Buildium
API integration

list_all_buildium_application_transactions

Retrieve all application transactions in Buildium. Retrieves all the transactions for a specific application. Returns: Id, Date, TransactionTypeEnum, TotalAmount, CheckNumber, ApplicationId, PayeeApplicantId, PaymentMethod, Journal. Required: application_id. Needs Buildium permission: Rentals > Lease transactions (View).

get_single_buildium_application_transaction_by_id

Retrieve an application transaction in Buildium. Retrieves a specific application transaction. Returns: Id, Date, TransactionTypeEnum, TotalAmount, CheckNumber, ApplicationId, PayeeApplicantId, PaymentMethod, Journal. Required: application_id, id. Needs Buildium permission: Rentals > Lease Transactions (View).

list_all_buildium_associations

List buildium associations with optional filtering. Returns: Id, Name, Description. Max 1000 results per page.

create_a_buildium_association

Create an association in Buildium. Creates an association. Returns: Id, Name, IsActive, Reserve, Description, YearBuilt, OperatingBankAccount, OperatingBankAccountId, Address, AssociationManager, FiscalYearEndDay, FiscalYearEndMonth, and more. Required: Address, Name, OperatingBankAccountId. Needs Buildium permission: Associations > Associations and units (View, Edit).

get_single_buildium_association_by_id

Retrieve a specific buildium association by id. Returns: Id, Name, Description. Required: id.

update_a_buildium_association_by_id

Update an association in Buildium. Updates an association. NOTE: 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. Returns: Id, Name, IsActive, Reserve, Description, YearBuilt, OperatingBankAccount, OperatingBankAccountId, Address, AssociationManager, FiscalYearEndDay, FiscalYearEndMonth, and more. Required: id, Address, FiscalYearEndDay, FiscalYearEndMonth, Name, OperatingBankAccountId. Needs Buildium permission: Associations > Associations and units (View, Edit).

list_all_buildium_ownershipaccount_transactions

Retrieve all transactions in Buildium. Retrieves all ledger transactions for a specific ownership account. Returns: Id, Date, TransactionType, TransactionTypeEnum, TotalAmount, CheckNumber, OwnershipAccountId, PayeeAssociationOwnerId, PaymentMethod, Journal. Required: ownership_account_id. Needs Buildium permission: Associations > Ownership account transactions (View).

get_single_buildium_ownershipaccount_transaction_by_id

Retrieve a transaction in Buildium. Retrieves a specific ownership account ledger transaction. Returns: Id, Date, TransactionType, TransactionTypeEnum, TotalAmount, CheckNumber, OwnershipAccountId, PayeeAssociationOwnerId, PaymentMethod, Journal. Required: ownership_account_id, id. Needs Buildium permission: Associations > Ownership account transactions (View).

list_all_buildium_ownershipaccounts_architecturalrequests

Retrieve all architectural requests in Buildium. Retrieves all architectural requests. Returns: Id, AssociationId, OwnershipAccountId, Name, SubmittedDateTime, Status, Decision, CreatedDateTime, CreatedByUser, LastUpdatedDateTime, LastUpdatedByUser. Needs Buildium permission: Associations > Associations and units (View); Associations > Ownership accounts (View); Associations > Association owners and tenants (View); Associations > Architectural requests (View).

create_a_buildium_ownershipaccounts_architecturalrequest

Create an architectural request in Buildium. Creates an architectural request. Returns: Id, AssociationId, OwnershipAccountId, Name, SubmittedDateTime, Status, Decision, CreatedDateTime, CreatedByUser, LastUpdatedDateTime, LastUpdatedByUser. Required: AssociationId, Name, OwnershipAccountId, SubmittedDateTime. Needs Buildium permission: Associations > Associations and units (View, Edit); Associations > Ownership accounts (View, Edit); Associations > Architectural requests (View, Edit); Associations > Association owners and tenants (View, Edit).

get_single_buildium_ownershipaccounts_architecturalrequest_by_id

Retrieve an architectural request in Buildium. Retrieves a specific architectural request. Returns: Id, AssociationId, OwnershipAccountId, Name, SubmittedDateTime, Status, Decision, CreatedDateTime, CreatedByUser, LastUpdatedDateTime, LastUpdatedByUser. Required: id. Needs Buildium permission: Associations > Associations and units (View); Associations > Ownership accounts (View); Associations > Association owners and tenants (View); Associations > Architectural requests (View).

list_all_buildium_files

List buildium files within the customer account, returning file metadata only. Returns: Id, Description. Filter by entity, category, upload date range, title/description, or physical filename. Use the Download File endpoint to retrieve actual file content.

get_single_buildium_file_by_id

Get buildium file metadata by id. Returns the full file record including Id, Title, Description, FileEntity (associated entity reference with Id, EntityType, and Href), CategoryId, PhysicalFileName, Size, ContentType, and UploadedDateTime. Required: id. Use the Download File endpoint to retrieve the actual file content.

update_a_buildium_file_by_id

Update a file in Buildium. Updates a metadata of the file. NOTE: 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. Returns: Id, FileEntity, CategoryId, Title, Description, PhysicalFileName, Size, ContentType, UploadedDateTime. Required: id, CategoryId, Title. Needs Buildium permission: Documents > Files (View, Edit).

buildium_files_download

Download a file from Buildium: returns the file itself (an image, PDF or document). Pass the DownloadUrl that a Buildium download request returns, such as a task history file, file, bill file, check file or rental/unit image download request. The URL expires 5 minutes after the request, so call this right after it. Required: path.

list_all_buildium_leases

Retrieve all leases in Buildium. Retrieves a list of leases. Returns: Id, PropertyId, UnitId, UnitNumber, LeaseFromDate, LeaseToDate, LeaseType, LeaseStatus, IsEvictionPending, TermType, RenewalOfferStatus, CurrentTenants, and more. Needs Buildium permission: Rentals > Leases (View).

get_single_buildium_lease_by_id

Retrieve a lease in Buildium. Retrieves a specific lease. Returns: Id, PropertyId, UnitId, UnitNumber, LeaseFromDate, LeaseToDate, LeaseType, LeaseStatus, IsEvictionPending, TermType, RenewalOfferStatus, CurrentTenants, and more. Required: id. Needs Buildium permission: Rentals > Leases (View).

list_all_buildium_lease_transactions

Retrieve all lease transactions in Buildium. Retrieves all the transactions for a specific lease. Returns: Id, Date, TransactionType, TransactionTypeEnum, TotalAmount, CheckNumber, LeaseId, PayeeTenantId, PaymentMethod, Journal. Required: lease_id. Needs Buildium permission: Rentals > Lease transactions (View).

get_single_buildium_lease_transaction_by_id

Retrieve a lease transaction in Buildium. Retrieves a specific lease transaction. Returns: Id, Date, TransactionType, TransactionTypeEnum, TotalAmount, CheckNumber, LeaseId, PayeeTenantId, PaymentMethod, Journal. Required: lease_id, id. Needs Buildium permission: Rentals > Lease Transactions (View).

list_all_buildium_rentals

List buildium rental properties. Returns: Id, Name, Type. Optionally filter by location, types, subtypes, status, rentalownerids, propertyids, or last-updated date range.

create_a_buildium_rental

Create a property in Buildium. Creates a new rental property. Returns: Id, Name, StructureDescription, NumberUnits, IsActive, OperatingBankAccountId, Reserve, Address, YearBuilt, RentalType, RentalSubType, RentalManager. Required: Address, Name, OperatingBankAccountId, RentalSubType. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

get_single_buildium_rental_by_id

Get a single buildium rental property by id. Returns: Id, Name, Type. Required: id.

update_a_buildium_rental_by_id

Update a property in Buildium. Updates a rental property. NOTE: 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. Returns: Id, Name, StructureDescription, NumberUnits, IsActive, OperatingBankAccountId, Reserve, Address, YearBuilt, RentalType, RentalSubType, RentalManager. Required: id, Address, Name, OperatingBankAccountId, RentalSubType. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

list_all_buildium_units_listings

List all rental unit listings in buildium. Returns an array of listing records; each record includes at minimum its id. Optionally filter by entitytype and entityid, or control sort order with orderby.

list_all_buildium_users

Retrieve all users in Buildium. Retrieves a list of users. Returns: Id, UserTypes, IsActive, LastLogin, FirstName, LastName, CompanyName, Email, AlternateEmail, PhoneNumbers, UserRole, IsCompany. Needs Buildium permission: Administration > Users (View).

get_single_buildium_user_by_id

Retrieve a user in Buildium. Retrieve a specific user. Returns: Id, UserTypes, IsActive, LastLogin, FirstName, LastName, CompanyName, Email, AlternateEmail, PhoneNumbers, UserRole, IsCompany. Required: id. Needs Buildium permission: Administration > Users (View).

list_all_buildium_unit_listings

Retrieve the active listing for a buildium rental unit. Returns: ListingDate, Rent, Deposit, AvailableDate, IsManagedExternally, RentalApplicationUrl, Contact (with Id, Name, Email, PhoneNumber, Website), Property, and Unit details. Required: unit_id.

update_a_buildium_unit_listing_by_id

Create/Update a listing in Buildium. 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. Returns: ListingDate, Rent, Deposit, LeaseTerms, AvailableDate, IsManagedExternally, RentalApplicationUrl, Contact, Property, Unit. Required: unit_id, AvailableDate, IsManagedExternally, Rent. Needs Buildium permission: Rentals > Listings (View, Edit); Rentals > Rental properties and units (View, Edit).

delete_a_buildium_unit_listing_by_id

Delete the listing for a buildium rental unit, removing it from the Buildium public website immediately and from syndicated sites within 24-48 hours. Returns an empty 204 response on success. Required: unit_id.

list_all_buildium_applications_outstandingbalances

List buildium applications that have outstanding balances; applications with a zero or credit balance are excluded from results. Returns ApplicationOutstandingBalanceMessage records including id and schema-specific balance attributes (consult Buildium's API docs for the full field-level breakdown). Optionally filter by applicationstatuses or applicationids.

list_all_buildium_architecturalrequest_files

List all files for a buildium architectural request. Returns: Id. Required: architectural_request_id.

get_single_buildium_architecturalrequest_file_by_id

Get a single buildium architectural request file by id. Returns: Id, Title, PhysicalFileName, Size, ContentType, UploadedDateTime. Required: architectural_request_id, id.

list_all_buildium_ownershipaccounts_outstandingbalances

Retrieve all outstanding balances in Buildium. Retrieves a list of ownership account outstanding balances. Returns: OwnershipAccountId, AssociationId, UnitId, Balance0To30Days, Balance31To60Days, Balance61To90Days, BalanceOver90Days, TotalBalance, Balances, PastDueEmailSentDate. Needs Buildium permission: Associations > Outstanding Balances (View).

list_all_buildium_associations_units

List all Buildium association units. Returns each unit's Id and Href. Optional filters include associationids, lastupdatedfrom, lastupdatedto, and orderby.

create_a_buildium_associations_unit

Create a unit in Buildium. Creates an association unit. Returns: Id, AssociationId, AssociationName, UnitNumber, Address, UnitBedrooms, UnitBathrooms, UnitSize. Required: Address, AssociationId, UnitNumber. Needs Buildium permission: Associations > Associations and units (View, Edit).

get_single_buildium_associations_unit_by_id

Get a single Buildium association unit by id. Returns the unit's Id and Href. Required: id.

update_a_buildium_associations_unit_by_id

Update a unit in Buildium. Updates an association unit. NOTE: 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. Returns: Id, AssociationId, AssociationName, UnitNumber, Address, UnitBedrooms, UnitBathrooms, UnitSize. Required: id, Address, UnitNumber. Needs Buildium permission: Associations > Associations and units (View, Edit).

list_all_buildium_leases_outstandingbalances

List buildium leases with outstanding balances; leases with a zero or credit balance are excluded. Returns records including LeaseId, TotalBalance, Balance0to30Days, Balance31to60Days, Balance61to90Days, BalanceOver90Days, and EvictionPending. Optional filters include entitytype, entityid, leasestatuses, leaseids, pastdueemail, balanceduration, and evictionstatus.

list_all_buildium_units_listingcontacts

List all listing contacts in buildium. Returns an array of listing contact records each including Id, Name, Email, PhoneNumber, and Website. Supports optional sorting via the orderby parameter.

create_a_buildium_units_listingcontact

Create a listing contact in Buildium. Create a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. Returns: Id, Name, Email, PhoneNumber, Website. Required: Name. Needs Buildium permission: Rentals > Listings (View, Edit).

get_single_buildium_units_listingcontact_by_id

Get a specific buildium listing contact by id. Returns the full listing contact record including Id, Name, Email, PhoneNumber, and Website. Required: id.

update_a_buildium_units_listingcontact_by_id

Update a listing contact in Buildium. Update a listing contact. Note, at least one contact field (phone number, email or website) is required for the listing contact. NOTE: 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. Returns: Id, Name, Email, PhoneNumber, Website. Required: id, Name. Needs Buildium permission: Rentals > Listings (View, Edit).

list_all_buildium_userroles

List all user roles in buildium. Returns: Id, Name, Description, NumberOfUsers.

get_single_buildium_userrole_by_id

Get a specific buildium user role by id. Returns: Id, Name, Description, NumberOfUsers. Required: id.

list_all_buildium_application_charges

Retrieve all charges in Buildium. Retrieves all the charges for a specific application. Returns: Id, Date, TotalAmount, Memo, Lines. Required: application_id. Needs Buildium permission: Rentals > Lease transactions (View).

get_single_buildium_application_charge_by_id

Retrieve a charge in Buildium. Retrieves a specific application charge. Returns: Id, Date, TotalAmount, Memo, Lines. Required: application_id, id. Needs Buildium permission: Rentals > Lease Transactions (View).

list_all_buildium_ownershipaccount_charges

Retrieve all charges in Buildium. Retrieves all ledger charges for a specific ownership account. Returns: Id, Date, TotalAmount, Memo, BillId, Lines. Required: ownership_account_id. Needs Buildium permission: Associations > Ownership account transactions (View).

get_single_buildium_ownershipaccount_charge_by_id

Retrieve a charge in Buildium. Retrieves a specific ownership account ledger charge. Returns: Id, Date, TotalAmount, Memo, BillId, Lines. Required: ownership_account_id, id. Needs Buildium permission: Associations > Ownership account transactions (View).

create_a_buildium_file_downloadrequest

Download a file in Buildium. 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. Returns: DownloadUrl. Required: file_id. Needs Buildium permission: Documents > Files (View). To get the file itself, pass DownloadUrl to buildium_files_download right away.

list_all_buildium_lease_charges

Retrieve all charges in Buildium. Retrieves all the charges for a specific lease. Returns: Id, Date, TotalAmount, Memo, BillId, Lines. Required: lease_id. Needs Buildium permission: Rentals > Lease transactions (View).

get_single_buildium_lease_charge_by_id

Retrieve a charge in Buildium. Retrieves a specific lease charge. Returns: Id, Date, TotalAmount, Memo, BillId, Lines. Required: lease_id, id. Needs Buildium permission: Rentals > Lease transactions (View).

list_all_buildium_associations_ownershipaccounts

List buildium association ownership accounts. Returns: Id. Supports optional filters: ids, associationids, unitorowner, datefrom, dateto, status, and delinquencystatuses.

create_a_buildium_associations_ownershipaccount

Create an ownership account in Buildium. Creates an ownership account. Returns: Id, AssociationId, UnitId, Status, DateOfPurchase, DateOfSale, Comments, AssociationOwnerIds, DelinquencyStatus. Required: DateOfPurchase, ReplaceExistingOwnershipAccount, SendWelcomeEmail, UnitId. Needs Buildium permission: Associations > Ownership accounts (View, Edit); Associations > Owners (View, Edit).

get_single_buildium_associations_ownershipaccount_by_id

Retrieve a single buildium association ownership account by id. Returns: Id. Required: id.

update_a_buildium_associations_ownershipaccount_by_id

Update an ownership account in Buildium. Updates an ownership account. NOTE: 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. Returns: Id, AssociationId, UnitId, Status, DateOfPurchase, DateOfSale, Comments, AssociationOwnerIds, DelinquencyStatus. Required: id, DateOfPurchase. Needs Buildium permission: Associations > Ownership accounts (View, Edit).

list_all_buildium_lease_moveouts

List all move out records for a buildium lease. Returns: TenantId, MoveOutDate, NoticeGivenDate. Required: lease_id.

create_a_buildium_lease_moveout

Create move out data for a single tenant on a buildium lease. Returns: TenantId, MoveOutDate, NoticeGivenDate. Required: lease_id, TenantId, MoveOutDate.

delete_a_buildium_lease_moveout_by_id

Delete move out data for a tenant on a buildium lease by id. Returns an empty 204 response on success. Required: lease_id, id.

get_single_buildium_lease_moveout_by_id

Get move out data for a single tenant on a buildium lease by id. Returns: TenantId, MoveOutDate, NoticeGivenDate. Required: lease_id, id.

create_a_buildium_rental_inactivationrequest

Inactivate a buildium rental property and all its associated units. Any property owners with no remaining active properties will also be inactivated. Returns an empty 204 response on success. Required: property_id.

create_a_buildium_rental_reactivationrequest

Reactivate a rental property in buildium, along with all its associated units and any inactive rental owners assigned to it. Returns an empty 204 response on success. Required: property_id.

list_all_buildium_associations_owners

List association owners in buildium with optional filters by name, phone, email, association IDs, statuses, and date ranges. Returns: Id, Name.

create_a_buildium_associations_owner

Create an owner in Buildium. Creates an association owner. Returns: Id, FirstName, LastName, Email, AlternateEmail, PhoneNumbers, PrimaryAddress, AlternateAddress, Comment, EmergencyContact, OwnershipAccounts, MailingPreference, and more. Required: FirstName, IsOwnerOccupied, LastName, OwnershipAccountId, PrimaryAddress, SendWelcomeEmail. Needs Buildium permission: Associations > Association owners and tenants (View, Edit); Associations > Ownership accounts (View, Edit).

get_single_buildium_associations_owner_by_id

Retrieve a specific buildium association owner by id. Returns: Id, Name. Required: id.

update_a_buildium_associations_owner_by_id

Update an owner in Buildium. Updates an existing association owner. NOTE: 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. Returns: Id, FirstName, LastName, Email, AlternateEmail, PhoneNumbers, PrimaryAddress, AlternateAddress, Comment, EmergencyContact, OwnershipAccounts, MailingPreference, and more. Required: id, FirstName, LastName, PrimaryAddress. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

list_all_buildium_rental_vendors

List all preferred vendors for a buildium rental property. Returns an array of preferred vendor records; each record includes VendorId. Required: property_id.

update_a_buildium_rental_vendor_by_id

Update preferred vendors in Buildium. Updates preferred vendors. Returns: Id, FirstName, LastName, CompanyName, PrimaryEmail, AlternateEmail, PhoneNumbers, Website, IsCompany. Required: property_id, VendorIds. Needs Buildium permission: Rentals > Rental properties and units (View, Edit); Maintenance > Vendors (View, Edit).

list_all_buildium_associations_tenants

List association tenants in buildium with optional filtering by name, phone, email, associationids, statuses, and date ranges. Returns per tenant: Id, FirstName, LastName, Email, PhoneNumbers, PrimaryAddress, MoveInDate, MoveOutDate, and CreatedDateTime.

create_a_buildium_associations_tenant

Create a tenant in Buildium. Creates an association tenant. Returns: Id, FirstName, LastName, Email, AlternateEmail, PhoneNumbers, PrimaryAddress, AlternateAddress, Comment, EmergencyContact, OwnershipAccounts, MoveInDate, and more. Required: FirstName, LastName, OwnershipAccountId, PrimaryAddress. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

get_single_buildium_associations_tenant_by_id

Retrieve a specific association tenant by id in buildium. Returns the full tenant record including Id, FirstName, LastName, Email, PhoneNumbers, PrimaryAddress, AlternateAddress, EmergencyContact, OwnershipAccounts, MoveInDate, MoveOutDate, and CreatedDateTime. Required: id.

update_a_buildium_associations_tenant_by_id

Update a tenant in Buildium. Updates an association tenant. NOTE: 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. Returns: Id, FirstName, LastName, Email, AlternateEmail, PhoneNumbers, PrimaryAddress, AlternateAddress, Comment, EmergencyContact, OwnershipAccounts, MoveInDate, and more. Required: id, FirstName, LastName, PrimaryAddress. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

list_all_buildium_lease_notes

List all notes for a buildium lease. Returns: Id. Required: lease_id. Optionally filter by updated date range or last-updated user.

create_a_buildium_lease_note

Create a note on a buildium lease. Returns: Id. Required: lease_id, Note.

update_a_buildium_lease_note_by_id

Update a note in Buildium. Updates a lease note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: lease_id, id, Note. Needs Buildium permission: Rentals > Leases (View, Edit).

get_single_buildium_lease_note_by_id

Get a single buildium lease note by id. Returns: Id, Note, LastUpdatedByUser, UpdatedDateTime. Required: lease_id, id.

create_a_buildium_ownershipaccount_refund

Create a refund in Buildium. Creates a refund. Returns: Id, Date, Payees, Memo, CheckNumber, BankAccountId, Address, TotalAmount, Lines. Required: ownership_account_id, Address, BankAccountId, Date, Lines, PayeeUserIds. Needs Buildium permission: Accounting > Bank Accounts (View, Edit).

get_single_buildium_ownershipaccount_refund_by_id

Get a single buildium ownership account refund by id. Returns the refund object including Id, Date, Amount, Memo, and BankAccountId. Required: ownership_account_id, id.

create_a_buildium_lease_refund

Create a refund in Buildium. Creates a refund. Returns: Id, Date, Payees, Memo, CheckNumber, BankAccountId, Address, TotalAmount, Lines. Required: lease_id, Address, BankAccountId, Date, Lines, PayeeUserIds. Needs Buildium permission: Accounting > Bank Accounts (View, Edit).

get_single_buildium_lease_refund_by_id

Get a single lease ledger refund in Buildium by its id. Returns: Id, Date, Payees, Memo, CheckNumber, BankAccountId, Address, TotalAmount, Lines. Required: lease_id, id.

create_a_buildium_application_refund

Create a refund in Buildium. Creates a refund for a specific application. Returns: Id, Date, Payees, Memo, CheckNumber, BankAccountId, Address, TotalAmount, Lines. Required: application_id, Address, BankAccountId, Date, Lines. Needs Buildium permission: Rentals > Lease transactions (View, Edit).

get_single_buildium_application_refund_by_id

Get a specific buildium application refund by id. Returns: Id, Date, Payees, Memo, CheckNumber, BankAccountId, Address, TotalAmount, Lines. Required: application_id, id.

list_all_buildium_leases_renewals

List all upcoming lease renewals in buildium across all rental properties. Returns a collection of lease renewal records including id. Required: esignaturestatuses. Results can be filtered by propertyids and rentalownerids.

list_all_buildium_lease_renewals

List all renewals for a specific buildium lease. Returns: Id. Required: lease_id.

create_a_buildium_lease_renewal

Create a lease renewal in Buildium. Creates a lease renewal. Returns: Id, LeaseStatus, LeaseFromDate, LeaseToDate, LeaseType, Rent, RentId, TenantIds. Required: lease_id, LeaseType, Rent, SendWelcomeEmail. Needs Buildium permission: Rentals > Leases (View, Edit).

get_single_buildium_lease_renewal_by_id

Get a single buildium lease renewal by id. Returns: Id, LeaseStatus, LeaseFromDate, LeaseToDate, LeaseType, Rent, RentId, TenantIds. Required: lease_id, id.

list_all_buildium_ownershipaccount_recurringtransactions

List all recurring transactions for a buildium ownership account. Returns an array of recurring transaction records, each including id. Required: ownership_account_id.

list_all_buildium_lease_recurringtransactions

List all recurring transactions for a given buildium lease. Returns an array of recurring transaction records including id and transaction-specific attributes. Required: lease_id.

list_all_buildium_administration_accounts

Retrieve account information for the Buildium account. Returns: Id, CompanyName, Url, Contact, AccountingSettings.

list_all_buildium_administration_accountinglockperiods

Retrieve the accounting lock period configuration in buildium. Returns the accounting lock period configuration object. No required parameters.

list_all_buildium_residentsettings_partialpaymentsettings

Retrieve the global partial payment settings for residents in Buildium. Returns: RequirePaymentsInFull.

update_a_buildium_residentsettings_partialpaymentsetting_by_id

Update the partial payment settings for residents in Buildium. Updates the partial payment settings for residents. Returns: RequirePaymentsInFull. Needs Buildium permission: Administration > Application Settings (View, Edit).

list_all_buildium_applicants

List all applicants in buildium. Returns applicant records including id, name, and email. Supports filtering by entityid, entitytype, applicationstatuses, unitids, name, email, applicationsubmittedstartdate, applicationsubmittedenddate, lastupdatedfrom, and lastupdatedto.

create_a_buildium_applicant

Create an applicant in Buildium. Creates an applicant. Returns: Id, ApplicantGroupId, PropertyId, UnitId, TenantId, FirstName, LastName, Email, PhoneNumbers, Status, Applications, UnsubmittedApplications, and more. Required: FirstName, LastName, SendRentalApplicationEmail. Needs Buildium permission: Rentals > Applicants (View, Edit).

get_single_buildium_applicant_by_id

Get a single buildium applicant by id. Returns the applicant record including id, name, and email. Required: id.

update_a_buildium_applicant_by_id

Update an applicant in Buildium. Updates an applicant. NOTE: 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. Returns: Id, ApplicantGroupId, PropertyId, UnitId, TenantId, FirstName, LastName, Email, PhoneNumbers, Status, Applications, UnsubmittedApplications, and more. Required: id, FirstName, LastName. Needs Buildium permission: Rentals > Applicants (View, Edit).

list_all_buildium_applicant_applications

List all buildium applications for a given applicant. Returns: Id. Required: applicant_id.

update_a_buildium_applicant_application_by_id

Update an application in Buildium. Updates a rental application. NOTE: 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. Returns: Id, ApplicationNumber, ApplicationStatus, ApplicationSubmittedDateTime, Application. Required: applicant_id, id, ApplicationStatus. Needs Buildium permission: Rentals > Applicants (View, Edit).

get_single_buildium_applicant_application_by_id

Get a single buildium rental application by id for a given applicant. Returns: Id, ApplicationNumber, ApplicationStatus, ApplicationSubmittedDateTime, Application. Required: applicant_id, id.

list_all_buildium_applicant_notes

List all notes for a buildium applicant. Returns: Id. Required: applicant_id.

create_a_buildium_applicant_note

Create a new note for a buildium applicant. Returns the created note including its Id, Note, LastUpdatedDateTime, and LastUpdatedByUser. Required: applicant_id, Note.

get_single_buildium_applicant_note_by_id

Retrieve an applicant note in Buildium. Retrieves an applicant note. Returns: Id, Note, LastUpdatedByUser. Required: applicant_id, id. Needs Buildium permission: Rentals > Applicants (View).

list_all_buildium_applicants_groups

List all applicant groups in buildium, optionally filtered by entity type, entity id, group status, unit ids, or applicant name. Returns items with Id, PropertyId, UnitId, ApplicationGroupStatus, and Applicants (each with name, email, phone numbers, status, and applications).

create_a_buildium_applicants_group

Create an applicant group in Buildium. Creates an applicant group. Returns: Id, PropertyId, UnitId, ApplicationGroupStatus, Applicants. Required: ApplicantIds. Needs Buildium permission: Rentals > Applicants (View, Edit).

get_single_buildium_applicants_group_by_id

Get a single applicant group by id in buildium. Returns the applicant group object including Id, PropertyId, UnitId, ApplicationGroupStatus, and Applicants (each with name, email, phone numbers, status, and associated applications). Required: id.

update_a_buildium_applicants_group_by_id

Update an applicant group in Buildium. Updates an applicant group. NOTE: 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. Returns: Id, PropertyId, UnitId, ApplicationGroupStatus, Applicants. Required: id, ApplicantGroupStatus, ApplicantIds. Needs Buildium permission: Rentals > Applicants (View, Edit).

list_all_buildium_group_notes

List all notes for a buildium applicant group. Returns: Id. Required: applicant_group_id.

create_a_buildium_group_note

Create a note for a buildium applicant group. Returns the created note including Id, Note, and LastUpdatedByUser (containing Id, FirstName, LastName, Href, and UpdatedDateTime). Required: applicant_group_id, Note.

update_a_buildium_group_note_by_id

Update a note on a buildium applicant group. Returns the updated note including Id, Note, and LastUpdatedByUser (containing Id, FirstName, LastName, Href, and UpdatedDateTime). Required: applicant_group_id, id, Note. Any field omitted from the request will be set to empty or null.

get_single_buildium_group_note_by_id

Get a single note for a buildium applicant group by id. Returns: Id, Note, LastUpdatedByUser. Required: applicant_group_id, id.

list_all_buildium_association_boardmembers

List all board members for a buildium association. Returns: Id. Optionally filter by statuses, boardpositiontypes, or creation date range. Required: association_id.

create_a_buildium_association_boardmember

Create a board member in Buildium. Creates a board member for a given association. Returns: Id, AssociationOwnerId, FirstName, LastName, Email, PhoneNumbers, BoardPositionType, StartDate, EndDate, CreatedDateTime. Required: association_id, AssociationOwnerId, BoardPositionType. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

update_a_buildium_association_boardmember_by_id

Update a board member in Buildium. Updates a board member for a given association. NOTE: 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. Returns: Id, AssociationOwnerId, FirstName, LastName, Email, PhoneNumbers, BoardPositionType, StartDate, EndDate, CreatedDateTime. Required: association_id, id, BoardPositionType. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

delete_a_buildium_association_boardmember_by_id

Delete a board member from a buildium association by id. This is a hard delete — data cannot be restored. Returns an empty 204 response on success. Required: association_id, id.

get_single_buildium_association_boardmember_by_id

Get a single Buildium association board member by id. Returns the board member record including Id, FirstName, LastName, Email, BoardPositionType, StartDate, EndDate, and CreatedDateTime. Required: association_id, id.

list_all_buildium_association_epaysettings

Retrieve ePay settings for a Buildium association. Returns the ePay settings configuration object; field details are defined by the Buildium EPaySettingsMessage schema — consult the Buildium developer documentation for the field-level breakdown. Required: association_id.

update_a_buildium_association_epaysetting_by_id

Update ePay settings in Buildium. Updates ePay settings for an association. Returns: EFTPayments, CreditCardPayments, OfflinePayments. Required: association_id, CreditCardPayments, EFTPayments, OfflinePayments. Needs Buildium permission: Associations > Associations and units (View, Edit).

create_a_buildium_association_inactivationrequest

Inactivate a buildium association along with its associated units and ownership accounts. Returns an empty 204 response on success. Required: association_id.

list_all_buildium_association_meterreadings

List meter readings for a buildium association within a specified date range. Returns: ReadingDate, ResponseMeterType, Value, Usage, ChargesCreated. Required: association_id, readingdatefrom, readingdateto. Maximum date range between readingdatefrom and readingdateto is 365 days.

list_all_buildium_association_notes

List all notes for a Buildium association. Returns: Id. Optionally filter by updated date range or last-updated user. Required: association_id.

create_a_buildium_association_note

Create a note in Buildium. Creates a note. Returns: Id, Note, LastUpdatedByUser. Required: association_id, Note. Needs Buildium permission: Associations > Associations and units (View, Edit).

update_a_buildium_association_note_by_id

Update a note in Buildium. Updates a note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: association_id, id, Note. Needs Buildium permission: Associations > Associations and units (View, Edit).

get_single_buildium_association_note_by_id

Get a single association note by id in Buildium. Returns: Id, Note, LastUpdatedByUser, UpdatedDateTime. Required: association_id, id.

create_a_buildium_association_reactivationrequest

Reactivate a buildium association along with its associated units and ownership accounts. Returns an empty 204 response on success. Required: association_id.

list_all_buildium_association_vendors

List all preferred vendors for a buildium association. Returns preferred vendor records; the only enumerable field from the available source is Id. Required: association_id.

update_a_buildium_association_vendor_by_id

Update preferred vendors in Buildium. Updates preferred vendors. NOTE: 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. Returns: Id, FirstName, LastName, CompanyName, PrimaryEmail, AlternateEmail, PhoneNumbers, Website, IsCompany. Required: association_id, VendorIds. Needs Buildium permission: Associations > Associations and units (View, Edit); Maintenance > Vendors (View, Edit).

list_all_buildium_associations_banklockboxdatas

List all association bank lockbox data in buildium. Returns bank lockbox data records including id. Optionally filter by associationids to restrict results to specific associations, or control sort order with orderby.

list_all_buildium_owner_units

Retrieve all occupancy statuses in Buildium. Retrieves the occupancy status for all of the units owned by the association owner. Returns: UnitId, IsOccupied. Required: owner_id. Needs Buildium permission: Associations > Association owners and tenants (View); Associations > Ownership Accounts (View).

update_a_buildium_owner_unit_by_id

Update occupancy status in Buildium. Updates whether a unit is occupied by the association owner. NOTE: 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. Returns: UnitId, IsOccupied. Required: owner_id, id, IsOccupied. Needs Buildium permission: Associations > Association owners and tenants (View, Edit); Associations > Ownership Accounts (View).

get_single_buildium_owner_unit_by_id

Retrieve an occupancy status in Buildium. Retrieves the owner occupancy status for an association unit. Returns: UnitId, IsOccupied. Required: owner_id, id. Needs Buildium permission: Associations > Association owners and tenants (View); Associations > Ownership Accounts (View).

list_all_buildium_ownershipaccount_notes

List all notes for a buildium association ownership account. Returns: Id. Required: ownership_account_id.

create_a_buildium_ownershipaccount_note

Create a new note on a buildium association ownership account. Returns: Id. Required: ownership_account_id, Note.

update_a_buildium_ownershipaccount_note_by_id

Update a note on a buildium association ownership account. Returns: Id. Required: ownership_account_id, id, Note. Any field not included will be set to empty string or null — perform a GET first to preserve existing values.

get_single_buildium_ownershipaccount_note_by_id

Retrieve a note in Buildium. Retrieves an ownership account note. Returns: Id, Note, LastUpdatedByUser. Required: ownership_account_id, id. Needs Buildium permission: Associations > OwnershipAccounts (View).

list_all_buildium_ownershipaccount_partialpaymentsettings

Retrieve partial payment settings for a buildium association ownership account. Returns: RequirePaymentsInFull. Required: ownership_account_id.

update_a_buildium_ownershipaccount_partialpaymentsetting_by_id

Update partial payment settings for an ownership account in Buildium. Updates partial payment settings for an ownership account. Returns: RequirePaymentsInFull. Required: ownership_account_id. Needs Buildium permission: Associations > Ownership Accounts (View, Edit); Administration > Application Settings (View, Edit).

create_a_buildium_ownershipaccount_recurringcharge

Create a recurring charge in Buildium. Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. Returns: Id, OwnershipAccountId, GLAccountId, RentId, Amount, Memo, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, OccurrencesRemaining, Frequency, Duration. Required: ownership_account_id, Amount, FirstOccurrenceDate, Frequency, GLAccountId, PostDaysInAdvance. Needs Buildium permission: Associations > Ownership account transactions (View, Edit).

get_single_buildium_ownershipaccount_recurringcharge_by_id

Get a single recurring charge from a buildium ownership account by its ID. Returns: Id, OwnershipAccountId, GLAccountId, RentId, Amount, Memo, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, OccurrencesRemaining, Frequency, Duration. Required: ownership_account_id, id.

create_a_buildium_ownershipaccount_recurringcredit

Create a recurring credit in Buildium. Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. Returns: Id, OwnershipAccountId, CreditType, OffsettingGLAccountId, PostingRuleGLAccountId, Lines, Amount, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Memo, and more. Required: ownership_account_id, CreditType, FirstOccurrenceDate, Frequency, PostDaysInAdvance. Needs Buildium permission: Associations > Ownership account transactions (View, Edit).

get_single_buildium_ownershipaccount_recurringcredit_by_id

Get a single recurring credit transaction for a buildium ownership account by its id. Returns: Id, OwnershipAccountId, CreditType, OffsettingGLAccountId, PostingRuleGLAccountId, Lines, Amount, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Memo, Frequency, Duration. Required: ownership_account_id, id.

create_a_buildium_ownershipaccount_recurringpayment

Create a recurring payment in Buildium. Creates a recurring payment that will post automatically on the specified ownership account ledger. Returns: Id, OwnershipAccountId, Payer, PaymentMethod, Lines, Amount, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Frequency, Duration, OccurrencesRemaining, and more. Required: ownership_account_id, FirstOccurrenceDate, Frequency, PaymentMethod, PostDaysInAdvance. Needs Buildium permission: Associations > Ownership account transactions (View, Edit).

get_single_buildium_ownershipaccount_recurringpayment_by_id

Get a recurring payment for a buildium ownership account by id. Returns: Id, OwnershipAccountId, Payer, PaymentMethod, Lines, Amount, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Frequency, Duration, OccurrencesRemaining, Memo. Required: ownership_account_id, id.

list_all_buildium_ownershipaccounts_recurringtransactions

List all recurring transactions across all ownership accounts in buildium. Returns: Id. Optionally filter by ownershipaccountids, createddatetimefrom/createddatetimeto, or lastupdatedfrom/lastupdatedto; each date range filter has a maximum span of 365 days.

list_all_buildium_bankaccounts

Retrieve all bank accounts in Buildium. Retrieves a list of bank accounts. Returns: Id, GLAccount, CheckPrintingInfo, ElectronicPayments, Name, Description, BankAccountType, Country, AccountNumber, RoutingNumber, IsActive, Balance, and more. Needs Buildium permission: Accounting > Bank Accounts (View).

get_single_buildium_bankaccount_by_id

Retrieve a bank account in Buildium. Retrieves a specific bank account. Returns: Id, GLAccount, CheckPrintingInfo, ElectronicPayments, Name, Description, BankAccountType, Country, AccountNumber, RoutingNumber, IsActive, Balance, and more. Required: id. Needs Buildium permission: Accounting > Bank Accounts (View).

list_all_buildium_bankaccount_checks

List all buildium bank account checks for a given bank account, filtered by entry date range. Returns: Id. Required: bank_account_id, startdate, enddate.

create_a_buildium_bankaccount_check

Create a bank account check in buildium. Returns the created check including Id, Payee, CheckNumber, EntryDate, TotalAmount, Memo, and Lines. Required: bank_account_id, Payee, EntryDate, Lines.

update_a_buildium_bankaccount_check_by_id

Update a bank account check in buildium via full replacement. Any field not included will be set to empty or null — retrieve the check first to preserve existing values. Returns: Id. Required: bank_account_id, id, Payee, EntryDate, Lines.

get_single_buildium_bankaccount_check_by_id

Get a single bank account check in buildium by its id. Returns: Id, Payee, CheckNumber, EntryDate, Memo, TotalAmount, Lines. Required: bank_account_id, id.

list_all_buildium_check_files

List all files associated with a buildium bank account check. Returns: Id. Required: bank_account_id, check_id.

delete_a_buildium_check_file_by_id

Delete a file associated with a buildium bank account check by id. Returns an empty 204 response on success. Required: bank_account_id, check_id, id.

get_single_buildium_check_file_by_id

Get metadata for a specific file associated with a buildium bank account check by id. Returns: Id, Title, PhysicalFileName, Size, ContentType, UploadedDateTime. Required: bank_account_id, check_id, id.

list_all_buildium_bankaccount_deposits

List all buildium bank account deposits for a given bank account filtered by entry date range. Returns: Id. Required: bank_account_id, startdate, enddate.

create_a_buildium_bankaccount_deposit

Create a deposit in Buildium. Creates a deposit. Returns: Id, EntryDate, Memo, TotalAmount, Lines, PaymentTransactionIds. Required: bank_account_id, EntryDate. Needs Buildium permission: Accounting > Bank Accounts (View, Edit).

update_a_buildium_bankaccount_deposit_by_id

Update a deposit in Buildium. Updates a deposit. NOTE: 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. Returns: Id, EntryDate, Memo, TotalAmount, Lines, PaymentTransactionIds. Required: bank_account_id, id, EntryDate. Needs Buildium permission: Accounting > Bank Accounts (View, Edit).

get_single_buildium_bankaccount_deposit_by_id

Get a single buildium bank account deposit by id. Returns: Id, EntryDate, Memo, TotalAmount, Lines, PaymentTransactionIds. Required: bank_account_id, id.

list_all_buildium_bankaccount_quickdeposits

List all quick deposits for a buildium bank account filtered by a date range. Returns: Id. Required: bank_account_id, startdate, enddate.

create_a_buildium_bankaccount_quickdeposit

Create a quick deposit for a buildium bank account. Returns the created record including Id, EntryDate, TotalAmount, Memo, AccountingEntity, and OffsetGLAccountId. Required: bank_account_id, EntryDate, OffsetGLAccountId, Amount, AccountingEntity.

update_a_buildium_bankaccount_quickdeposit_by_id

Update a quick deposit for a buildium bank account by id. Any field not included will be set to empty or null — fetch the record first to preserve existing values. Returns the updated record including Id, EntryDate, TotalAmount, Memo, AccountingEntity, and OffsetGLAccountId. Required: bank_account_id, id, EntryDate, OffsetGLAccountId, Amount, AccountingEntity.

get_single_buildium_bankaccount_quickdeposit_by_id

Get a single buildium bank account quick deposit by id. Returns: Id, EntryDate, Memo, TotalAmount, AccountingEntity, OffsetGLAccountId. Required: bank_account_id, id.

list_all_buildium_bankaccount_reconciliations

List all bank account reconciliations in buildium for a given bank account. Returns: Id. Required: bank_account_id. Only works for bank accounts not linked externally.

create_a_buildium_bankaccount_reconciliation

Create a reconciliation in Buildium. Creates a reconciliation. Reconciliations can only be created for bank accounts that are not linked externally. Returns: Id, IsFinished, StatementEndingDate. Required: bank_account_id, EndingBalance, StatementEndingDate. Needs Buildium permission: Accounting > BankAccount (View, Edit).

update_a_buildium_bankaccount_reconciliation_by_id

Update a reconciliation in Buildium. Updates a reconciliation. Reconciliations can only be updated for bank accounts that are not linked externally. Returns: Id, IsFinished, StatementEndingDate. Required: bank_account_id, id, StatementEndingDate. Needs Buildium permission: Accounting > BankAccount (View, Edit).

get_single_buildium_bankaccount_reconciliation_by_id

Get a single bank account reconciliation in buildium by id. Returns: Id, IsFinished, StatementEndingDate. Required: bank_account_id, id. Only works for bank accounts not linked externally.

list_all_buildium_reconciliation_balances

Retrieve a buildium bank account reconciliation's balance. Only works for bank accounts that are not linked externally. Returns the reconciliation balance record including id and attributes. Required: bank_account_id, reconciliation_id.

update_a_buildium_reconciliation_balance_by_id

Update a reconciliation's balance in Buildium. Updates a bank account reconciliation's balance. Reconciliation balances can only be updated for bank accounts that are not linked externally. Returns: Difference, StatementBalance, ClearedBalance. Required: bank_account_id, reconciliation_id, EndingBalance, TotalChecksAndWithdrawals, TotalDepositsAndAdditions. Needs Buildium permission: Accounting > BankAccount (View, Edit).

create_a_buildium_reconciliation_cleartransactionsrequest

Clear transactions for a reconciliation in Buildium. Clears transactions for a reconciliation. Reconciliation transactions can only be cleared for bank accounts that are not linked externally. Required: bank_account_id, reconciliation_id, TransactionIds. Needs Buildium permission: Accounting > BankAccount (View, Edit).

create_a_buildium_reconciliation_finalizerequest

Finalize a manual reconciliation in buildium for a bank account that is not linked externally. Returns an empty 204 response on success. Required: bank_account_id, reconciliation_id.

list_all_buildium_reconciliation_transactions

List all transactions for a buildium bank account reconciliation, retrieving both cleared and uncleared transactions up to the Statement Ending Date. Works for both pending and completed reconciliations; only available for bank accounts not linked externally. Returns: Id. Required: bank_account_id, reconciliation_id.

create_a_buildium_reconciliation_uncleartransactionsrequest

Un-clear transactions for a reconciliation in Buildium. Un-clears transactions for a reconciliation. Reconciliation transactions can only be un-cleared for bank accounts that are not linked externally. Required: bank_account_id, reconciliation_id, TransactionIds. Needs Buildium permission: Accounting > BankAccount (View, Edit).

list_all_buildium_bankaccount_transactions

List all buildium bank account transactions for a given bank account and date range. Returns: Id. Required: bank_account_id, startdate, enddate. Only EntryDate is supported as an orderby value.

get_single_buildium_bankaccount_transaction_by_id

Get a single buildium bank account transaction by its proxy record id. Returns: Id, EntryDate, TransactionType, CheckNumber, Memo, Amount, ReconciliationStatus, PaidBy, PaidTo, Balance. Required: bank_account_id, id.

list_all_buildium_bankaccount_transfers

Retrieve all transfers in Buildium. Retrieves all bank account transfers. Returns: Id, EntryDate, Memo, AccountingEntity, TotalAmount, TransferToBankAccountId. Required: bank_account_id, startdate, enddate. Needs Buildium permission: Accounting > BankAccount (View).

get_single_buildium_bankaccount_transfer_by_id

Retrieve a transfer in Buildium. Retrieves a bank account transfer. Returns: Id, GLAccount, CheckPrintingInfo, ElectronicPayments, Name, Description, BankAccountType, Country, AccountNumber, RoutingNumber, IsActive, Balance, and more. Required: bank_account_id, id. Needs Buildium permission: Accounting > Bank Accounts (View).

list_all_buildium_bankaccount_undepositedfunds

List all undeposited funds for a buildium bank account. Returns undeposited fund records including id. Required: bank_account_id.

list_all_buildium_bankaccount_withdrawals

List all bank account withdrawals in Buildium for a given bank account, filtered by date range. Returns: Id. Required: bank_account_id, startdate, enddate.

create_a_buildium_bankaccount_withdrawal

Create a withdrawal in Buildium. Creates a bank account withdrawal. Returns: Id, EntryDate, Memo, TotalAmount, AccountingEntity, OffsetGLAccountId. Required: bank_account_id, AccountingEntity, Amount, EntryDate, OffsetGLAccountId. Needs Buildium permission: Accounting > Bank Accounts (View, Edit).

update_a_buildium_bankaccount_withdrawal_by_id

Update a withdrawal in Buildium. Updates a bank account withdrawal. NOTE: 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. Returns: Id, EntryDate, Memo, TotalAmount, AccountingEntity, OffsetGLAccountId. Required: bank_account_id, id, AccountingEntity, Amount, EntryDate, OffsetGLAccountId. Needs Buildium permission: Accounting > Bank Accounts (View, Edit).

get_single_buildium_bankaccount_withdrawal_by_id

Get a single bank account withdrawal in Buildium by its proxy id. Returns: Id, EntryDate, Memo, TotalAmount, AccountingEntity, OffsetGLAccountId. Required: bank_account_id, id.

list_all_buildium_bills

Retrieve all bills in Buildium. Retrieves a list of bills. Returns: Id, Date, DueDate, PaidDate, Memo, VendorId, WorkOrderId, ReferenceNumber, ApprovalStatus, Lines. Needs Buildium permission: Accounting > Bills (View).

get_single_buildium_bill_by_id

Retrieve a bill in Buildium. Retrieves a single bill. Returns: Id, Date, DueDate, PaidDate, Memo, VendorId, WorkOrderId, ReferenceNumber, ApprovalStatus, Lines. Required: id. Needs Buildium permission: Accounting > Bills (View).

list_all_buildium_bill_files

List metadata for all files attached to a Buildium bill. Returns: Id. Supports sorting via orderby. Required: bill_id.

delete_a_buildium_bill_file_by_id

Delete a file permanently from a Buildium bill. The file cannot be recovered after deletion. Returns an empty 204 response on success. Required: bill_id, id.

get_single_buildium_bill_file_by_id

Get metadata for a specific Buildium bill file by id. Returns: Id, Title, PhysicalFileName, Size, ContentType, UploadedDateTime. Required: bill_id, id.

list_all_buildium_bill_payments

List all bill payments for a specific bill in Buildium. Returns: Id. Required: bill_id.

create_a_buildium_bill_payment

Create a bill payment for a specific bill in Buildium. Returns: Id. Required: bill_id, BankAccountId, EntryDate, Lines.

get_single_buildium_bill_payment_by_id

Get a single bill payment by id for a specific bill in Buildium. Returns: Id, BankAccountId, EntryDate, Memo, CheckNumber, PaidBillIds, AppliedVendorCredits, Lines. Required: bill_id, id.

create_a_buildium_bills_payment

Create a payment for multiple bills with one check in Buildium. Creates a payment for multiple bills with one check. Returns: Id, BankAccountId, EntryDate, Memo, CheckNumber, PaidBillIds, AppliedVendorCredits, Lines. Required: BankAccountId, BillIds, EntryDate. Needs Buildium permission: Accounting > Bills (View, Edit); Accounting > Bank Accounts (View, Edit).

list_all_buildium_budgets

List all budgets in Buildium with optional filters. Returns a collection of budget records including Id, Name, and FiscalYear. Supports filtering by propertyids, fiscalyear, and name.

create_a_buildium_budget

Create a budget in Buildium. Creates a budget. Returns: Id, Name, StartDate, EndDate, Property, Details. Required: Details, FiscalYear, Name, PropertyId, StartMonth. Needs Buildium permission: Accounting > Budgets (View, Edit).

get_single_buildium_budget_by_id

Retrieve a single Buildium budget by id. Returns the budget record including Id, Name, and FiscalYear. Required: id.

update_a_buildium_budget_by_id

Update a budget in Buildium. Updates a budget. Returns: Id, Name, StartDate, EndDate, Property, Details. Required: id, Details, Name. Needs Buildium permission: Accounting > Budgets (View, Edit).

list_all_buildium_clientleads

Retrieve all client leads in Buildium. Retrieves all client leads Note: When using the `orderby` query string parameter, the only supported options are DateReceived. Returns: Id, DateReceived, Name, Email, PhoneNumber, PricePaid, Address, PropertyType, Comments, LeadStatus, CreditRequest. Needs Buildium permission: Administration > All Property Management (View).

get_single_buildium_clientlead_by_id

Retrieve a client lead in Buildium. Retrieves a specific client lead. Returns: Id, DateReceived, Name, Email, PhoneNumber, PricePaid, Address, PropertyType, Comments, LeadStatus, CreditRequest. Required: id. Needs Buildium permission: Administration > All Property Management (View).

list_all_buildium_communications_announcements

List all buildium announcements with optional filtering by date range, associated entity, and sender. Returns: Id.

create_a_buildium_communications_announcement

Create an announcement in Buildium. Creates and publishes an announcement. Returns: Id, Subject, Body, AnnouncementDate, ExpirationDate, Channels, Sender. Required: Body, IncludeAlternateEmail, NotifyAssociationTenants, PropertyIds, Subject. Needs Buildium permission: Communications > Announcements (View, Edit).

get_single_buildium_communications_announcement_by_id

Get a single buildium announcement by id. Returns the full announcement object including Id, Subject, Body, AnnouncementDate, ExpirationDate, Channels, and Sender. Required: id.

create_a_buildium_announcement_expirationrequest

Expire a buildium announcement immediately, removing it from the Resident Center. Returns an empty 204 response on success. Required: announcement_id.

list_all_buildium_announcement_properties

List association and rental properties in buildium whose residents received a specific announcement. Returns an array of property records including id. An empty collection indicates the announcement was sent to all properties at the time of its creation. Required: announcement_id.

list_all_buildium_communications_emails

List emails in buildium filtered by sent date range. Returns: Id. Required: sentdatetimefrom, sentdatetimeto. Maximum date range is 90 days; system-generated emails are excluded.

create_a_buildium_communications_email

Send an email in Buildium. Sends an email to one or more recipients using the specified email template. NOTE: Emails can only be sent to current tenants. Required: ExcludeDelinquentRecipients, IncludeAlternateEmails, IncludeAssociationTenants, Subject, TemplateId. Needs Buildium permission: Communication > Emails (View, Edit).

get_single_buildium_communications_email_by_id

Retrieve a single buildium email by id. Returns the email object including Id, SentDateTime, Subject, and Sender (with name and link). Required: id. System-generated emails are not included; use the email recipients endpoint to retrieve recipient details separately.

list_all_buildium_email_recipients

List all recipients for a specific buildium email. Returns: Id, Name, Email, RecipientType, Href. Required: email_id.

list_all_buildium_communications_phonelogs

List all phone logs in buildium, with optional filters by date range, staff user, subject, participant, and unit agreement. Returns a collection of phone log records each including Id, Subject, Description, CallDateTime, Participant, and LoggedByStaffUser.

create_a_buildium_communications_phonelog

Create a phone log in Buildium. Creates a phone log. Returns: Id, Participant, LoggedByStaffUser, Subject, Description, CallDateTime. Required: CallDateTime, Description, Participant, Subject. Needs Buildium permission: Communications > Timelines (Phone Logs) (View, Edit).

get_single_buildium_communications_phonelog_by_id

Get a specific buildium phone log by id. Returns the full PhoneLogMessage record including Id, Subject, Description, CallDateTime, Participant (with EntityId, EntityResources, and UnitAgreement), and LoggedByStaffUser. Required: id.

update_a_buildium_communications_phonelog_by_id

Update a phone log in Buildium. Update a phone log NOTE: 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. Returns: Id, Participant, LoggedByStaffUser, Subject, Description, CallDateTime. Required: id, CallDateTime, Description, Subject. Needs Buildium permission: Communications > Timelines (Phone Logs) (View, Edit).

list_all_buildium_communications_templates

List all communication templates in Buildium, including mailing and email templates used for mail-merge messages to residents, rental owners, and vendors. Returns: Id, Name, Description, RecipientType. Supports optional sorting via orderby.

get_single_buildium_communications_template_by_id

Get a single Buildium communication template by id. Returns: Id, Name, Description, RecipientType. Required: id.

update_a_buildium_creditcardaccount_by_id

Update a credit card account in Buildium. Updates a credit card account. NOTE: 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. Returns: Id, Name, Description, PaymentDueDay, CreditLimit, IsActive, Balance. Required: id, Name. Needs Buildium permission: Accounting > Banking (View, Edit).

list_all_buildium_file_sharings

Retrieve the share settings for a Buildium file. Returns file sharing settings with entity-type-specific fields — only fields matching the file's entity type (e.g., Rental, Association) are populated; the shape is dynamic based on entity type. Required: file_id.

update_a_buildium_file_sharing_by_id

Update the share settings for a Buildium file. Only settings applicable to the file's entity type can be modified (e.g., a rental file updates only rental share settings). Returns the updated file sharing settings with entity-type-specific fields populated. Required: file_id.

list_all_buildium_files_categories

List all Buildium file categories. Returns: Id, Name, IsEditable. Use the orderby parameter to control sort order.

create_a_buildium_files_category

Create a category in Buildium. Creates a file category. Returns: Id, Name, IsEditable. Required: Name. Needs Buildium permission: Documents > Files (View, Edit).

get_single_buildium_files_category_by_id

Get a specific Buildium file category by id. Returns: Id, Name, IsEditable. Required: id.

update_a_buildium_files_category_by_id

Update a Buildium file category by id. Returns: Id, Name, IsEditable. Required: id, Name. Categories where IsEditable is false cannot be updated; any field omitted from the request body is set to null or empty string in the database.

list_all_buildium_generalledgers

List all general ledger entries in buildium filtered by date range, GL accounts, and accounting basis. Returns: GLAccountId, GLAccountName, BeginningBalance, TotalAmount, and Entries (array of individual transaction entries each with Id, Date, Amount, Balance, TransactionType, and AccountingEntity). Required: accountingbasis, glaccountids, startdate, enddate.

list_all_buildium_generalledger_transactions

Retrieve all general ledger transactions in Buildium. Retrieves a list of general ledger transactions. Returns: Id, Date, TransactionType, TotalAmount, CheckNumber, UnitAgreement, UnitId, UnitNumber, PaymentDetail, DepositDetails, Application, Journal, and more. Required: startdate, enddate, glaccountids. Needs Buildium permission: Accounting > General Ledger Transactions (View).

get_single_buildium_generalledger_transaction_by_id

Retrieve a general ledger transaction in Buildium. Retrieves a specific general ledger transaction. Returns: Id, Date, TransactionType, TotalAmount, CheckNumber, UnitAgreement, UnitId, UnitNumber, PaymentDetail, DepositDetails, Application, Journal, and more. Required: id. Needs Buildium permission: Accounting > General Ledger Transactions (View).

list_all_buildium_glaccounts

Retrieve all general ledger accounts in Buildium. Retrieves a list of general ledger accounts. General ledger accounts are used to categorize transactions for accounting purposes. Returns: Id, AccountNumber, Name, Description, Type, SubType, IsDefaultGLAccount, DefaultAccountName, IsContraAccount, IsBankAccount, CashFlowClassification, ExcludeFromCashBalances, and more. Needs Buildium permission: Accounting > General Ledger Accounts (View).

get_single_buildium_glaccount_by_id

Retrieve a general ledger account in Buildium. Retrieves a specific general ledger account. Returns: Id, AccountNumber, Name, Description, Type, SubType, IsDefaultGLAccount, DefaultAccountName, IsContraAccount, IsBankAccount, CashFlowClassification, ExcludeFromCashBalances, and more. Required: id. Needs Buildium permission: Accounting > General Ledger Accounts (View).

list_all_buildium_glaccounts_balances

Retrieve all general ledger account balances in Buildium. 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. Returns: TotalBalance, GLAccount, AccountingEntityBalances. Required: accountingbasis, asofdate. Needs Buildium permission: Accounting > General Ledger Accounts (View).

list_all_buildium_lease_epaysettings

Retrieve ePay settings for a buildium lease. Returns the ePay settings object including id and attributes. Required: lease_id.

update_a_buildium_lease_epaysetting_by_id

Update ePay settings in Buildium. Updates ePay settings for a lease. Returns: EFTPayments, CreditCardPayments, OfflinePayments. Required: lease_id, CreditCardPayments, EFTPayments, OfflinePayments. Needs Buildium permission: Rentals > Leases (View, Edit).

list_all_buildium_lease_partialpaymentsettings

Retrieve partial payment settings for a buildium lease. Returns the partial payment settings object for the specified lease, including its attributes. Required: lease_id.

update_a_buildium_lease_partialpaymentsetting_by_id

Update partial payment settings for a buildium lease using a JSON Patch document (RFC 6902). Returns the updated partial payment settings object including its attributes. Required: lease_id.

create_a_buildium_lease_recurringcharge

Create a recurring charge in Buildium. Creates a recurring charge transaction that will post automatically on the specified lease ledger. Returns: Id, LeaseId, GLAccountId, RentId, Amount, Memo, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Frequency, Duration. Required: lease_id, Amount, FirstOccurrenceDate, Frequency, GLAccountId, PostDaysInAdvance. Needs Buildium permission: Rentals > Lease transactions (View, Edit).

get_single_buildium_lease_recurringcharge_by_id

Get a single recurring charge on a Buildium lease by its id. Returns: Id, LeaseId, GLAccountId, RentId, Amount, Memo, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Frequency, Duration. Required: lease_id, id.

create_a_buildium_lease_recurringcredit

Create a recurring credit in Buildium. Creates a recurring credit transaction on the specified lease ledger. Returns: Id, LeaseId, CreditType, OffsettingGLAccountId, PostingRuleGLAccountId, Lines, Amount, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Memo, and more. Required: lease_id, CreditType, FirstOccurrenceDate, Frequency, PostDaysInAdvance. Needs Buildium permission: Rentals > Lease transactions (View, Edit).

get_single_buildium_lease_recurringcredit_by_id

Get a buildium recurring credit transaction by id for a given lease. Returns: Id, LeaseId, CreditType, OffsettingGLAccountId, PostingRuleGLAccountId, Lines, Amount, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Memo, Frequency, Duration. Required: lease_id, id.

create_a_buildium_lease_recurringpayment

Create a recurring payment in Buildium. Creates a recurring payment that will post automatically on the specified lease ledger. Returns: Id, LeaseId, Payer, PaymentMethod, Lines, Amount, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Frequency, Duration, and more. Required: lease_id, FirstOccurrenceDate, Frequency, PaymentMethod, PostDaysInAdvance. Needs Buildium permission: Rentals > Lease Transactions (View, Edit).

get_single_buildium_lease_recurringpayment_by_id

Get a single recurring payment from a buildium lease ledger by id. Returns: Id, LeaseId, Payer, PaymentMethod, Lines, Amount, OccurrencesRemaining, FirstOccurrenceDate, NextOccurrenceDate, PostDaysInAdvance, Frequency, Duration, Memo. Required: lease_id, id.

list_all_buildium_lease_rents

List all rent schedules for a Buildium lease. A lease may have more than one schedule if its rent terms change within the duration of the lease. Returns: Id. Required: lease_id.

create_a_buildium_lease_rent

Create a rent schedule in Buildium. Creates a rent schedule. Returns: Id, StartDate, EndDate, TotalAmount, RentCycle, BackdateCharges, CreatedDateTime, CreatedByUserId, Charges. Required: lease_id, BackdateCharges, Charges, RentCycle. Needs Buildium permission: Rentals > Lease Transactions (View, Edit).

update_a_buildium_lease_rent_by_id

Update a rent schedule in Buildium. Updates a rent schedule. Returns: Id, StartDate, EndDate, TotalAmount, RentCycle, BackdateCharges, CreatedDateTime, CreatedByUserId, Charges. Required: lease_id, id, BackdateCharges, Charges, RentCycle. Needs Buildium permission: Rentals > Lease Transactions (View, Edit).

get_single_buildium_lease_rent_by_id

Get a specific rent schedule for a Buildium lease by id. Returns the full rent schedule including Id, StartDate, EndDate, TotalAmount, RentCycle, BackdateCharges, CreatedDateTime, CreatedByUserId, and Charges. Required: lease_id, id.

list_all_buildium_lease_rentersinsurances

List all renters insurance policies for a buildium lease. Returns each policy record including Id and policy-specific attributes from the RentersInsurancePolicyMessage. Required: lease_id.

get_single_buildium_lease_rentersinsurance_by_id

Get a single renters insurance policy by id for a buildium lease. Returns: Id, InsuranceCompany, CarrierType, PolicyIdentifier, EffectiveDate, ExpirationDate, CancellationDate, InsuredTenants. Required: lease_id, id.

list_all_buildium_leases_recurringtransactions

List all recurring transactions across all leases in buildium. Returns: Id. Filter by lease IDs or creation/update date ranges; the maximum date range per filter pair is 365 days.

list_all_buildium_leases_renewalhistories

List all lease renewal history records in buildium. Returns each record's Id, LeaseId, LeaseStatus, LeaseFromDate, LeaseToDate, LeaseType, Rent, RentId, TenantIds, CreatedDateTime, and LastUpdatedDateTime. Optionally filter by lease IDs or creation/update date ranges; the maximum date range per filter pair is 365 days.

list_all_buildium_leases_rents

List all rent schedules in buildium. Each schedule details the recurring charges applied to a lease ledger each rent cycle; a lease may have multiple schedules if rent terms change. Returns: Id. Date range filters accept UTC datetime strings with a maximum range of 365 days.

list_all_buildium_leases_tenants

Retrieve all tenants in Buildium. Retrieves a list of tenants. Returns: Id, UserLeaseId, FirstName, LastName, Email, AlternateEmail, PhoneNumbers, CreatedDateTime, EmergencyContact, DateOfBirth, SMSOptInStatus, Address, and more. Needs Buildium permission: Rentals > Tenants (View).

get_single_buildium_leases_tenant_by_id

Retrieve a tenant in Buildium. Retrieve a specific tenant. Returns: Id, UserLeaseId, FirstName, LastName, Email, AlternateEmail, PhoneNumbers, CreatedDateTime, EmergencyContact, DateOfBirth, SMSOptInStatus, Address, and more. Required: id. Needs Buildium permission: Rentals > Tenants (View).

list_all_buildium_propertygroups

List all buildium property groups. Returns: Id, Name, Description. Optionally filter results by property IDs or by name/description text.

create_a_buildium_propertygroup

Create a property group in Buildium. Creates a property group. Returns: Id, Name, Description, Properties, CreatedByUser. Required: Name, PropertyIds. Needs Buildium permission: Rentals > Rental properties and units or (View, Edit); Associations > Associations and units (View, Edit).

get_single_buildium_propertygroup_by_id

Get a single buildium property group by id. Returns: Id, Name, Description. Required: id.

update_a_buildium_propertygroup_by_id

Update a buildium property group by id. Returns the updated property group including Id, Name, Description, Properties, and CreatedByUser. Required: id, Name, PropertyIds. A property group can only be updated by the user that created it.

list_all_buildium_rental_amenities

Retrieve all amenities for a buildium rental property. Returns the rental features attributes object containing the amenity details for the specified property. Required: property_id.

update_a_buildium_rental_amenity_by_id

Update amenities for a buildium rental property using a full PUT replacement — any field omitted from the request body will be set to null or empty string. Returns the updated rental features attributes object. Required: property_id.

list_all_buildium_rental_epaysettings

Retrieve ePay settings for a buildium rental property. Returns the ePay settings configuration object including Id and attributes (ePay configuration fields as defined by the EPaySettingsMessage schema). Required: property_id.

update_a_buildium_rental_epaysetting_by_id

Update ePay settings in Buildium. Updates ePay settings for a rental property. Returns: EFTPayments, CreditCardPayments, OfflinePayments. Required: property_id, CreditCardPayments, EFTPayments, OfflinePayments. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

list_all_buildium_rental_images

List all images for a buildium rental property. Returns file metadata including Id, FileName, and Description for each image; note that only metadata is returned — use the Download File endpoint to retrieve the actual file contents. Required: property_id.

update_a_buildium_rental_image_by_id

Update a property image in Buildium. Updates a rental property image. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: property_id, id, ShowInListing. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

delete_a_buildium_rental_image_by_id

Delete a rental property image in buildium by id. Returns an empty 204 response on success. Required: property_id, id.

get_single_buildium_rental_image_by_id

Get a single buildium rental property image by id. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: property_id, id.

list_all_buildium_rental_meterreadings

List all meter readings for a buildium rental property within a specified date range. Returns an array of meter reading records including id, meterType, and readingDate. Required: property_id, readingdatefrom, readingdateto. Maximum date range is 365 days.

list_all_buildium_rental_notes

List all notes for a buildium rental property. Returns: Id. Required: property_id. Supports optional filters for updated date range (updateddatetimefrom, updateddatetimeto), last updated user (lastupdatedbyuserid), and sort order (orderby).

create_a_buildium_rental_note

Create a note on a buildium rental property. Returns: Id. Required: property_id, Note.

update_a_buildium_rental_note_by_id

Update a note on a buildium rental property by id. Returns: Id. Required: property_id, id, Note. Any field not included in the request will be set to empty string or null — fetch the note first to avoid overwriting existing data.

get_single_buildium_rental_note_by_id

Get a single note for a buildium rental property by id. Returns: Id, Note, LastUpdatedByUser. Required: property_id, id.

list_all_buildium_rentals_owners

List rental owners in Buildium with optional filtering by property IDs, status, owner name, phone, agreement days remaining, or last-updated date range. Returns each owner record including Id, FirstName, LastName, Email, PhoneNumbers, Address, PropertyIds, IsCompany, IsActive, ManagementAgreementStartDate, ManagementAgreementEndDate, CompanyName, and TaxInformation.

create_a_buildium_rentals_owner

Create an owner in Buildium. Creates a rental owner. Returns: Id, IsCompany, IsActive, FirstName, LastName, PhoneNumbers, Email, AlternateEmail, Comment, Address, ManagementAgreementStartDate, ManagementAgreementEndDate, and more. Required: Address, IsCompany, PropertyIds. Needs Buildium permission: Rentals > Property Rental Owners (View, Edit).

get_single_buildium_rentals_owner_by_id

Get a specific rental owner by id in Buildium. Returns the full rental owner record including Id, FirstName, LastName, Email, PhoneNumbers, Address, PropertyIds, IsCompany, IsActive, ManagementAgreementStartDate, ManagementAgreementEndDate, CompanyName, and TaxInformation. Required: id.

update_a_buildium_rentals_owner_by_id

Update an owner in Buildium. Updates a rental owner. NOTE: 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. Returns: Id, IsCompany, IsActive, FirstName, LastName, PhoneNumbers, Email, AlternateEmail, Comment, Address, ManagementAgreementStartDate, ManagementAgreementEndDate, and more. Required: id, Address, IsCompany, PropertyIds. Needs Buildium permission: Rentals > Property Rental Owners (View, Edit).

list_all_buildium_rentals_units

List all rental property units in buildium, with optional filtering by property, date range, and sort order. Returns a collection of rental unit records including Id and attributes.

create_a_buildium_rentals_unit

Create a unit in Buildium. Creates a rental unit. Returns: Id, PropertyId, BuildingName, UnitNumber, Description, MarketRent, Address, UnitBedrooms, UnitBathrooms, UnitSize, IsUnitListed, IsUnitOccupied. Required: Address, PropertyId, UnitNumber. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

get_single_buildium_rentals_unit_by_id

Retrieve a specific rental property unit in buildium by id. Returns the unit record including Id and attributes. Required: id.

update_a_buildium_rentals_unit_by_id

Update a unit in Buildium. Updates a rental unit. NOTE: 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. Returns: Id, PropertyId, BuildingName, UnitNumber, Description, MarketRent, Address, UnitBedrooms, UnitBathrooms, UnitSize, IsUnitListed, IsUnitOccupied. Required: id, Address, UnitNumber. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

list_all_buildium_unit_amenities

Retrieve all amenities for a buildium rental unit. Returns the rental unit features object including id and attributes. Required: unit_id.

update_a_buildium_unit_amenity_by_id

Update amenities for a buildium rental unit. Returns the updated features object including id and attributes. Required: unit_id. Any field not included in the request will be set to empty string or null in buildium — retrieve current amenities with the list method first to avoid unintentional data loss.

list_all_buildium_unit_images

List all images for a buildium rental unit. Returns file metadata only (not file content); use the Download File endpoint to retrieve actual files. Returns: Id, Description. Required: unit_id.

update_a_buildium_unit_image_by_id

Update a unit image in Buildium. Updates a unit image. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: unit_id, id, ShowInListing. Needs Buildium permission: Rentals > Properties and units (View, Edit).

delete_a_buildium_unit_image_by_id

Delete a unit image from buildium by id. Returns an empty 204 response on success. Required: unit_id, id.

get_single_buildium_unit_image_by_id

Get a single unit image by id from buildium. Returns file metadata only (not file content). Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: unit_id, id.

list_all_buildium_resident_center_users

List all buildium resident center users for both rentals and associations. Returns each record with UnitAgreement (Id, Type, Href), User (Id, FirstName, LastName, UserType, Href), ResidentCenterUserStatus, and IsAutoPayEnabled. All filter parameters are optional; use unitagreementids, userids, usertypes, residentcenteruserstatuses, or isautopayenabled to narrow results.

list_all_buildium_retailcashusers

List all retail cash users in buildium. Returns a collection of records each including UnitAgreement, User, Property, Unit, IsAccountCreated, IsEvictionPending, and IsEnabled. Optionally filter by entityid, entitytype, statuses, name, unitaddress, or isaccountcreated.

update_a_buildium_retailcashuser_by_id

Update a retail cash user in buildium to enable or disable their retail cash account. Returns the updated record including UnitAgreement, User, Property, Unit, IsAccountCreated, IsEvictionPending, and IsEnabled. Required: user_id, id, IsEnabled.

get_single_buildium_retailcashuser_by_id

Get a single retail cash user in buildium by user id and unit agreement id. Returns UnitAgreement, User, Property, Unit, IsAccountCreated, IsEvictionPending, and IsEnabled. Required: user_id, id.

list_all_buildium_tasks

Retrieve all tasks in Buildium. 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. Returns: Id, TaskType, Category, Title, Description, Property, UnitId, UnitAgreement, RequestedByUserEntity, AssignedToUserId, TaskStatus, Priority, and more. Needs Buildium permission: Tasks > Tasks (View).

get_single_buildium_task_by_id

Retrieve a task in Buildium. 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. Returns: Id, TaskType, Category, Title, Description, Property, UnitId, UnitAgreement, RequestedByUserEntity, AssignedToUserId, TaskStatus, Priority, and more. Required: id. Needs Buildium permission: Tasks > Tasks (View).

get_single_buildium_task_history_by_id

Get a specific task history record in Buildium. Returns: Id. Required: task_id, id.

update_a_buildium_task_history_by_id

Update a task history in Buildium. 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. Returns: Id, Priority, TaskStatus, AssignedToUserId, DueDate, Message, SharedWith, FileIds, CreatedDateTIme, CreatedByUser, LastUpdatedDateTime, LastUpdatedByUser. Required: task_id, id, Message. Needs Buildium permission: Tasks > Tasks (View, Edit).

list_all_buildium_task_histories

List all task history records for a task in Buildium. Returns records each including Id, Priority, TaskStatus, AssignedToUserId, DueDate, Message, SharedWith, FileIds, CreatedByUser, and LastUpdatedByUser. Required: task_id.

list_all_buildium_tasks_categories

List all task categories in buildium. Returns: Id, Name. Optionally sort results using the orderby parameter.

create_a_buildium_tasks_category

Create a task category in Buildium. Returns: Id, Name, IsSystemCategory, SubCategories. Required: Name. Needs Buildium permission: Tasks > Tasks (View, Edit).

get_single_buildium_tasks_category_by_id

Get a single buildium task category by id. Returns: Id, Name. Required: id.

update_a_buildium_tasks_category_by_id

Update a buildium task category by id. Returns: Id, Name. Required: id, Name. Any field not included in the request will be set to empty or null in the database — perform a GET first to preserve existing values.

list_all_buildium_tasks_contactrequests

List contact request tasks in Buildium with optional filters. Returns a collection of tasks each including Id, Title, Status, Priority, DueDate, EntityType, EntityId, UnitId, TaskCategoryId, and AssignedTo. Filter by statuses, priorities, entitytype, assignedtoid, tasktitle, date ranges, and more. No required parameters.

create_a_buildium_tasks_contactrequest

Create a contact request in Buildium. Creates a contact request. Returns: Id, Category, Title, Description, Property, UnitId, ContactDetail, AssignedToUserId, TaskStatus, Priority, DueDate, CreatedDateTime, and more. Required: AssignedToUserId, ContactDetail, Priority, TaskStatus, Title. Needs Buildium permission: Tasks > Tasks (View, Edit).

get_single_buildium_tasks_contactrequest_by_id

Retrieve a single contact request task from Buildium by id. Returns: Id, Description. Required: id.

update_a_buildium_tasks_contactrequest_by_id

Update a contact request task in Buildium by id. Any field not included in the request will be set to empty or null — perform a GET first to avoid unintentional data loss. Returns: Id, Description. Required: id, Title, AssignedToUserId, TaskStatus, Priority, ContactDetail.

list_all_buildium_tasks_rentalownerrequests

List all rental owner request tasks in Buildium, optionally filtered by entity type/id, statuses, priorities, due date range, last updated range, unit, task category, assigned staff, or title. Returns: Id, Description.

create_a_buildium_tasks_rentalownerrequest

Create a rental owner request in Buildium. Creates a rental owner request. Returns: Id, Category, Title, Description, Property, UnitId, RequestedByUserEntity, AssignedToUserId, TaskStatus, Priority, DueDate, CreatedDateTime, and more. Required: Priority, RequestedByRentalOwnerId, TaskStatus, Title. Needs Buildium permission: Tasks > Tasks (View, Edit).

get_single_buildium_tasks_rentalownerrequest_by_id

Get a specific rental owner request from Buildium by id. Returns the full task record including Id, Title, Description, TaskStatus, Priority, DueDate, Category, Property, RequestedByUserEntity, AssignedToUserId, CreatedDateTime, and LastUpdatedDateTime. Required: id.

update_a_buildium_tasks_rentalownerrequest_by_id

Update a rental owner request in Buildium. Updates a rental owner request. NOTE: 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. Returns: Id, Category, Title, Description, Property, UnitId, RequestedByUserEntity, AssignedToUserId, TaskStatus, Priority, DueDate, CreatedDateTime, and more. Required: id, Priority, TaskStatus, Title. Needs Buildium permission: Tasks > Tasks (View, Edit).

list_all_buildium_rentalownerrequest_contributiondatas

Retrieve contribution details for a buildium rental owner contribution request. Returns the rental owner contribution data object including Id. Required: rental_owner_request_task_id.

update_a_buildium_rentalownerrequest_contributiondata_by_id

Update contribution details for a buildium rental owner contribution request. Returns the updated rental owner contribution data object including Id. Required: rental_owner_request_task_id.

list_all_buildium_tasks_residentrequests

List resident requests in buildium. Returns each task's Id, Title, Status, Priority, DueDate, LastUpdatedDateTime, AssignedToUser, UnitId, UnitAgreementId, EntityType, and EntityId. Supports filtering by entitytype, entityid, statuses, priorities, unitid, unitagreementid, taskcategoryid, assignedtoid, tasktitle, and due date or last-updated date ranges.

create_a_buildium_tasks_residentrequest

Create a resident request in Buildium. Creates a resident request. Returns: Id, Category, Title, Description, Property, UnitId, UnitAgreement, RequestedByUserEntity, AssignedToUserId, TaskStatus, Priority, DueDate, and more. Required: Priority, RequestedByEntityId, TaskStatus, Title, UnitAgreementId. Needs Buildium permission: Tasks > Tasks (View, Edit).

get_single_buildium_tasks_residentrequest_by_id

Get a specific resident request task by id in buildium. Returns the task's Id, Title, Status, Priority, DueDate, LastUpdatedDateTime, AssignedToUser, UnitId, UnitAgreementId, EntityType, and EntityId. Required: id.

update_a_buildium_tasks_residentrequest_by_id

Update a resident request in Buildium. Update a resident request. NOTE: 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. Returns: Id, Category, Title, Description, Property, UnitId, UnitAgreement, RequestedByUserEntity, AssignedToUserId, TaskStatus, Priority, DueDate, and more. Required: id, Priority, TaskStatus, Title. Needs Buildium permission: Tasks > Tasks (View, Edit).

list_all_buildium_tasks_todorequests

List to-do tasks in Buildium with optional filters. Returns: Id, Description. Filter by statuses, priorities, entitytype, entityid, unitid, lastupdatedfrom, lastupdatedto, duedatefrom, duedateto, taskcategoryid, assignedtoid, or tasktitle.

create_a_buildium_tasks_todorequest

Create a to do request in Buildium. Creates a to do task. Returns: Id, Category, Title, Description, Property, UnitId, AssignedToUserId, TaskStatus, Priority, DueDate, CreatedDateTime, LastUpdatedDateTime. Required: AssignedToUserId, Priority, TaskStatus, Title. Needs Buildium permission: Tasks > Tasks (View, Edit).

get_single_buildium_tasks_todorequest_by_id

Retrieve a single to-do task from Buildium by id. Returns: Id, Description. Required: id.

update_a_buildium_tasks_todorequest_by_id

Update a to do request in Buildium. Updates a to do task NOTE: 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. Returns: Id, Category, Title, Description, Property, UnitId, AssignedToUserId, TaskStatus, Priority, DueDate, CreatedDateTime, LastUpdatedDateTime. Required: id, AssignedToUserId, Priority, TaskStatus, Title. Needs Buildium permission: Tasks > Tasks (View, Edit).

list_all_buildium_vendors

Retrieve all vendors in Buildium. Retrieves a list of vendors. Returns: Id, IsCompany, IsActive, FirstName, LastName, PrimaryEmail, AlternateEmail, CompanyName, PhoneNumbers, Website, Category, Address, and more. Needs Buildium permission: Maintenance > Vendors (View).

create_a_buildium_vendor

Create a vendor in Buildium. Creates a vendor. Returns: Id, IsCompany, IsActive, FirstName, LastName, PrimaryEmail, AlternateEmail, CompanyName, PhoneNumbers, Website, Category, Address, and more. Required: CategoryId, IsCompany. Needs Buildium permission: Maintenance > Vendors (View, Edit).

get_single_buildium_vendor_by_id

Retrieve a vendor in Buildium. Retrieve a specific vendor. Returns: Id, IsCompany, IsActive, FirstName, LastName, PrimaryEmail, AlternateEmail, CompanyName, PhoneNumbers, Website, Category, Address, and more. Required: id. Needs Buildium permission: Maintenance > Vendors (View).

update_a_buildium_vendor_by_id

Update a vendor in Buildium. Updates a vendor. NOTE: 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. Returns: Id, IsCompany, IsActive, FirstName, LastName, PrimaryEmail, AlternateEmail, CompanyName, PhoneNumbers, Website, Category, Address, and more. Required: id, CategoryId, IsCompany. Needs Buildium permission: Maintenance > Vendors (View, Edit).

create_a_buildium_vendor_credit

Create a credit in Buildium. Creates a credit. Returns: Id, EntryDate, ReferenceNumber, Memo, Lines. Required: vendor_id, EntryDate, Lines. Needs Buildium permission: Accounting > Bills (View, Edit).

get_single_buildium_vendor_credit_by_id

Retrieve a vendor credit in Buildium for a specified vendor. Returns the full vendor credit object including Id, EntryDate, ReferenceNumber, Memo, and Lines (line items with GLAccountId, Amount, and AccountingEntity). Required: vendor_id, id.

list_all_buildium_vendor_notes

List all notes for a buildium vendor. Returns: Id. Required: vendor_id.

create_a_buildium_vendor_note

Create a new note for a buildium vendor. Returns the created note including Id, Note, and LastUpdatedByUser. Required: vendor_id, Note.

update_a_buildium_vendor_note_by_id

Update an existing buildium vendor note by id. Returns the updated note including Id, Note, and LastUpdatedByUser. Required: vendor_id, id, Note. Any field not included will be set to empty string or null.

get_single_buildium_vendor_note_by_id

Retrieve a note in Buildium. Retrieves a vendor note. Returns: Id, Note, LastUpdatedByUser. Required: vendor_id, id. Needs Buildium permission: Maintenance > Vendors (View).

create_a_buildium_vendor_refund

Create a refund in Buildium. Creates a refund. Returns: Id, EntryDate, BankAccountId, CreditCardAccountId, PaymentMethod, ReferenceNumber, Memo, Lines. Required: vendor_id, EntryDate, Lines, PaymentMethod. Needs Buildium permission: Maintenance > Vendors (View, Edit); Accounting > Bank Accounts (View).

get_single_buildium_vendor_refund_by_id

Retrieve a vendor refund in Buildium by id for a specified vendor. Returns the vendor refund object including its id. Required: vendor_id, id.

list_all_buildium_vendor_transactions

List all transactions for a given vendor in Buildium. Returns vendor transaction records including id, date, type, referenceNumber, and memo. Required: vendor_id, transactiondatefrom, transactiondateto. The date range between transactiondatefrom and transactiondateto cannot exceed 365 days.

list_all_buildium_vendors_categories

List all vendor categories in Buildium. Returns: Id, Name, IsSystemCategory. Supports optional orderby parameter to control sort direction.

create_a_buildium_vendors_category

Create a vendor category in Buildium. Creates a vendor category. Returns: Id, Name, IsSystemCategory. Required: Name. Needs Buildium permission: Maintenance > Vendors (View, Edit).

get_single_buildium_vendors_category_by_id

Get a single vendor category in Buildium by id. Returns: Id, Name, IsSystemCategory. Required: id.

update_a_buildium_vendors_category_by_id

Update a vendor category in Buildium by id. Returns: Id, Name, IsSystemCategory. Required: id, Name. Any field omitted from the request body will be set to empty or null in the database.

list_all_buildium_workorders

List work orders in Buildium with optional filtering by entity, status, type, priority, unit, vendor, amount, and billing status. Returns each work order including Id, Title, Status, DueDate, VendorId, EntryAllowed, Task, and LineItems.

create_a_buildium_workorder

Create a new work order in Buildium. Returns the created work order including Id, Title, Status, DueDate, VendorId, EntryAllowed, Task, and LineItems. Required: EntryAllowed, VendorId.

get_single_buildium_workorder_by_id

Retrieve a specific Buildium work order by id. Returns the work order including Id, Title, Status, DueDate, VendorId, EntryAllowed, WorkDetails, Task, and LineItems. Required: id.

update_a_buildium_workorder_by_id

Update a work order in Buildium by id. Returns the updated work order including Id, Title, Status, DueDate, VendorId, EntryAllowed, Task, and LineItems. Any field omitted from the request body is cleared to empty or null; fetch the current record first to avoid data loss. Required: id, EntryAllowed, VendorId.

list_all_buildium_task_history_files

List task history file metadata records associated with a specific task history entry in Buildium. Returns: Id, Title, PhysicalFileName, Size, ContentType, UploadedDateTime. Required: task_id, task_history_id.

get_single_buildium_task_history_file_by_id

Get a single task history file metadata record by id in Buildium. Returns: Id, Title, PhysicalFileName, Size, ContentType, UploadedDateTime. Required: task_id, task_history_id, id.

delete_a_buildium_task_history_file_by_id

Delete a task history file by id in Buildium. Returns an empty 204 response on success. Required: task_id, task_history_id, id.

list_all_buildium_association_owner_notes

List notes for a Buildium association owner. Returns Id and note-specific attributes for each note in the collection. Required: owner_id.

create_a_buildium_association_owner_note

Create a note in Buildium. Creates an association owner note. Returns: Id, Note, LastUpdatedByUser. Required: owner_id, Note. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

get_single_buildium_association_owner_note_by_id

Get a single note for a Buildium association owner by id. Returns Id and note-specific attributes for the matching record. Required: owner_id, id.

update_a_buildium_association_owner_note_by_id

Update a note in Buildium. Updates an association owner note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: owner_id, id, Note. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

list_all_buildium_rental_owner_notes

Retrieves all notes in Buildium. Retrieves all rental owner notes. Returns: Id, Note, LastUpdatedByUser. Required: rental_owner_id. Needs Buildium permission: Rentals > Property Rental Owners (View).

create_a_buildium_rental_owner_note

Create a note in Buildium. Creates a new Rental Owner note. Returns: Id, Note, LastUpdatedByUser. Required: rental_owner_id, Note. Needs Buildium permission: Rentals > Property Rental Owners (View, Edit).

get_single_buildium_rental_owner_note_by_id

Retrieve a note in Buildium. Retrieves a rental owner note. Returns: Id, Note, LastUpdatedByUser. Required: rental_owner_id, id. Needs Buildium permission: Rentals > Property Rental Owners (View).

update_a_buildium_rental_owner_note_by_id

Update a note in Buildium. Updates a Rental Owner note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: rental_owner_id, id, Note. Needs Buildium permission: Rentals > Property Rental Owners (View, Edit).

list_all_buildium_association_tenant_notes

List notes for a Buildium association tenant. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id.

create_a_buildium_association_tenant_note

Create a note in Buildium. Creates an association tenant note. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id, Note. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

get_single_buildium_association_tenant_note_by_id

Get a single note for a Buildium association tenant by id. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id, id.

update_a_buildium_association_tenant_note_by_id

Update a note in Buildium. Updates an association tenant note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id, id, Note. Needs Buildium permission: Associations > Association owners and tenants (View, Edit).

list_all_buildium_lease_tenant_notes

Retrieve all notes in Buildium. Retrieves all tenant notes. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id. Needs Buildium permission: Rentals > Tenants (View).

create_a_buildium_lease_tenant_note

Create a note in Buildium. Creates a tenant note. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id, Note. Needs Buildium permission: Rentals > Tenants (View, Edit).

get_single_buildium_lease_tenant_note_by_id

Retrieve a note in Buildium. Retrieves a tenant note. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id, id. Needs Buildium permission: Rentals > Tenants (View).

update_a_buildium_lease_tenant_note_by_id

Update a note in Buildium. Updates a tenant note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: tenant_id, id, Note. Needs Buildium permission: Rentals > Tenants (View, Edit).

list_all_buildium_association_unit_notes

List all notes attached to a Buildium association unit. Returns: Id, Note, LastUpdatedByUser. Required: unit_id.

create_a_buildium_association_unit_note

Create a note in Buildium. Creates a new association unit note. Returns: Id, Note, LastUpdatedByUser. Required: unit_id, Note. Needs Buildium permission: Associations > Associations and units (View, Edit).

get_single_buildium_association_unit_note_by_id

Get a single note for a Buildium association unit by id. Returns: Id, Note, LastUpdatedByUser. Required: unit_id, id.

update_a_buildium_association_unit_note_by_id

Update a note in Buildium. Updates an association unit note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: unit_id, id, Note. Needs Buildium permission: Associations > Associations and units (View, Edit).

list_all_buildium_rental_unit_notes

List all notes for a buildium rental unit. Returns: Id, Note, LastUpdatedByUser. Required: unit_id.

create_a_buildium_rental_unit_note

Create a note in Buildium. Creates a rental unit note. Returns: Id, Note, LastUpdatedByUser. Required: unit_id, Note. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

get_single_buildium_rental_unit_note_by_id

Get a single note for a buildium rental unit by id. Returns: Id, Note, LastUpdatedByUser. Required: unit_id, id.

update_a_buildium_rental_unit_note_by_id

Update a note in Buildium. Updates a rental unit note. NOTE: 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. Returns: Id, Note, LastUpdatedByUser. Required: unit_id, id, Note. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

list_all_buildium_association_meterreading_summaries

List buildium association meter reading summary details for a given association, date, and meter type. Returns: ReadingDate, MeterType, Details. Required: association_id, readingdate, metertype.

update_a_buildium_association_meterreading_summary_by_id

Create or update buildium association meter reading summary details for a given association. Returns: ReadingDate, MeterType, Details. Required: association_id, ReadingDate, MeterType, Details (body).

delete_a_buildium_association_meterreading_summary_by_id

Delete buildium association meter reading summaries for a given association for a specific date and meter type. Returns an empty 204 response on success. Required: association_id, readingdate, metertype.

list_all_buildium_rental_meterreading_summaries

List meter reading summaries for a Buildium rental property. Returns: ReadingDate, MeterType, Details. Required: property_id, readingdate, metertype.

update_a_buildium_rental_meterreading_summary_by_id

Create/Update meter reading details in Buildium. This endpoint can be used to both create and update a meter reading detail for a property. There can only be one meter reading detail for a given combination of MeterType and ReadingDate for a property.If you are updating an existing meter reading detail, use the query parameters to specify the existing meter reading detail to update.If you are creating a new meter reading detail, do not pass any query parameters.When adding a new item to the Details array, leave out the `Id` field.When updating an existing item in the Details array, the `Id` field of the existing item must be included. Returns: ReadingDate, MeterType, Details. Required: property_id, Details, MeterType, ReadingDate. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

delete_a_buildium_rental_meterreading_summary_by_id

Delete meter reading summaries for a Buildium rental property. Returns an empty 204 response on success. Required: property_id, readingdate, metertype.

create_a_buildium_architecturalrequest_file_uploadrequest

Upload an architectural request file in Buildium. 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. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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 AWS documentation on REST error responses. NOTE: 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. Returns: UploadUrl, PhysicalFileName, Headers. Required: architectural_request_id, FileName. Needs Buildium permission: Associations > Associations and units (View, Edit); Associations > Ownership accounts (View, Edit); Associations > Architectural requests (View, Edit); Associations > Association owners and tenants (View, Edit).

create_a_buildium_file_uploadrequest

Upload a file in Buildium. Uploading a file requires making two API requests. Each step is outlined below. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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 AWS documentation on REST error responses. NOTE: 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. Returns: UploadUrl, PhysicalFileName, Headers. Required: CategoryId, EntityType, FileName, Title. Needs Buildium permission: Documents > Files (View, Edit).

create_a_buildium_check_file_uploadrequest

Upload a file for a check in Buildium. Uploads a file and associates it to the specified check record. Uploading a file requires making two API requests. Each step is outlined below. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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 AWS documentation on REST error responses. NOTE: 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. Returns: BucketUrl, FormData, PhysicalFileName. Required: bank_account_id, check_id, FileName. Needs Buildium permission: Accounting > Checks (View, Edit); Accounting > General Ledger Transactions (View).

create_a_buildium_bill_file_uploadrequest

Upload a bill file in Buildium. Uploads a file and associates it to the specified bill record. Uploading a file requires making two API requests. Each step is outlined below. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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 AWS documentation on REST error responses. NOTE: 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. Returns: UploadUrl, PhysicalFileName, Headers. Required: bill_id, FileName. Needs Buildium permission: Accounting > Bills (View, Edit).

create_a_buildium_task_history_file_uploadrequest

Upload a task history file in Buildium. 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. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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 AWS documentation on REST error responses. NOTE: 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. Returns: UploadUrl, PhysicalFileName, Headers. Required: task_id, task_history_id, FileName. Needs Buildium permission: Tasks > Tasks (View, Edit).

create_a_buildium_architecturalrequest_file_downloadrequest

Create a download request for a specific file associated with an architectural request in Buildium, generating a URL to access the file. Returns: DownloadUrl. Required: architectural_request_id, file_id. To get the file itself, pass DownloadUrl to buildium_files_download right away.

create_a_buildium_check_file_downloadrequest

Create a download request for a specific check file in buildium to obtain a temporary download URL. Returns: DownloadUrl. Required: bank_account_id, check_id, file_id. To get the file itself, pass DownloadUrl to buildium_files_download right away.

create_a_buildium_bill_file_downloadrequest

Create a download request for a specific bill file in Buildium, generating a presigned URL to access the file. Returns: DownloadUrl. Required: bill_id, file_id. To get the file itself, pass DownloadUrl to buildium_files_download right away.

create_a_buildium_task_history_file_downloadrequest

Create a download request for a specific file attached to a Buildium task history record. Works for any task type (contact requests, rental owner requests, resident requests, or to do's). Returns: DownloadUrl. Required: task_id, task_history_id, file_id. To get the file itself, pass DownloadUrl to buildium_files_download right away.

create_a_buildium_rental_image_downloadrequest

Create a temporary download URL for a buildium rental property image. Returns: DownloadUrl. The URL expires after 5 minutes. Required: property_id, image_id. To get the file itself, pass DownloadUrl to buildium_files_download right away.

create_a_buildium_unit_image_downloadrequest

Create a temporary download URL for a buildium rental unit image. Returns: DownloadUrl. Required: unit_id, image_id. The generated URL expires after 5 minutes. To get the file itself, pass DownloadUrl to buildium_files_download right away.

update_a_buildium_rental_images_order_by_id

Update property image order in Buildium. Updates the image display order within the Buildium web application and in any associated rental listings. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: property_id, Ids. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

update_a_buildium_unit_images_order_by_id

Update unit image order in Buildium. Updates the image display order within the Buildium web application and in any associated rental listings. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: unit_id, Ids. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

create_a_buildium_rental_image_uploadrequest

Upload a rental image in Buildium. Uploading a file requires making two API requests. Each step is outlined below. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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. NOTE: 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: 5. Send the PUT request! A successful request will return with a `200 - OK` HTTP response code. For any failure responses, please refer to AWS documentation on REST error responses. NOTE: 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. Returns: UploadUrl, PhysicalFileName, Headers. Required: property_id, FileName, ShowInListing. Needs Buildium permission: Documents > Files (View, Edit).

create_a_buildium_unit_image_uploadrequest

Upload a unit image in Buildium. Uploading a file requires making two API requests. Each step is outlined below. Step 1 - Save file metadata 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. NOTE: 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. Step 2 - Upload the file binary 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. NOTE: 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 AWS documentation on REST error responses. NOTE: 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. Returns: UploadUrl, PhysicalFileName, Headers. Required: unit_id, FileName, ShowInListing. Needs Buildium permission: Documents > Files (View, Edit).

create_a_buildium_rental_image_videolinkrequest

Create an image for a rental using a video link in Buildium. Creates an image for a rental using a video link. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: property_id, ShowInListing, VideoUrl. Needs Buildium permission: Rentals > Rental properties and units (View, Edit).

create_a_buildium_unit_image_videolinkrequest

Create an image for a unit using a video link in Buildium. Creates an image for a rental unit using a video link. Returns: Id, Description, PhysicalFileName, Provider, ShowInListing. Required: unit_id, ShowInListing, VideoUrl. Needs Buildium permission: Rentals > Properties and units (View, Edit).

list_all_buildium_inventory_assets

Retrieve all inventory assets in Buildium. Retrieves a list of inventory assets. Returns: Id, Name, CategoryId, CategoryName, Make, Model, Description, ItemType, PropertyId, PropertyName, AccountingBookId, CompanyName, and more. Needs Buildium permission: Maintenance > Inventory and Assets (View).

create_a_buildium_inventory_asset

Create an inventory asset in Buildium. Creates an inventory asset. Returns: Id, Name, CategoryId, CategoryName, Make, Model, Description, ItemType, PropertyId, PropertyName, AccountingBookId, CompanyName, and more. Required: CategoryId, EntityId, EntityType, ItemType, Name, Status. Needs Buildium permission: Maintenance > Inventory and Assets (View, Edit).

get_single_buildium_inventory_asset_by_id

Retrieve an inventory asset in Buildium. Retrieves a specific inventory asset. Returns: Id, Name, CategoryId, CategoryName, Make, Model, Description, ItemType, PropertyId, PropertyName, AccountingBookId, CompanyName, and more. Required: id. Needs Buildium permission: Maintenance > Inventory and Assets (View).

update_a_buildium_inventory_asset_by_id

Update an inventory asset in Buildium. Updates an inventory asset. Returns: Id, Name, CategoryId, CategoryName, Make, Model, Description, ItemType, PropertyId, PropertyName, AccountingBookId, CompanyName, and more. Required: id, CategoryId, EntityId, EntityType, Name, Status. Needs Buildium permission: Maintenance > Inventory and Assets (View, Edit).

delete_a_buildium_inventory_asset_by_id

Delete an inventory asset in Buildium. Deletes an inventory asset and its associated service history. Any tasks linked to the asset will be unlinked. Required: id. Needs Buildium permission: Maintenance > Inventory and Assets (View, Edit, Delete).

list_all_buildium_asset_service_histories

Retrieve asset service history in Buildium. Retrieves a list of service history records for the specified inventory asset. Returns: Id, EventType, EventDate, Details. Required: inventory_asset_id. Needs Buildium permission: Maintenance > Inventory and Assets (View).

create_a_buildium_asset_service_history

Creates an asset service history entry in Buildium. Creates an asset service history entry for a given inventory asset. Returns: Id, EventType, EventDate, Details. Required: inventory_asset_id. Needs Buildium permission: Maintenance > Inventory and Assets (View, Edit).

get_single_buildium_asset_service_history_by_id

Retrieve an asset service history record in Buildium. Retrieves a specific service history record for the specified inventory asset. Returns: Id, EventType, EventDate, Details. Required: inventory_asset_id, id. Needs Buildium permission: Maintenance > Inventory and Assets (View).

list_all_buildium_asset_categories

Retrieve all asset categories in Buildium. Retrieves a list of asset categories. Returns: Id, Name. Needs Buildium permission: Maintenance > Inventory and Assets (View).

list_all_buildium_inventory_storages

Retrieve all inventory storages in Buildium. Retrieves a list of inventory storages. Returns: Id, Name. Needs Buildium permission: Maintenance > Inventory and Assets (View).