Buildium

Retrieves information related to the Buildium account. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Account Information</span> - `View`

Retrieves accounting lock periods. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Application Settings</span> - `View`

Retrieves a list of association and/or rental properties whose residents received the announcement. An empty response collection indicates that the announcement was sent to all properties at the time of its creation. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View`

Creates and publishes an announcement. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View` `Edit`

Removes the announcement from the Resident Center immediately. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View` `Edit`

Retrieves all announcements. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View`

Retrieves an announcement. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View`

Retrieves an application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Retrieves all the applications for a given applicant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Updates a rental application. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Creates an applicant group note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Retrieves an applicant group note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Retrieves all applicant group notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Updates an applicant group note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Creates an applicant group. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Retrieves an applicant group. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Retrieves all applicant groups. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Updates an applicant group. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Creates an applicant note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Retrieves all applicant notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Retrieves an applicant note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Creates an applicant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Retrieves an applicant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Retrieves all applicants. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`

Updates an applicant. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`

Creates a payment on the application ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings > Application Settings > Residents page in your account. If you'd like to specify the GL accounts the payment should apply to, please use the <a href="#operation/ExternalApiApplicationLedgerPayments_CreateApplicationLedgerPayment">Create a payment</a> endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Creates a charge on a specific application ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Retrieves all the charges for a specific application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves a specific application charge. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`

Updates a charge on a specific application ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Reverses an application ledger payment. Note, this action can only be taken on a payment that has been deposited. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates an application ledger payment. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Updates an application ledger payment. Each line item must have a unique general ledger account identifier. PaymentMethod, Date, Memo, and the total Amount cannot be changed for payments with a PaymentMethod of `BuildiumEFT`, `BuildiumCC` or `RetailCash`. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Creates a refund for a specific application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Retrieves a specific application refund. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves all the transactions for a specific application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves a specific application transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`

Retrieves a list of applications that have outstanding balances. Applications with a zero or credit balance will not be returned in the results. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Outstanding Balances</span> - `View`

Inactivates an association along with associated units and ownership accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Reactivates an association along with associated units and ownership accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Creates a service history for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves all of the service history records for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieves a specific service history record for a given appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Creates an association appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Deletes an associations appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves an association appliance by id. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieves all association appliances. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates an association appliance. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Creates an architectural request <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit` <span class="permissionBlock">Associations > Architectural requests</span> - `View` `Edit` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Uploads a file and associates it to the specified architectural request record. Uploading a file requires making two API requests. Each step is outlined below. <strong>Step 1 - Save file metadata</strong> The first step in the file upload process is to submit the file metadata to `/v1/associations/ownershipaccounts/architecturalrequests/{architecturalRequestId:int}/files/uploads`. The response of this call will contain an upload URL and a collection of headers that will be used in step 2 to generate the request for the file binary upload. <strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <strong>Step 2 - Upload the file binary</strong> Uploading the file binary will require using the response from step 1 to form a PUT request to the Buildium file provider. Follow these steps to create the request: 1. Form a PUT request using the value of the `UploadUrl` property as the URL. 2. Set the `Content-Type` header to `application/octet-stream`. 3. Copy the fields from the `Headers` property to this request as header key/value pairs. <strong>NOTE:</strong> These values must be added to the request form-data in the order they were received in the response. 4. Lastly create the body of the request with the file binary. 5. Send the PUT request! A successful request will return with a `200 - OK` HTTP response code. For any failure responses, please refer to <a target="_blank" href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit` <span class="permissionBlock">Associations > Architectural requests</span> - `View` `Edit` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Downloads a specific file associated to the architectural request. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Architectural requests</span> - `View`

Retrieves a specific architectural request. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Architectural requests</span> - `View`

Retrieves an architectural request file. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Architectural requests</span> - `View`

Retrieves all files for an architectural request. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Architectural requests</span> - `View`

Retrieves all architectural requests. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Architectural requests</span> - `View`

Retrieves all association bank lockbox data. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Creates a board member for a given association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Deletes a board member. Note, this is a hard delete from the database and data can not be restored. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit` `Delete`

Retrieves all association board members. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Retrieves an association board member. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Updates a board member for a given association. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Delete meter reading details for an association for a given date. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit` `Delete`

Retrieves all meter reading details for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

This endpoint can be used to both create and update a meter reading detail for an association. <ul><li>There can only be one meter reading detail for a given combination of MeterType and ReadingDate for an association</li><li>If you are updating an existing meter reading detail, use the query parameters to specify the existing meter reading detail to update.</li><li>If you are creating a new meter reading detail, do not pass any query parameters.</li><li>When adding a new item to the Details array, leave out the `Id` field.</li><li>When updating an existing item in the Details array, the `Id` field of the existing item must be included.</li></ul> <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves all meter readings for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Creates a note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves a note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieves all notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates a note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Creates an association owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Retrieves an association owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Retrieves all association owner notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Updates an association owner note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Retrieves the owner occupancy status for an association unit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Ownership Accounts</span> - `View`

Retrieves the occupancy status for all of the units owned by the association owner. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Associations > Ownership Accounts</span> - `View`

Updates whether a unit is occupied by the association owner. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit` <span class="permissionBlock">Associations > Ownership Accounts</span> - `View`

Creates an association owner. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit` <span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit`

Retrieves a list of association owners. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Retrieve a specific association owner. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Updates an existing association owner. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Retrieves all preferred vendors. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` <span class="permissionBlock">Maintenance > Vendors</span> - `View`

Updates preferred vendors. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit` <span class="permissionBlock">Maintenance > Vendors</span> - `View` `Edit`

Creates an association tenant note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Retrieves an association tenant note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Retrieves all association tenant notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Updates an association tenant note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Creates an association tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Retrieves a specific association tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Retrieves a list of association tenants. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`

Updates an association tenant. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`

Creates a new association unit note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves an association unit note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieves all association unit notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates an association unit note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Creates an association unit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves a list of association units. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieve a specific association unit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates an association unit. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Creates an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves ePay settings for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates ePay settings for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieve a specific association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieves a list of associations. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates an association. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Downloads a specific file associated to the check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Uploads a file and associates it to the specified check record. Uploading a file requires making two API requests. Each step is outlined below. <strong>Step 1 - Save file metadata</strong> The first step in the file upload process is to submit the file metadata to `/v1/bankaccounts/{bankAccountId}/checks/{checkId}/files/uploads`. The response of this call will contain an upload URL and a collection of headers that will be used in step 2 to generate the request for the file binary upload. <strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <strong>Step 2 - Upload the file binary</strong> Uploading the file binary will require using the response from step 1 to form a PUT request to the Buildium file provider. Follow these steps to create the request: 1. Form a PUT request using the value of the `UploadUrl` property as the URL. 2. Set the `Content-Type` header to `application/octet-stream`. 3. Copy the fields from the `Headers` property to this request as header key/value pairs. <strong>NOTE:</strong> These values must be added to the request form-data in the order they were received in the response. 4. Lastly create the body of the request with the file binary. 5. Send the PUT request! A successful request will return with a `200 - OK` HTTP response code. For any failure responses, please refer to <a target="_blank" href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Checks</span> - `View` `Edit` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Deletes a file for a check <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccounts</span> - `View` `Edit` `Delete` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Retrieves the metadata for a specific file associated with the specified check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Retrieves the metadata for all files associated to the specified check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Creates a check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves all bank account checks. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Retrieves a bank account check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for checks associated with a Company) </span>

Updates a check. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates a deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a bank account deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for deposits associated with a Company) </span>

Retrieves all bank account deposits. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` <span class="permissionBlock">(Required for deposits associated with a Company) </span>

Updates a deposit. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates a reconciliation. Reconciliations can only be created for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Creates a quick deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Retrieves all quick deposits. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Retrieves a quick deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Updates a quick deposit. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Finalizes a manual reconciliation. Reconciliations can only be finalized for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Retrieves all transactions, both cleared and uncleared, up to the Statement Ending Date of the related reconciliation. This is true for pending and completed reconciliations. Transactions can only be retrieved for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Retrieves a bank account reconciliation's balance. Reconciliation balances can only be retrieved for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Retrieves a bank account reconciliation. Reconciliations can only be retrieved for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Retrieves all bank account reconciliations. Reconciliations can only be retrieved for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Clears transactions for a reconciliation. Reconciliation transactions can only be cleared for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Un-clears transactions for a reconciliation. Reconciliation transactions can only be un-cleared for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Updates a reconciliation. Reconciliations can only be updated for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Updates a bank account reconciliation's balance. Reconciliation balances can only be updated for bank accounts that are not linked externally. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`

Retrieves a specific bank account transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Account</span> - `View`

Retrieves all bank account transactions. Note: When using the `orderby` query string parameter, the only supported parameter is `EntryDate`. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Creates a bank account transfer. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a bank account transfer. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Retrieves all bank account transfers. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Updates a bank account transfer. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieve all bank account undeposited funds. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Creates a bank account withdrawal. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a bank account withdrawal. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccounts</span> - `View`

Retrieves all bank account withdrawals. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccounts</span> - `View`

Updates a bank account withdrawal. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates a bank account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Banking</span> - `View` `Edit`

Retrieves a list of bank accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Retrieves a specific bank account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Updates a bank account.; <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Banking</span> - `View` `Edit`

Downloads a specific file associated to the bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Uploads a file and associates it to the specified bill record. Uploading a file requires making two API requests. Each step is outlined below. <strong>Step 1 - Save file metadata</strong> The first step in the file upload process is to submit the file metadata to `/v1/bills/{billId}/files/uploads`. The response of this call will contain an upload URL and a collection of headers that will be used in step 2 to generate the request for the file binary upload. <strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <strong>Step 2 - Upload the file binary</strong> Uploading the file binary will require using the response from step 1 to form a PUT request to the Buildium file provider. Follow these steps to create the request: 1. Form a PUT request using the value of the `UploadUrl` property as the URL. 2. Set the `Content-Type` header to `application/octet-stream`. 3. Copy the fields from the `Headers` property to this request as header key/value pairs. <strong>NOTE:</strong> These values must be added to the request form-data in the order they were received in the response. 4. Lastly create the body of the request with the file binary. 5. Send the PUT request! A successful request will return with a `200 - OK` HTTP response code. For any failure responses, please refer to <a target="_blank" href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`

Retrieves specific bill payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Retrieves a list of bill payments for a specific bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Creates a bill payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates a payment for multiple bills with one check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates a bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`

Deletes the specified file from a bill. The file will be permanently deleted from the Buildium platform and can not be recovered. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit` `Delete`

Retrieves the metadata for all files associated to the specified bill. To download the actual file view the [Download a bill file](#tag/Bills/operation/ExternalApiBillFileDownloadRequests_DownloadBillFile). <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Retrieves the metadata for a specific file associated with the specified bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Retrieves a single bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Retrieves a list of bills. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`

Updates a bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`

Use this operation to update any of the writable fields of an existing bill resource. When updating this resource keep the following in mind: <ul><li>Writable fields omitted from the request or that do not have a value in the request message are set to `NULL`. If you do not want to update the field, submit the original field value.</li><li>When a bill has an existing payment any edits to the line items that change the total bill amount must result in the new total bill amount being equal to or greater than the amount paid.</li><li>When adding a new line item leave the `LineItem.Id` field empty.</li><li>You cannot update a bill that has a pending EFT associated with it.</li></ul> <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`

Creates a budget. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View` `Edit`

Retrieves a budget. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View`

Retrieves all budgets. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View`

Updates a budget. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View` `Edit`

Retrieves all client leads Note: When using the `orderby` query string parameter, the only supported options are DateReceived. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > All Property Management</span> - `View`

Retrieves a specific client lead <h4>Required permission(s):</h4><span class="permissionBlock">Administration > All Property Management</span> - `View`

Creates a contact request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`

Retrieves a contact request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`

Retrieves a list of contact requests. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`

Updates a contact request. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`

Creates a credit card balance payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Edits a credit card balance payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a credit card balance payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Creates a credit card purchase. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Edits a credit card purchase. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a credit card purchase. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`

Retrieves a specific credit card account transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Retrieves all credit card account transactions. Note: When using the `orderby` query string parameter, the only supported parameter is `EntryDate`. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Creates a credit card account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Banking</span> - `View` `Edit`

Gets a credit card account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Gets credit card accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Updates a credit card account. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Banking</span> - `View` `Edit`

Retrieves all email recipients. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Email</span> - `View` <h4>Optional Permissions:</h4> The following permissions are optional, but results with a missing permission will be filtered out. <span class="permissionBlock">Maintenance > Vendors</span> - `View` In order to retrieve recipients that are Vendors, you must have this permission. <span class="permissionBlock">Administration > Users</span> - `View` In order to see recipients that are Staff, you must have this permission.

Retrieves the content of an email. System generated emails are not included. To retrieve the recipients of the email see the [Retrieve all email recipients](#tag/Communications/operation/ExternalApiEmailRecipients_GetEmailRecipients) endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Emails</span> - `View`

Retrieves all emails. System generated emails are not included. <h4>Required permission(s):</h4><span class="permissionBlock">Communication > Emails</span> - `View`

Sends an email to one or more recipients using the specified email template. <strong>NOTE:</strong> Emails can only be sent to current tenants. <h4>Required permission(s):</h4><span class="permissionBlock">Communication > Emails</span> - `View` `Edit`

Creates a file category. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`

Retrieves a list of file categories. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`

Retrieves a specific file category. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`

Updates a file category. Note that file categories where `IsEditable` is `false` can not be updated. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`

Downloading a file requires making two API requests. The first request to `/v1/files/{fileId}/downloadrequest` will return a secure URL that can be used to download the file contents. Note the download URL is transient and will expire after 5 minutes. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`

Retrieves a file's share settings. Note, that the response JSON schema includes share setting fields for all file entity types, however only fields that pertain to the queried file entity type will be populated. For example, if a file of entity type Rental is retrieved only the fields in the Rental section of the response will have values. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`

Updates a file's share settings. Note, can only update a file's share settings based on the file's entity type (ie: If the file belongs to a rental property, you can only update the rental file sharing settings). The response payload contains file share setting values for all file entity types, but the relevant setting values correlate to the file's entity type. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`

Retrieves the file metadata for a specific file. Note this endpoint will only return file metadata. To download files make requests to the <a href="#operation/FileDownloadExternalApi_GetFileDownloadUrlAsync">Download File endpoint.</a> <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`

Retrieves a list of files that exist within the customer account. Note this endpoint will only return file metadata. To download files make requests to the <a href="#operation/FileDownloadExternalApi_GetFileDownloadUrlAsync">Download File</a> endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`

Updates a metadata of the file. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`

Uploading a file requires making two API requests. Each step is outlined below. <strong>Step 1 - Save file metadata</strong> The first step in the file upload process is to submit the file metadata to `/v1/files/uploads`. The response of this call will contain an upload URL and a collection of headers that will be used in step 2 to generate the request for the file binary upload. <strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <strong>Step 2 - Upload the file binary</strong> Uploading the file binary will require using the response from step 1 to form a PUT request to the Buildium file provider. Follow these steps to create the request: 1. Form a PUT request using the value of the `UploadUrl` property as the URL. 2. Set the `Content-Type` header to `application/octet-stream`. 3. Copy the fields from the `Headers` property to this request as header key/value pairs. <strong>NOTE:</strong> These values must be added to the request form-data in the order they were received in the response. 4. Lastly create the body of the request with the file binary. 5. Send the PUT request! A successful request will return with a `200 - OK` HTTP response code. For any failure responses, please refer to <a target="_blank" href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`

Creates a general ledger account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View` `Edit`

Retrieves a list of general ledger accounts. General ledger accounts are used to categorize transactions for accounting purposes. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Retrieves a specific general ledger account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Updates a general ledger account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View` `Edit`

Retrieves all general ledger entries <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`

Creates a general journal entry. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` `Edit`

Updates a general journal entry. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` `Edit`

Retrieves a list of general ledger transactions. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`

Retrieves a specific general ledger transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`

Retrieves all general ledger account balances as of a given date. The response includes the total balance of each account along with the subtotals for any accounting entities (company, associations or rental properties) that have transactions assigned to the account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Creates a payment on the lease ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings > Application Settings > Residents page in your account. If you'd like to specify the GL accounts the payment should apply to, please use the <a href="#operation/ExternalApiLeaseLedgerPaymentsWrite_CreatePayment">Create a payment</a> endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Creates a recurring charge transaction that will post automatically on the specified lease ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Retrieves a recurring charge. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves ePay settings for a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Updates ePay settings for a lease <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`

Retrieves all the charges for a specific lease. <h4>Required permissions(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves a specific lease charge. <h4>Required permissions(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Creates a charge transaction on a specific lease ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bills</span> - `View` `Edit` In order to associate the charge to a bill using the BillId property, you must have this permission.

Updates a charge. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Creates a lease ledger credit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Withholds a resident deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Ledger</span> - `View` `Edit` <span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Updates a resident deposit withholding. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Ledger</span> - `View` `Edit` <span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Reverses a lease ledger payment. Note, this action can only be taken on a payment that has been deposited. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Creates a lease ledger payment. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Updates a ledger payment. Each line item must have a unique general ledger account identifier. PaymentMethod, Date, Memo, and the total Amount cannot be changed for payments with a PaymentMethod of `BuildiumEFT`, `BuildiumCC` or `RetailCash`. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Creates a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Retrieves a specific lease transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`

Retrieves all the transactions for a specific lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Creates move out data for a single tenant on a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit` <span class="permissionBlock">Rentals > Tenants</span> - `View` `Edit`

Retrieves move out data for a single tenant on a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` <span class="permissionBlock">Rentals > Tenants</span> - `View`

Retrieves a list of move out dates for a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` <span class="permissionBlock">Rentals > Tenants</span> - `View`

Deletes move out data for a tenant on a given lease. <h4>Required Permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit` <span class="permissionBlock">Rentals > Tenants</span> - `View`

Creates a lease note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`

Retrieves a lease note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Retrieves all lease notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Updates a lease note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`

Retrieves a list of leases that have outstanding balances. Leases with a zero or credit balance will not be returned in the results. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Outstanding Balances</span> - `View`

Retrieves partial payment settings for a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Creates a recurring credit transaction on the specified lease ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`

Retrieves a recurring credit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Creates a recurring payment that will post automatically on the specified lease ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View` `Edit`

Retrieves a recurring payment. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`

Retrieves all recurring transactions for a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves all recurring transactions for all leases. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves all renewals for a specific a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Retrieves all upcoming lease renewals across all rental properties. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Retrieves a specific renewal for a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Retrieves all lease renewal history <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`

Creates a lease renewal. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`

Creates a rent schedule. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View` `Edit`

The rent schedule provides details (dollar amount, day of the month, etc) of the recurring charges that are applied to the lease ledger each rent cycle. A lease may have more than one rent schedule associated with it if the rent terms change within the duration of the lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Retrieves a specific rent schedule for a lease. The rent schedule provides details (dollar amount, day of the month, etc) of the recurring charges that are applied to the lease ledger each rent cycle. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

The rent schedule provides details (dollar amount, day of the month, etc) of the recurring charges that are applied to the lease ledger each rent cycle. A lease may have more than one rent schedule associated with it if the rent terms change within the duration of the lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`

Updates a rent schedule. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View` `Edit`

Updates partial payment settings for a lease. <h4>Required Permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit` <span class="permissionBlock">Administration > Application Settings</span> - `View` `Edit`

Creates a signed lease. <span class="permissionBlock">Rentals > Leases</span> - `View` `Edit` <span class="permissionBlock">Rentals > Tenants</span> - `View` `Edit` <span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit` <h4>Optional Permissions:</h4> <span class="permissionBlock">Rentals > Applicants</span> - `View` In order to add tenants to the lease using the ApplicantIds property, you must have this permission.

Retrieves a specific lease. <span class="permissionBlock">Rentals > Leases</span> - `View`

Retrieves a list of leases. <span class="permissionBlock">Rentals > Leases</span> - `View`

Update a signed lease. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`

Create a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View` `Edit`

Retrieves all listing contacts. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View`

Retrieves a specific listing contact. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View`

Update a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View` `Edit`

Deleting a listing will immediately remove it from your Buildium public website. The listing will also be removed from any syndicated sites within 24-48 hours. Listings manually created on craigslist using the Buildium guided tool will not be removed. The listing must be removed using craigslist's tools provided in your craigslist account. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View` `Edit` `Delete`

Retrieves a specific listing. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View` <span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Retrieves all listings. <span class="permissionBlock">Rentals > Listings</span> - `View` <span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

This endpoint can be used to both *create* and *update* a listing. If no listing exists for the unit one will be created, otherwise the existing listing will be updated. A unit can only ever have one active listing. Upon creation the listing will post immediately to your Buildium public website, and will post to the selected syndicated sites within 24-48 hours. Updates to the listing will appear immediately in your Buildium public website and propagated to syndicated sites within 24-48 hours. Note, the listing will automatically pull in the information, features, and media that exists for the property and unit details. <span class="permissionBlock">Rentals > Listings</span> - `View` `Edit` <span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieves all mailing and email templates. A template is a tool in Buildium that allows you to create "mail merge" templates for emails and postal mailings to easily send common messages to residents, rental owners and vendors. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Mailing Templates</span> - `View` <h4>Optional Permissions:</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` <span class="permissionBlock">Rentals > Property Rental owners</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Maintenance > Vendors</span> - `View` <span class="permissionBlock">Rentals > Applicants</span> - `View`

Retrieves a communication template. A template is a tool in Buildium that allows you to create "mail merge" templates for emails and postal mailings to easily send common messages to residents, rental owners and vendors. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Mailing Templates</span> - `View` <h4>Optional Permissions:</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` <span class="permissionBlock">Rentals > Property Rental owners</span> - `View` <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` <span class="permissionBlock">Maintenance > Vendors</span> - `View` <span class="permissionBlock">Rentals > Applicants</span> - `View`

Creates a payment on the ownership account ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings > Application Settings > Residents page in your account. If you'd like to specify the general ledger accounts the payment should apply to, please use the <a href="#operation/ExternalApiOwnershipAccountLedgerPayments_CreateOwnershipAccountLedgerPayment">Create a payment</a> endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Retrieves a recurring charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit` <span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Updates an ownership account deposit withholding. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit` <span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`

Creates a ledger charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bills</span> - `View` `Edit` In order to associate the charge to a bill using the BillId property, you must have this permission.

Retrieves all ledger charges for a specific ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Retrieves a specific ownership account ledger charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Updates a charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Creates a ledger credit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Creates a ledger payment. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Updates a ledger payment. Each line item must have a unique general ledger account identifier. PaymentMethod, Date, Memo, and the total Amount cannot be changed for payments with a PaymentMethod of `BuildiumEFT`, `BuildiumCC` or `RetailCash`. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Creates a new ownership account note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit`

Retrieves an ownership account note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > OwnershipAccounts</span> - `View`

Retrieves notes for an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > OwnershipAccounts</span> - `View`

Updates an association ownership account note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership Accounts</span> - `View` `Edit`

Retrieves a list of ownership account outstanding balances. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Outstanding Balances</span> - `View`

Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Retrieves a recurring credit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Creates a recurring payment that will post automatically on the specified ownership account ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`

Retrieves a recurring payment. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Retrieves all recurring transactions for an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Retrieves all recurring transactions for all ownership accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Creates a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`

Retrieves a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`

Updates partial payment settings for an ownership account. <h4>Required Permission(s):</h4><span class="permissionBlock">Associations > Ownership Accounts</span> - `View` `Edit` <span class="permissionBlock">Administration > Application Settings</span> - `View` `Edit`

Creates an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit` <span class="permissionBlock">Associations > Owners</span> - `View` `Edit`

Retrieves a list of ownership accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View`

Retrieves a specific ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View`

Retrieves all ledger transactions for a specific ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Retrieves a specific ownership account ledger transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`

Retrieves partial payment settings for an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > OwnershipAccounts</span> - `View`

Updates an ownership account. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit`

Retrieves the partial payment settings for residents. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Application Settings</span> - `View`

Updates the partial payment settings for residents. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Application Settings</span> - `View` `Edit`

Creates a phone log. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View` `Edit`

Retrieves a specific phone log. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View`

Retrieves all phone logs. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View`

Update a phone log <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View` `Edit`

Creates a property group. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units or</span> - `View` `Edit` <span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Retrieves a property group. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units or</span> - `View` <span class="permissionBlock">Associations > Associations and units</span> - `View`

Retrieves all property groups. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units or</span> - `View` <span class="permissionBlock">Associations > Associations and units</span> - `View`

Updates a property group. A property group can only be updated by the user that created it. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units or</span> - `View` `Edit` <span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`

Creates a service history record for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieves all of the service history records for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Retrieves a specific service history record for a given appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Creates a rental property appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Deletes an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieves a rental appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Retrieves all rental appliances. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Updates a rental appliance. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Delete meter reading details for a property for a given date. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View` `Edit` `Delete`

Retrieves ePay settings for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Updates ePay settings for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieve all the amenities for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Updates the amenities for a rental property. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Use this endpoint to create a temporary URL that can be used to download a property image. This URL expires after 5 minutes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Updates the image display order within the Buildium web application and in any associated rental listings. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Uploading a file requires making two API requests. Each step is outlined below. <strong>Step 1 - Save file metadata</strong> The first step in the file upload process is to submit the file metadata to `/v1/rentals/{propertyId}/images/uploads`. The response of this call will contain an upload URL and a collection of headers that will be used in step 2 to generate the request for the file binary upload. <strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <strong>Step 2 - Upload the file binary</strong> Uploading the file binary will require using the response from step 1 to form a PUT request to the Buildium file provider. Follow these steps to create the request: 1. Form a PUT request using the value of the `UploadUrl` property as the URL. 2. Set the `Content-Type` header to `application/octet-stream`. 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <strong>NOTE:</strong> These values must be added to the request form-data in the order they were received in the response. 4. Lastly create a form-data key named `file` and set the value to the file binary. <strong>NOTE:</strong> This must be the last field in the form-data list. This image shows what the POST request should look like if you're using Postman: <img src="file-upload-example.png" /> 5. Send the PUT request! A successful request will return with a `200 - OK` HTTP response code. For any failure responses, please refer to <a target="_blank" href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses">AWS documentation</a> on REST error responses. <strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`

Creates an image for a rental using a video link. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Deletes a rental property image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit` `Delete`

Retrieves a rental property image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Retrieves all images for a rental property. Note this endpoint will only return file metadata such as file names and descriptions. To download files make requests to the [Download File](#tag/Rental-Properties/operation/ExternalApiRentalImageDownloadRequests_GetRentalImageDownloadUrlById) endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Updates a rental property image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieves all meter reading details for a property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

This endpoint can be used to both create and update a meter reading detail for a property. <ul><li>There can only be one meter reading detail for a given combination of MeterType and ReadingDate for a property.</li><li>If you are updating an existing meter reading detail, use the query parameters to specify the existing meter reading detail to update.</li><li>If you are creating a new meter reading detail, do not pass any query parameters.</li><li>When adding a new item to the Details array, leave out the `Id` field.</li><li>When updating an existing item in the Details array, the `Id` field of the existing item must be included.</li></ul> <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieves all meter readings for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Creates a note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Retrieves a note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Retrieves all notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`

Updates a note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`

Creates a new Rental Owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View` `Edit`

Retrieves a rental owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`

Retrieves all rental owner notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`

Updates a Rental Owner note. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View` `Edit`

Creates a rental owner request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`

Retrieves all rental owner requests. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`

Retrieves a specific rental owner request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`

Retrieves the contribution details for a rental owner contribution request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`

Updates a rental owner request. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`

Updates the contribution details for a rental owner contribution request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`

Creates a rental owner. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View` `Edit`

Retrieves a specific rental owner. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`

Retrieves a list of rental owners. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`

Updates a rental owner. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View` `Edit`

Retrieves all preferred vendors. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` <span class="permissionBlock">Maintenance > Vendors</span> - `View`

Updates preferred vendors. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit` <span class="permissionBlock">Maintenance > Vendors</span> - `View` `Edit`

Creates a rental tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` `Edit` <span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`

Retrieves a list of tenants. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View`

Retrieve a specific tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View`

Updates a rental tenant. <strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` `Edit`

Retrieves all amenities for a rental unit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`