How do AI agents use Buildium through Open Connector?

Your user connects Buildium once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Buildium tools to your agent over MCP or a typed API, with credentials injected server-side on each call.

Is this a Buildium MCP server?

Yes. Open Connector can serve Buildium as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Buildium actions with credentials injected server-side.

Where do Buildium credentials live?

In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Buildium integration

Buildium integration for AI agents.

Buildium integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves Buildium tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHub All integrations →

What your agents can do

Real Buildium actions, managed and audited.

Your user connects Buildium once; your agent can then use Buildium to manage rentals, associations, leases, tenants, owners, vendors, files, accounting, tasks, and property management workflows — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

1
Your user grants Buildium access once (OAuth) — the token lands in the vault.
2
Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.
3
Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported Buildium tools.

439 tools are generated from the published Buildium catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 439 tools. All published catalog entries are included in this page's server-rendered HTML.

Retrieve account info: Retrieves information related to the Buildium account. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Account Information</span> - `View`; Administration
Retrieve accounting lock periods: Retrieves accounting lock periods. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Application Settings</span> - `View`; Administration
Retrieve all announcement properties: 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`; Communications
Create an announcement: Creates and publishes an announcement. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View` `Edit`; Communications
Expire an announcement: Removes the announcement from the Resident Center immediately. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View` `Edit`; Communications
Retrieve all announcements: Retrieves all announcements. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View`; Communications
Retrieve an announcement: Retrieves an announcement. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Announcements</span> - `View`; Communications
Retrieve an application: Retrieves an application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Retrieve all applications: Retrieves all the applications for a given applicant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Update an application: 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`; Applicants
Create an applicant group note: Creates an applicant group note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`; Applicants
Retrieve an applicant group note: Retrieves an applicant group note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Retrieve all applicant group notes: Retrieves all applicant group notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Update an applicant group note: 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`; Applicants
Create an applicant group: Creates an applicant group. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`; Applicants
Retrieve an applicant group: Retrieves an applicant group. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Retrieve all applicant groups: Retrieves all applicant groups. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Update an applicant group: 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`; Applicants
Create an applicant note: Creates an applicant note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`; Applicants
Retrieve all applicant notes: Retrieves all applicant notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Retrieve an applicant note: Retrieves an applicant note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Create an applicant: Creates an applicant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View` `Edit`; Applicants
Retrieve an applicant: Retrieves an applicant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Retrieve all applicants: Retrieves all applicants. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Applicants</span> - `View`; Applicants
Update an applicant: 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`; Applicants
Create a payment (auto allocated): 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`; Application Transactions
Create a charge: Creates a charge on a specific application ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Application Transactions
Retrieve all charges: Retrieves all the charges for a specific application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Application Transactions
Retrieve a charge: Retrieves a specific application charge. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`; Application Transactions
Update a charge: Updates a charge on a specific application ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Application Transactions
Create a payment reversal: 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`; Application Transactions
Create a payment: Creates an application ledger payment. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Application Transactions
Update a payment: 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`; Application Transactions
Create a refund: Creates a refund for a specific application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Application Transactions
Retrieve a refund: Retrieves a specific application refund. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Application Transactions
Retrieve all application transactions: Retrieves all the transactions for a specific application. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Application Transactions
Retrieve an application transaction: Retrieves a specific application transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`; Application Transactions
Retrieve all outstanding balances: 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`; Application Transactions
Inactivate an association: 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`; Associations
Reactivate an association: 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`; Associations
Create a service history: Creates a service history for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Appliances
Retrieve all service history: Retrieves all of the service history records for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Appliances
Retrieve a service history: Retrieves a specific service history record for a given appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Appliances
Create an appliance: Creates an association appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Appliances
Delete an appliance: Deletes an associations appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Appliances
Retrieve an appliance: Retrieves an association appliance by id. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Appliances
Retrieve all appliances: Retrieves all association appliances. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Appliances
Update an appliance: 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`; Appliances
Create an architectural request: 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`; Architectural Requests
Upload an architectural request file: 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`; Architectural Requests
Download an architectural request file: 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`; Architectural Requests
Retrieve an architectural request: 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`; Architectural Requests
Retrieve an architectural request file: 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`; Architectural Requests
Retrieve all files for an architectural request: 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`; Architectural Requests
Retrieve all architectural requests: 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`; Architectural Requests
Retrieve all association bank lockbox data: Retrieves all association bank lockbox data. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Associations
Create a board member: Creates a board member for a given association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`; Board Members
Delete a board member: 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`; Board Members
Retrieve all board members: Retrieves all association board members. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Board Members
Retrieve a board member: Retrieves an association board member. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Board Members
Update a board member: 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`; Board Members
Delete meter reading details for a given date: 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`; Association Meter Readings
Retrieve all meter reading details: Retrieves all meter reading details for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Association Meter Readings
Create/Update meter reading details: 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`; Association Meter Readings
Retrieve all meter readings: Retrieves all meter readings for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Association Meter Readings
Create a note: Creates a note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Associations
Retrieve a note: Retrieves a note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Associations
Retrieve all notes: Retrieves all notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Associations
Update a note: 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`; Associations
Create a note: Creates an association owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`; Association Owners
Retrieve a note: Retrieves an association owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Owners
Retrieve all notes: Retrieves all association owner notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Owners
Update a note: 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`; Association Owners
Retrieve an occupancy status: 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`; Association Owners
Retrieve all occupancy statuses: 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`; Association Owners
Update occupancy status: 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`; Association Owners
Create an owner: 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`; Association Owners
Retrieve all owners: Retrieves a list of association owners. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Owners
Retrieve an owner: Retrieve a specific association owner. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Owners
Update an owner: 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`; Association Owners
Retrieve all preferred vendors: 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`; Associations
Update preferred vendors: 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`; Associations
Create a note: Creates an association tenant note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`; Association Tenants
Retrieve a note: Retrieves an association tenant note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Tenants
Retrieve all notes: Retrieves all association tenant notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Tenants
Update a note: 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`; Association Tenants
Create a tenant: Creates an association tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View` `Edit`; Association Tenants
Retrieve a tenant: Retrieves a specific association tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Tenants
Retrieve all tenants: Retrieves a list of association tenants. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Association owners and tenants</span> - `View`; Association Tenants
Update a tenant: 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`; Association Tenants
Create a note: Creates a new association unit note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Association Units
Retrieve a note: Retrieves an association unit note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Association Units
Retrieve all notes: Retrieves all association unit notes. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Association Units
Update a note: 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`; Association Units
Create a unit: Creates an association unit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Association Units
Retrieve all units: Retrieves a list of association units. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Association Units
Retrieve a unit: Retrieve a specific association unit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Association Units
Update a unit: 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`; Association Units
Create an association: Creates an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Associations
Retrieve ePay settings: Retrieves ePay settings for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Associations
Update ePay settings: Updates ePay settings for an association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View` `Edit`; Associations
Retrieve an association: Retrieve a specific association. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Associations
Retrieve all associations: Retrieves a list of associations. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Associations and units</span> - `View`; Associations
Update an association: 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`; Associations
Download a file for a check: 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>; Bank Accounts
Upload a file for a check: 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>; Bank Accounts
Delete a file for a check: 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>; Bank Accounts
Retrieve a file for a check: 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>; Bank Accounts
Retrieve all files for a check: 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>; Bank Accounts
Create a check: Creates a check. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Bank Accounts
Retrieve all checks: 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>; Bank Accounts
Retrieve a check: 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>; Bank Accounts
Update a check: 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`; Bank Accounts
Create a deposit: Creates a deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Bank Accounts
Retrieve a deposit: 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>; Bank Accounts
Retrieve all deposits: 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>; Bank Accounts
Update a deposit: 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`; Bank Accounts
Create a reconciliation: 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`; Bank Accounts
Create a quick deposit: Creates a quick deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View` `Edit`; Bank Accounts
Retrieve all quick deposits: Retrieves all quick deposits. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`; Bank Accounts
Retrieve a quick deposit: Retrieves a quick deposit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`; Bank Accounts
Update a quick deposit: 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`; Bank Accounts
Finalize a manual reconciliation: 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`; Bank Accounts
Retrieve all transactions for a reconciliation: 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`; Bank Accounts
Retrieve a reconciliation's balance: 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`; Bank Accounts
Retrieve a reconciliation: 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`; Bank Accounts
Retrieve all reconciliations: 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`; Bank Accounts
Clear transactions for a reconciliation: 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`; Bank Accounts
Un-clear transactions for a reconciliation: 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`; Bank Accounts
Update a reconciliation: 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`; Bank Accounts
Update a reconciliation's balance: 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`; Bank Accounts
Retrieve a transaction: Retrieves a specific bank account transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Account</span> - `View`; Bank Accounts
Retrieve all transactions: 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`; Bank Accounts
Create a transfer: Creates a bank account transfer. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Bank Accounts
Retrieve a transfer: Retrieves a bank account transfer. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Bank Accounts
Retrieve all transfers: Retrieves all bank account transfers. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`; Bank Accounts
Update a transfer: 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`; Bank Accounts
Retrieve all undeposited funds: Retrieve all bank account undeposited funds. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Bank Accounts
Create a withdrawal: Creates a bank account withdrawal. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Bank Accounts
Retrieve a withdrawal: Retrieves a bank account withdrawal. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccounts</span> - `View`; Bank Accounts
Retrieve all withdrawals: Retrieves all bank account withdrawals. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccounts</span> - `View`; Bank Accounts
Update a withdrawal: 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`; Bank Accounts
Create a bank account: Creates a bank account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Banking</span> - `View` `Edit`; Bank Accounts
Retrieve all bank accounts: Retrieves a list of bank accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Bank Accounts
Retrieve a bank account: Retrieves a specific bank account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Bank Accounts
Update a bank account: 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`; Bank Accounts
Download a bill file: Downloads a specific file associated to the bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Bills
Upload a bill file: 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`; Bills
Retrieve a bill payment: Retrieves specific bill payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Bills
Retrieve all bill payments: Retrieves a list of bill payments for a specific bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Bills
Create a bill payment: 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`; Bills
Create a payment for multiple bills with one check: 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`; Bills
Create a bill: Creates a bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`; Bills
Delete a bill file: 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`; Bills
Retrieve all files for a bill: 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`; Bills
Retrieve a file for a bill: Retrieves the metadata for a specific file associated with the specified bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Bills
Retrieve a bill: Retrieves a single bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Bills
Retrieve all bills: Retrieves a list of bills. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Bills
Update a bill: Updates a bill. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`; Bills
Update a bill: 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`; Bills
Create a budget: Creates a budget. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View` `Edit`; Budgets
Retrieve a budget: Retrieves a budget. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View`; Budgets
Retrieve all budgets: Retrieves all budgets. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View`; Budgets
Update a budget: Updates a budget. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Budgets</span> - `View` `Edit`; Budgets
Retrieve all client leads: 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`; Client Leads
Retrieve a client lead: Retrieves a specific client lead <h4>Required permission(s):</h4><span class="permissionBlock">Administration > All Property Management</span> - `View`; Client Leads
Create a contact request: Creates a contact request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; Contact Requests
Retrieve a contact request: Retrieves a contact request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Contact Requests
Retrieve all contact requests: Retrieves a list of contact requests. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Contact Requests
Update a contact request: 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`; Contact Requests
Create a credit card balance payment: Creates a credit card balance payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Credit Card Accounts
Edit a credit card balance payment: Edits a credit card balance payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Credit Card Accounts
Retrieve a credit card balance payment: Retrieves a credit card balance payment. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`; Credit Card Accounts
Create a credit card purchase: Creates a credit card purchase. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Credit Card Accounts
Edit a credit card purchase: Edits a credit card purchase. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Credit Card Accounts
Retrieve a credit card purchase: Retrieves a credit card purchase. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > BankAccount</span> - `View`; Credit Card Accounts
Retrieve a transaction: Retrieves a specific credit card account transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Credit Card Accounts
Retrieve all transactions: 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`; Credit Card Accounts
Create a credit card account: Creates a credit card account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Banking</span> - `View` `Edit`; Credit Card Accounts
Get a credit card account: Gets a credit card account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Credit Card Accounts
Get all credit card accounts: Gets credit card accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Credit Card Accounts
Update a credit card account: 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`; Credit Card Accounts
Retrieve all email recipients: 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.; Communications
Retrieve an email: 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`; Communications
Retrieve all emails: Retrieves all emails. System generated emails are not included. <h4>Required permission(s):</h4><span class="permissionBlock">Communication > Emails</span> - `View`; Communications
Send an email: 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`; Communications
Create a category: Creates a file category. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View` `Edit`; Files
Retrieve all categories: Retrieves a list of file categories. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`; Files
Retrieve a category: Retrieves a specific file category. <h4>Required permission(s):</h4><span class="permissionBlock">Documents > Files</span> - `View`; Files
Update a category: 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`; Files
Download a file: 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`; Files
Retrieve file share settings: 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`; Files
Update file share settings: 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`; Files
Retrieve a file: 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`; Files
Retrieve all files: 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`; Files
Update a file: 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`; Files
Upload a file: 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`; Files
Create a general ledger account: Creates a general ledger account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View` `Edit`; General Ledger
Retrieve all general ledger accounts: 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`; General Ledger
Retrieve a general ledger account: Retrieves a specific general ledger account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View`; General Ledger
Update a general ledger account: Updates a general ledger account. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Accounts</span> - `View` `Edit`; General Ledger
Retrieve all general ledger entries: Retrieves all general ledger entries <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`; General Ledger
Create a general journal entry: Creates a general journal entry. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` `Edit`; General Ledger
Update a general journal entry: Updates a general journal entry. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View` `Edit`; General Ledger
Retrieve all general ledger transactions: Retrieves a list of general ledger transactions. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`; General Ledger
Retrieve a general ledger transaction: Retrieves a specific general ledger transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`; General Ledger
Retrieve all general ledger account balances: 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`; General Ledger
Create a payment (auto allocated): 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`; Lease Transactions
Create a recurring charge: 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`; Lease Transactions
Retrieve a recurring charge: Retrieves a recurring charge. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Retrieve ePay settings: Retrieves ePay settings for a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Update ePay settings: Updates ePay settings for a lease <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`; Leases
Retrieve all charges: Retrieves all the charges for a specific lease. <h4>Required permissions(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Retrieve a charge: Retrieves a specific lease charge. <h4>Required permissions(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Create a charge: 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.; Lease Transactions
Update a charge: Updates a charge. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Lease Transactions
Create a credit: Creates a lease ledger credit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Lease Transactions
Create a deposit withholding: 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`; Lease Transactions
Update a deposit withholding: 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`; Lease Transactions
Create a payment reversal: 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`; Lease Transactions
Create a payment: Creates a lease ledger payment. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Lease Transactions
Update a payment: 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`; Lease Transactions
Create a refund: Creates a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Lease Transactions
Retrieve a refund: Retrieves a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Lease Transactions
Retrieve a lease transaction: Retrieves a specific lease transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`; Lease Transactions
Retrieve all lease transactions: Retrieves all the transactions for a specific lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Create a move out: 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`; Leases
Retrieve a move out: 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`; Leases
Retrieve all move outs: 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`; Leases
Delete a move out: 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`; Leases
Create a note: Creates a lease note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`; Leases
Retrieve a note: Retrieves a lease note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve all notes: Retrieves all lease notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Update a note: 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`; Leases
Retrieve all outstanding balances: 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`; Lease Transactions
Retrieve all partial payment settings for a lease: Retrieves partial payment settings for a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Create a recurring credit: Creates a recurring credit transaction on the specified lease ledger. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View` `Edit`; Lease Transactions
Retrieve a recurring credit: Retrieves a recurring credit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Create a recurring payment: 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`; Lease Transactions
Retrieve a recurring payment: Retrieves a recurring payment. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View`; Lease Transactions
Retrieve all recurring transactions: Retrieves all recurring transactions for a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Retrieve all recurring transactions for all leases: Retrieves all recurring transactions for all leases. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease transactions</span> - `View`; Lease Transactions
Retrieve all renewals: Retrieves all renewals for a specific a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve all upcoming renewals: Retrieves all upcoming lease renewals across all rental properties. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve a renewal: Retrieves a specific renewal for a given lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve all lease renewal history: Retrieves all lease renewal history <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Create a lease renewal: Creates a lease renewal. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View` `Edit`; Leases
Create a rent schedule: Creates a rent schedule. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View` `Edit`; Leases
Retrieve all rent schedules: 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`; Leases
Retrieve a rent schedule: 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`; Leases
Retrieve all rent schedules: 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`; Leases
Update a rent schedule: Updates a rent schedule. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Lease Transactions</span> - `View` `Edit`; Leases
Update partial payment settings for a lease: 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`; Leases
Create a lease: 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.; Leases
Retrieve a lease: Retrieves a specific lease. <span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve all leases: Retrieves a list of leases. <span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Update a lease: 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`; Leases
Create a listing contact: 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`; Listings
Retrieve all listing contacts: Retrieves all listing contacts. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View`; Listings
Retrieve a listing contact: Retrieves a specific listing contact. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Listings</span> - `View`; Listings
Update a listing contact: 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`; Listings
Delete a listing: 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`; Listings
Retrieve a listing: 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`; Listings
Retrieve all listings: Retrieves all listings. <span class="permissionBlock">Rentals > Listings</span> - `View` <span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Listings
Create/Update a listing: 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`; Listings
Retrieve all communication templates: 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`; Communications
Retrieve a communication template: 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`; Communications
Create a payment (auto allocated): 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`; Ownership Account Transactions
Create a recurring charge: 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`; Ownership Account Transactions
Retrieve a recurring charge: Retrieves a recurring charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Create a deposit withholding: 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`; Ownership Account Transactions
Update a deposit withholding: 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`; Ownership Account Transactions
Create a charge: 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.; Ownership Account Transactions
Retrieve all charges: Retrieves all ledger charges for a specific ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Retrieve a charge: Retrieves a specific ownership account ledger charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Update a charge: Updates a charge. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`; Ownership Account Transactions
Create a credit: Creates a ledger credit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`; Ownership Account Transactions
Create a payment: Creates a ledger payment. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View` `Edit`; Ownership Account Transactions
Update a payment: 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`; Ownership Account Transactions
Create a note: Creates a new ownership account note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View` `Edit`; Ownership Accounts
Retrieve a note: Retrieves an ownership account note. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > OwnershipAccounts</span> - `View`; Ownership Accounts
Retrieve all notes: Retrieves notes for an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > OwnershipAccounts</span> - `View`; Ownership Accounts
Update a note: 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`; Ownership Accounts
Retrieve all outstanding balances: Retrieves a list of ownership account outstanding balances. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Outstanding Balances</span> - `View`; Ownership Account Transactions
Create a recurring credit: 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`; Ownership Account Transactions
Retrieve a recurring credit: Retrieves a recurring credit. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Create a recurring payment: 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`; Ownership Account Transactions
Retrieve a recurring payment: Retrieves a recurring payment. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Retrieve all recurring transactions: Retrieves all recurring transactions for an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Retrieve all recurring transactions for all ownership accounts: Retrieves all recurring transactions for all ownership accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Create a refund: Creates a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View` `Edit`; Ownership Account Transactions
Retrieve a refund: Retrieves a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Ownership Account Transactions
Update partial payment settings for an ownership account: 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`; Ownership Accounts
Create an ownership account: 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`; Ownership Accounts
Retrieve all ownership accounts: Retrieves a list of ownership accounts. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View`; Ownership Accounts
Retrieve an ownership account: Retrieves a specific ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership accounts</span> - `View`; Ownership Accounts
Retrieve all transactions: Retrieves all ledger transactions for a specific ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Retrieve a transaction: Retrieves a specific ownership account ledger transaction. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > Ownership account transactions</span> - `View`; Ownership Account Transactions
Retrieve all partial payment settings for an ownership account: Retrieves partial payment settings for an ownership account. <h4>Required permission(s):</h4><span class="permissionBlock">Associations > OwnershipAccounts</span> - `View`; Ownership Accounts
Update an ownership account: 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`; Ownership Accounts
Retrieve the partial payment settings for residents: Retrieves the partial payment settings for residents. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Application Settings</span> - `View`; Administration
Update the partial payment settings for residents: Updates the partial payment settings for residents. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Application Settings</span> - `View` `Edit`; Administration
Create a phone log: Creates a phone log. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View` `Edit`; Communications
Retrieve a phone log: Retrieves a specific phone log. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View`; Communications
Retrieve all phone logs: Retrieves all phone logs. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Timelines (Phone Logs)</span> - `View`; Communications
Update a phone log: 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`; Communications
Create a property group: 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`; Property Groups
Retrieve a property group: 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`; Property Groups
Retrieve all property groups: 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`; Property Groups
Update a property group: 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`; Property Groups
Create a service history: Creates a service history record for an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Appliances
Retrieve all service history: 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`; Rental Appliances
Retrieve a service history: 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`; Rental Appliances
Create an appliance: Creates a rental property appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Appliances
Delete an appliance: Deletes an appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Appliances
Retrieve an appliance: Retrieves a rental appliance. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Appliances
Retrieve all appliances: Retrieves all rental appliances. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Appliances
Update an appliance: 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`; Rental Appliances
Delete meter reading details for a given date: 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`; Rental Meter Readings
Retrieve ePay settings: Retrieves ePay settings for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Update ePay settings: Updates ePay settings for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Properties
Retrieve all amenities: Retrieve all the amenities for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Update amenities: 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`; Rental Properties
Download a property image: 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`; Rental Properties
Update property image order: 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`; Rental Properties
Upload a rental image: 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`; Rental Properties
Create an image for a rental using a video link: 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`; Rental Properties
Delete a property image: Deletes a rental property image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit` `Delete`; Rental Properties
Retrieve a property image: Retrieves a rental property image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Retrieve all property images: 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`; Rental Properties
Update a property image: Updates a rental property image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Properties
Retrieve all meter reading details: Retrieves all meter reading details for a property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Meter Readings
Create/Update meter reading details: 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`; Rental Meter Readings
Retrieve all meter readings: Retrieves all meter readings for a rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Meter Readings
Create a note: Creates a note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Properties
Retrieve a note: Retrieves a note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Retrieve all notes: Retrieves all notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Update a note: 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`; Rental Properties
Create a note: Creates a new Rental Owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View` `Edit`; Rental Owners
Retrieve a note: Retrieves a rental owner note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`; Rental Owners
Retrieves all notes: Retrieves all rental owner notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`; Rental Owners
Update a note: 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`; Rental Owners
Create a rental owner request: Creates a rental owner request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; Rental Owner Requests
Retrieve all rental owner requests: Retrieves all rental owner requests. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Rental Owner Requests
Retrieve a rental owner request: Retrieves a specific rental owner request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Rental Owner Requests
Retrieve rental owner contribution request: Retrieves the contribution details for a rental owner contribution request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Rental Owner Requests
Update a rental owner request: 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`; Rental Owner Requests
Update a rental owner contribution request: Updates the contribution details for a rental owner contribution request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; Rental Owner Requests
Create an owner: Creates a rental owner. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View` `Edit`; Rental Owners
Retrieve an owner: Retrieves a specific rental owner. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`; Rental Owners
Retrieve all owners: Retrieves a list of rental owners. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Property Rental Owners</span> - `View`; Rental Owners
Update an owner: 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`; Rental Owners
Retrieve all preferred vendors: 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`; Rental Properties
Update preferred vendors: 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`; Rental Properties
Create a tenant: 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`; Rental Tenants
Retrieve all tenants: Retrieves a list of tenants. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View`; Rental Tenants
Retrieve a tenant: Retrieve a specific tenant. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View`; Rental Tenants
Update a tenant: 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`; Rental Tenants
Retrieve all amenities: Retrieves all amenities for a rental unit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Update amenities: Updates the amenities for a rental 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">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Units
Download a unit image: Use this endpoint to create a temporary URL that can be used to download a unit image. This URL expires after 5 minutes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Update unit image order: 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`; Rental Units
Upload a unit image: 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/units/{unitId}/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 `Headers` property to this request as header key/value pairs. <strong>NOTE:</strong> These values must be added to the request headers 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`; Rental Units
Create an image for a unit using a video link: Creates an image for a rental unit using a video link. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Properties and units</span> - `View` `Edit`; Rental Units
Delete a unit image: Deletes a unit image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit` `Delete`; Rental Units
Retrieve a unit image: Retrieves a unit image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Retrieve all unit images: Retrieves all images for a unit. 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-Units/operation/ExternalApiRentalUnitImageDownloadRequests_GetRentalUnitImageDownloadUrlById) endpoint. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Update a unit image: Updates a unit image. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Properties and units</span> - `View` `Edit`; Rental Units
Create a note: Creates a rental unit note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Units
Retrieve a note: Retrieves a rental unit note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Retrieve all notes: Retrieves all rental unit notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Update a note: Updates a rental 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">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Units
Create a unit: Creates a rental unit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Units
Retrieve all units: Retrieves a list of rental property units. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Retrieve a unit: Retrieves a specific rental property unit. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Units
Update a unit: Updates a rental 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">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Units
Inactivate a property: Inactivates a rental property and all associated units. Any associated property's owners that have no remaining active properties will be inactivated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Properties
Reactivate a property: Reactivates a rental property and all associated units. Any inactive rental owners assigned to this property will also be reactivated. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Properties
Create a property: Creates a new rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View` `Edit`; Rental Properties
Retrieve all properties: Retrieves a list of rental properties. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Retrieve a property: Retrieve a specific rental property. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Rental properties and units</span> - `View`; Rental Properties
Update a property: Updates 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`; Rental Properties
Retrieve all insurance policies: Retrieves all renters insurance policies for a lease. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve an insurance policy: Retrieves a renters insurance policy. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Leases</span> - `View`; Leases
Retrieve all resident center users: Retrieves all resident center users for both rentals and associations. <h4>Required permission(s):</h4><span class="permissionBlock">Communications > Resident Center Users</span> - `View` <span class="permissionBlock">Rentals > Tenants</span> - `View` is required to retrieve resident center users that are tenants. <span class="permissionBlock">Associations > Association owners and tenants</span> - `View` is required to retrieve resident center users that are association owners.; Resident Center
Create a resident request: Creates a resident request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; Resident Requests
Retrieve a resident request: Retrieves a specific resident request. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Resident Requests
Retrieve all resident requests: Retrieves a list of resident requests. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Resident Requests
Update a resident request: Update a resident 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`; Resident Requests
Retrieve a retail cash user: Retrieves a retail cash user. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` OR <span class="permissionBlock"> Associations > Association owners and tenants</span> - `View`; Resident Center
Retrieve all retail cash users: Retrieves all retail cash users. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` OR <span class="permissionBlock"> Associations > Association owners and tenants</span> - `View`; Resident Center
Update a retail cash user: Updates a retail cash user. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` `Edit` OR <span class="permissionBlock"> Associations > Association owners and tenants</span> - `View` `Edit`; Resident Center
Create a task category: Create a task category. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; Tasks
Retrieve all task categories: Retrieves a list of task categories. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Retrieve a task category: Retrieves a specific task category. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Update a task category: Updates a task category. <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`; Tasks
Download a task history file: Downloads a specific file associated to the task history record. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Upload a task history file: Uploads a file and associates it to the specified task history record. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. 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/tasks/{taskId}/history/{taskHistoryId}/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">Tasks > Tasks</span> - `View` `Edit`; Tasks
Delete task history file: Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit` `Delete`; Tasks
Retrieve all task history files: Retrieves the metadata for all files associated with a task history record. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Retrieve a task history file: Retrieves the metadata for a specific file associated with a task history record. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Retrieve all task history: Retrieves all task history records for a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Retrieve a task history: Retrieves a specific task history record for a task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Update a task history: Updates a specific task history record for a task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; Tasks
Retrieve all tasks: Retrieves a list of all task/request types (Contact, Owner, Resident and To Do). Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Retrieve a task: Retrieves a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; Tasks
Create a note: Creates a tenant note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View` `Edit`; Rental Tenants
Retrieve all notes: Retrieves all tenant notes. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View`; Rental Tenants
Retrieve a note: Retrieves a tenant note. <h4>Required permission(s):</h4><span class="permissionBlock">Rentals > Tenants</span> - `View`; Rental Tenants
Update a note: Updates a 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">Rentals > Tenants</span> - `View` `Edit`; Rental Tenants
Create a to do request: Creates a to do task. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View` `Edit`; To Do Requests
Retrieve a to do request: Retrieves a to do task. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; To Do Requests
Retrieve all to do requests: Retrieves a list of to do tasks. <h4>Required permission(s):</h4><span class="permissionBlock">Tasks > Tasks</span> - `View`; To Do Requests
Update a to do request: Updates a to do task <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`; To Do Requests
Retrieve all user roles: Retrieves a list of user roles. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > User Roles</span> - `View`; Administration
Retrieve a user role: Retrieve a specific user role. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > User Roles</span> - `View`; Administration
Retrieve all users: Retrieves a list of users. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Users</span> - `View`; Administration
Retrieve a user: Retrieve a specific user. <h4>Required permission(s):</h4><span class="permissionBlock">Administration > Users</span> - `View`; Administration
Create a vendor category: Creates a vendor category. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View` `Edit`; Vendors
Retrieve all vendor categories: Retrieves a list of vendor categories. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Retrieve a vendor category: Retrieves a specific vendor category. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Update a vendor category: Updates a vendor category. <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">Maintenance > Vendors</span> - `View` `Edit`; Vendors
Retrieve a credit: Retrieves a credit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View`; Vendors
Create a credit: Creates a credit. <h4>Required permission(s):</h4><span class="permissionBlock">Accounting > Bills</span> - `View` `Edit`; Vendors
Create a note: Creates a vendor note. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View` `Edit`; Vendors
Retrieve a note: Retrieves a vendor note. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Retrieve all notes: Retrieves all vendor notes. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Update a note: Updates a vendor 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">Maintenance > Vendors</span> - `View` `Edit`; Vendors
Retrieve a refund: Retrieves a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Create a refund: Creates a refund. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View` `Edit` <span class="permissionBlock">Accounting > Bank Accounts</span> - `View`; Vendors
Retrieve all transactions: Retrieves all transactions for a given vendor. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View` <span class="permissionBlock">Accounting > General Ledger Transactions</span> - `View`; Vendors
Create a vendor: Creates a vendor. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View` `Edit`; Vendors
Retrieve all vendors: Retrieves a list of vendors. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Retrieve a vendor: Retrieve a specific vendor. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Vendors</span> - `View`; Vendors
Update a vendor: Updates a vendor. <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">Maintenance > Vendors</span> - `View` `Edit`; Vendors
Create a work order: Creates a work order. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Work Orders</span> - `View` `Edit`; Work Orders
Retrieve all work orders: Retrieves a list of work orders. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Work Orders</span> - `View`; Work Orders
Retrieve a work order: Retrieves a specific work order. <h4>Required permission(s):</h4><span class="permissionBlock">Maintenance > Work Orders</span> - `View`; Work Orders
Update a work order: Updates a work order. <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">Maintenance > Work Orders</span> - `View` `Edit`; Work Orders

FAQ

Buildium integration, answered

How do AI agents use Buildium through Open Connector?: Your user connects Buildium once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Buildium tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a Buildium MCP server?: Yes. Open Connector can serve Buildium as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Buildium actions with credentials injected server-side.
Where do Buildium credentials live?: In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents Buildium — keep the keys.

Open source, self-hostable, with Buildium credentials that never leave your infrastructure. Run it from source today.

View source on GitHub How the MCP gateway works →