\r\n\r\n | \r\n Applicants\r\n | \r\n \r\n Applicant.Created\r\n
\r\n Applicant.Updated\r\n
\r\n Applicant.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
ApplicantId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Applicant Applications\r\n | \r\n \r\n ApplicantApplication.Created\r\n
\r\n ApplicantApplication.Updated\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
ApplicantId: [integer]\r\n
ApplicationId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Board Members\r\n | \r\n \r\n AssociationBoardMember.Created \r\n
\r\n AssociationBoardMember.Updated\r\n
\r\n AssociationBoardMember.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
BoardMemberId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Associations\r\n | \r\n \r\n Association.Created \r\n
\r\n Association.Updated\r\n
\r\n Association.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
PropertyId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Meter Readings\r\n | \r\n \r\n Association.MeterReading.Created \r\n
\r\n Association.MeterReading.Updated\r\n
\r\n Association.MeterReading.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
PropertyId: [integer],\r\n
ReadingDate: [date],\r\n
MeterType: [string] \r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Owners\r\n | \r\n \r\n AssociationOwner.Created \r\n
\r\n AssociationOwner.Updated\r\n
\r\n AssociationOwner.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
OwnerId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Ownership Account Transactions\r\n | \r\n \r\n OwnershipAccountTransaction.Created \r\n
\r\n OwnershipAccountTransaction.Updated\r\n
\r\n OwnershipAccountTransaction.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TransactionId: [integer],\r\n
TransactionType: [string]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Ownership Accounts\r\n | \r\n \r\n OwnershipAccount.Created \r\n
\r\n OwnershipAccount.Updated\r\n
\r\n OwnershipAccount.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
OwnershipAccountId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Tenants\r\n | \r\n \r\n AssociationTenant.Created \r\n
\r\n AssociationTenant.Updated\r\n
\r\n AssociationTenant.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TenantId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Association Units\r\n | \r\n \r\n AssociationUnit.Created \r\n
\r\n AssociationUnit.Updated\r\n
\r\n AssociationUnit.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
UnitId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Bank Accounts\r\n | \r\n \r\n BankAccount.Created \r\n
\r\n BankAccount.Updated\r\n
\r\n BankAccount.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
BankAccountId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Bank Account Transactions\r\n | \r\n \r\n BankAccount.Transaction.Created \r\n
\r\n BankAccount.Transaction.Updated\r\n
\r\n BankAccount.Transaction.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
BankAccountId: [integer],\r\n
TransactionId: [integer],\r\n
TransactionType: [string]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Bills\r\n | \r\n \r\n Bill.Created \r\n
\r\n Bill.Updated\r\n
\r\n Bill.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
BillId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Bill Payments\r\n | \r\n \r\n Bill.Payment.Created \r\n
\r\n Bill.Payment.Updated\r\n
\r\n Bill.Payment.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
PaymentId: [integer]\r\n
BillIds: [\r\n
[integer]\r\n
]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Budgets\r\n | \r\n \r\n Budget.Created \r\n
\r\n Budget.Updated\r\n
\r\n Budget.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
BudgetId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n General Ledger Accounts\r\n | \r\n \r\n GLAccount.Created \r\n
\r\n GLAccount.Updated\r\n
\r\n GLAccount.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
GLAccountId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n
\r\n | \r\n Integrations\r\n | \r\n \r\n Installation.Created \r\n
\r\n Installation.Updated\r\n
\r\n Installation.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
IntegrationName: [string]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Lease Move Outs\r\n | \r\n \r\n Lease.MoveOut.Created\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
LeaseId: [integer],\r\n
TenantId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Lease Tenants\r\n | \r\n \r\n LeaseTenant.Created \r\n
\r\n LeaseTenant.Updated\r\n
\r\n LeaseTenant.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TenantId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Lease Transactions\r\n | \r\n \r\n LeaseTransaction.Created \r\n
\r\n LeaseTransaction.Updated\r\n
\r\n LeaseTransaction.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TransactionId: [integer],\r\n
TransactionType: [string]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Leases\r\n | \r\n \r\n Lease.Created \r\n
\r\n Lease.Updated\r\n
\r\n Lease.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
LeaseId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Listings\r\n | \r\n \r\n Listing.Created \r\n
\r\n Listing.Updated\r\n
\r\n Listing.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
UnitId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Phone Logs\r\n | \r\n \r\n PhoneLog.Created \r\n
\r\n PhoneLog.Updated\r\n
\r\n PhoneLog.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
PhoneLogId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Rental Meter Readings\r\n | \r\n \r\n Rental.MeterReading.Created \r\n
\r\n Rental.MeterReading.Updated\r\n
\r\n Rental.MeterReading.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
PropertyId: [integer],\r\n
ReadingDate: [date],\r\n
MeterType: [string] \r\n
\r\n }\r\n \r\n | \r\n
\r\n \r\n | \r\n Rental Properties\r\n | \r\n \r\n Rental.Created\r\n
\r\n Rental.Updated\r\n
\r\n Rental.Deleted\r\n | \r\n \r\n {
EventName: [string],
EventDateTime: [datetime],
AccountId: [integer],
PropertyId: [integer]
}\r\n | \r\n
\r\n\r\n | \r\n Rental Units\r\n | \r\n \r\n RentalUnit.Created \r\n
\r\n RentalUnit.Updated\r\n
\r\n RentalUnit.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
UnitId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Task Categories\r\n | \r\n \r\n TaskCategory.Created \r\n
\r\n TaskCategory.Updated\r\n
\r\n TaskCategory.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TaskCategoryId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Tasks\r\n | \r\n \r\n Task.Created \r\n
\r\n Task.Updated\r\n
\r\n Task.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TaskId: [integer],\r\n
TaskType: [string],\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Vendor Categories\r\n | \r\n \r\n VendorCategory.Created \r\n
\r\n VendorCategory.Updated\r\n
\r\n VendorCategory.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
VendorCategoryId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n | \r\n Vendors\r\n | \r\n \r\n Vendor.Created \r\n
\r\n Vendor.Updated\r\n
\r\n Vendor.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
VendorId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n
\r\n | \r\n Vendor Transactions\r\n | \r\n \r\n Vendor.Transaction.Created \r\n
\r\n Vendor.Transaction.Updated\r\n
\r\n Vendor.Transaction.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
TransactionId: [integer]\r\n
TransactionType: [string]\r\n
VendorId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n
\r\n | \r\n Work Orders\r\n | \r\n \r\n WorkOrder.Created\r\n
\r\n WorkOrder.Updated\r\n
\r\n WorkOrder.Deleted\r\n | \r\n \r\n \r\n {\r\n
EventName: [string],\r\n
EventDateTime: [datetime], \r\n
AccountId: [integer],\r\n
WorkOrderId: [integer]\r\n
\r\n }\r\n \r\n | \r\n
\r\n\r\n
\r\n\r\n\r\n# Changelog\r\n\r\n### 2024-02-20\r\n#### API Updates\r\n* Meter reading resources and webhook events have been released:\r\n * [Delete meter reading details for an association and date](#tag/Association-Meter-Readings/operation/ExternalApiAssociationDeleteMeterReadingDetails_DeleteMeterReadingDetailsForAssociation)\r\n * [Delete meter reading details for a rental and date](#tag/Rental-Meter-Readings/operation/ExternalApiRentalDeleteMeterReadingDetails_DeleteMeterReadingDetailsForRental)\r\n * [Retrieve all meter reading details for an association](#tag/Association-Meter-Readings/operation/ExternalApiAssociationMeterReadingDetails_GetAssociationMeterReadingDetailsAsync)\r\n * [Retrieve all meter reading details for a rental](#tag/Rental-Meter-Readings/operation/ExternalApiRentalMeterReadingDetails_GetMeterReadingDetailsForRentalAsync)\r\n * [Retrieve all meter readings for an association](#tag/Association-Meter-Readings/operation/ExternalApiAssociationMeterReadingsRead_GetMeterReadingsForAssociation)\r\n * [Retrieve all meter readings for a rental](#tag/Rental-Meter-Readings/operation/ExternalApiRentalMeterReadingsRead_GetMeterReadingsForRental)\r\n * [Create/Update meter reading details for a rental](#tag/Rental-Meter-Readings/operation/ExternalApiRentalMeterReadingDetailsUpsert_UpsertMeterReadingDetailsForRentalAsync)\r\n * [Create/Update meter reading details for an association](#tag/Association-Meter-Readings/operation/ExternalApiAssociationMeterReadingDetailsUpsert_UpsertAssociationMeterReadingDetailsAsync)\r\n\r\n### 2024-01-23\r\n#### API Updates\r\n* Unit level accounting changes have been released:\r\n * `UnitId` has been added, as optional, to the `AccountingEntity` property for accounting transactions request resources. \r\n * `Unit` has been added to the `AccountingEntity` property for accounting transactions response resources.\r\n * As part of those changes listed above, the following endpoints have been updated:\r\n * [Create a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountChecks_CreateBankAccountCheck)\r\n * [Update a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountChecks_UpdateCheckForBankAccount)\r\n * [Retrieve a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountChecks_GetCheckForBankAccount)\r\n * [Retrieve all checks](#tag/Bank-Accounts/operation/ExternalApiBankAccountChecks_GetBankAccountChecks)\r\n * [Create a deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountDeposits_CreateBankAccountDeposit)\r\n * [Update a deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountDeposits_UpdateBankAccountDeposit)\r\n * [Retrieve a deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountDeposits_GetBankAccountDepositById)\r\n * [Retrieve all deposits](#tag/Bank-Accounts/operation/ExternalApiBankAccountDeposits_GetBankAccountDeposits)\r\n * [Create a quick deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountQuickDeposits_CreateQuickDeposit)\r\n * [Update a quick deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountQuickDeposits_UpdateQuickDeposit)\r\n * [Retrieve a quick deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountQuickDeposits_GetQuickDepositById)\r\n * [Retrieve all quick deposits](#tag/Bank-Accounts/operation/ExternalApiBankAccountQuickDeposits_GetAllQuickDeposits)\r\n * [Create a bill](#tag/Bills/operation/ExternalApiBills_CreateBill)\r\n * [Update a bill](#tag/Bills/operation/ExternalApiBills_UpdateBill)\r\n * [Retrieve a bill](#tag/Bills/operation/ExternalApiBills_GetBillById)\r\n * [Retrieve all bills](#tag/Bills/operation/ExternalApiBills_GetBillsAsync)\r\n * [Create a bill payment](#tag/Bills/operation/ExternalApiBillPaymentsWrite_CreateBillPayment)\r\n * [Retrieve a bill payment](#tag/Bills/operation/ExternalApiBillPaymentsRead_GetBillPaymentById)\r\n * [Retrieve all bill payments](#tag/Bills/operation/ExternalApiBillPaymentsRead_GetBillPayments)\r\n * [Create a withdrawal](#tag/Bank-Accounts/operation/ExternalApiBankAccountWithdrawals_CreateWithdrawalForBankAccount)\r\n * [Update a withdrawal](#tag/Bank-Accounts/operation/ExternalApiBankAccountWithdrawals_UpdateBankAccountWithdrawal)\r\n * [Retrieve a withdrawal](#tag/Bank-Accounts/operation/ExternalApiBankAccountWithdrawals_UpdateBankAccountWithdrawal)\r\n * [Retrieve all withdrawals](#tag/Bank-Accounts/operation/ExternalApiBankAccountWithdrawals_GetBankAccountWithdrawals)\r\n * [Create a transfer](#tag/Bank-Accounts/operation/ExternalApiBankAccountTransfers_CreateBankAccountTransfer)\r\n * [Update a transfer](#tag/Bank-Accounts/operation/ExternalApiBankAccountTransfers_UpdateBankAccountTransfer)\r\n * [Retrieve a transfer](#tag/Bank-Accounts/operation/ExternalApiBankAccountTransfers_GetBankAccountTransferById)\r\n * [Retrieve all transfers](#tag/Bank-Accounts/operation/ExternalApiBankAccountTransfers_GetBankAccountTransfers)\r\n * [Create a credit](#tag/Vendors/operation/ExternalApiVendorCreditsWrite_CreateVendorCredit)\r\n * [Retrieve a credit](#tag/Vendors/operation/ExternalApiVendorCredits_GetVendorCredit)\r\n * [Create a refund](#tag/Vendors/operation/ExternalApiVendorRefundsWrite_CreateVendorRefund)\r\n * [Retrieve a refund](#tag/Vendors/operation/ExternalApiVendorRefunds_GetVendorRefund)\r\n * [Create a general journal entry](#tag/General-Ledger/operation/ExternalApiGeneralLedgerJournalEntries_CreateGeneralJournalEntry)\r\n * [Update a general journal entry](#tag/General-Ledger/operation/ExternalApiGeneralLedgerJournalEntries_UpdateGeneralJournalEntry)\r\n * [Retrieve a general ledger transaction](#tag/General-Ledger/operation/ExternalApiGeneralLedgerTransactions_GetTransactionById)\r\n * [Retrieve all general ledger transactions](/#tag/General-Ledger/operation/ExternalApiGeneralLedgerTransactions_GetAllTransactions)\r\n * [Retrieve all general ledger entries](#tag/General-Ledger/operation/ExternalApiGeneralLedger_GetGeneralLedgerEntries)\r\n * `UnitId` has been added to the `Lines` property for lease accounting transactions response resources.\r\n * [Retrieve all lease transactions](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerTransactions_GetLeaseLedgers)\r\n * [Retrieve a lease transaction](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerTransactions_GetLeaseLedgerTransactionById)\r\n * [Create a charge](#tag/Lease-Transactions/operation/CreateLeaseLedgerCharge)\r\n * [Update a charge](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerChargesWrite_UpdateLeaseCharge)\r\n * [Create a payment](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerPaymentsWrite_CreatePayment)\r\n * [Create a payment (auto allocated)](#tag/Lease-Transactions/operation/ExternalApiLeaseAutoAllocatedPayment_CreateLeaseAutoAllocatedPayment)\r\n * [Create a payment reversal](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerPaymentReversalsWrite_CreateLeaseReversePayment)\r\n * [Create a credit](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerCreditsWrite_CreateLeaseCredit)\r\n * [Create a deposit withholding](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerDepositWithholding_CreateLeaseLedgerDepositWithholding)\r\n* Requests to [create a deposit](#tag/Bank-Accounts/operation/ExternalApiBankAccountDeposits_CreateBankAccountDeposit) that contain payment ids that do not exist or have already been deposited will include those payment ids in the error response.\r\n* The ability to update a ledger payment has been released for [leases](#tag/Lease-Transactions/operation/ExternalApiLeaseLedgerPaymentsWrite_UpdateLeaseLedgerPayment) and [ownership accounts](#tag/Ownership-Account-Transactions/operation/ExternalApiOwnershipAccountLedgerPayments_UpdateOwnershipAccountLedgerPayment).\r\n\r\n### 2023-12-12\r\n#### API Updates\r\n* File sharing resources have been released:\r\n * [Retrieve a file's share settings](#tag/Files/operation/ExternalApiFileSharing_GetFileShareSettingsById)\r\n * [Update a file's share settings](#tag/Files/operation/ExternalApiFileSharing_UpdateFileSharingSetting)\r\n* `TransactionTypeEnum` has been added as a property to lease and ownership account transaction response resources.\r\n* `MoveInDate` has been added as a property to each resource in the `Tenants` property of a lease resource.\r\n\r\n\r\n### 2023-11-14\r\n#### API Updates\r\n* The ability to set sharing options while [creating a resident request task](#tag/Resident-Requests/operation/ExternalApiResidentRequestTasks_CreateResource) has been released.\r\n* `AccountNumberUnmasked` has been added as a property to bank account response resources.\r\n* `DelinquencyStatus` has been added as a property to each Ownership Account in the response for association lockbox data response resources.\r\n\r\n### 2023-10-17\r\n#### API Updates\r\n* Check files endpoints have been released:\r\n * [Retrieve all files for a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountCheckFiles_GetFilesForBankAccountCheck)\r\n * [Retrieve a file for a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountCheckFiles_GetBankAccountCheckFileById)\r\n * [Download a file for a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountCheckFileDownloadRequests_DownloadCheckFile)\r\n * [Upload a file for a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountCheckFileUploads_CreateCheckUploadFileRequest)\r\n * [Delete a file for a check](#tag/Bank-Accounts/operation/ExternalApiBankAccountCheckFiles_DeleteBankAccountCheckFile)\r\n* The ability to [create a payment for multiple bills with one check](#tag/Bills/operation/ExternalApiBillPaymentsWrite_CreateMultipleBillPayments) has been released.\r\n\r\n### 2023-09-19\r\n#### API Updates\r\n* Lease ePay settings endpoints have been released:\r\n * [Retrieve ePay settings for a lease](#operation/ExternalApiLeaseEpaySettings_GetLeaseEpaySettingsById)\r\n * [Update ePay settings for a lease](#operation/ExternalApiLeaseEpaySettings_UpdateLeaseEpaySettings)\r\n* The ability to filter [ownership accounts](#operation/ExternalApiOwnershipAccounts_GetAllOwnershipAccounts) and [associations](#operation/ExternalApiAssociations_GetAssociations) by ids has been released.\r\n\r\n### 2023-08-16\r\n#### API Updates\r\n* Rental owner contribution request endpoints have been released:\r\n * [Retrieve contribution details included for a rental owner contribution request](#operation/ExternalApiRentalOwnerRequestTasks_GetRentalOwnerRequestTaskContributionData)\r\n * [Update contribution details included for a rental owner contribution request](#operation/ExternalApiRentalOwnerRequestTasks_UpdateRentalOwnerRequestTaskContributionData)\r\n* The ability to [retrieve all association bank lockbox data](#operation/ExternalApiAssociationBankLockBoxData_GetBankLockBoxData) has been released.\r\n* The ability to create payments using configured allocation settings have been released:\r\n * [Create a lease ledger payment with automatic allocations](#operation/ExternalApiLeaseAutoAllocatedPayment_CreateLeaseAutoAllocatedPayment)\r\n * [Create an ownership account ledger payment with automatic allocations](#operation/ExternalApiOwnershipAccountAutoAllocatedPayment_CreateOwnershipAccountAutoAllocatedPayment)\r\n* Budget resources will now round values within the `MonthlyAmounts` collection to two decimal places.\r\n \r\n### 2023-07-18\r\n#### API Updates\r\n* The ability to [retrieve all general ledger entries](#operation/ExternalApiGeneralLedger_GetGeneralLedgerEntries) has been released.\r\n* Retail cash user endpoints have been released:\r\n * [Retrieve all retail cash users](#operation/ExternalApiRetailCashRead_GetRetailCashUsers)\r\n * [Retrieve a retail cash user](#operation/ExternalApiRetailCashRead_GetRetailCashUser)\r\n * [Update a retail cash user](#operation/ExternalApiRetailCashWrite_UpdateRetailCashUser)\r\n* `TaxInformation` has been added as a property to Association response resources.\r\n* `TaxInformation` has been added as an optional property when [creating an association](#operation/ExternalApiAssociations_CreateAssociation).\r\n\r\n#### Webhook Updates\r\n* New [webhook events](#section/Webhooks/Webhook-Events) have been added for the following resources:\r\n - Vendor transactions\r\n \r\n### 2023-06-20\r\n#### API Updates\r\n* The ability to [retrieve all lease renewals](#operation/ExternalApiLeaseRenewalsRead_GetAllLeaseRenewalsForAllProperties) has been released.\r\n* Image management endpoints have been released:\r\n * Retrieve images for [rentals](#operation/ExternalApiRentalImages_GetRentalImages) and [rental units](#operation/ExternalApiRentalUnitImages_GetRentalUnitImages)\r\n * Retrieve an image for [rentals](#operation/ExternalApiRentalImages_GetRentalImageById) and [rental units](#operation/ExternalApiRentalUnitImages_GetRentalUnitImageById)\r\n * Update an image for [rentals](#operation/ExternalApiRentalImages_UpdateRentalImage) and [rental units](#operation/ExternalApiRentalUnitImages_UpdateRentalUnitImage)\r\n * Delete an image for [rentals](#operation/ExternalApiRentalImages_DeleteRentalImage) and [rental units](#operation/ExternalApiRentalUnitImages_DeleteRentalUnitImage)\r\n * Reorder images for [rentals](#operation/ExternalApiRentalImageOrder_ReorderRentalImages) and [rental units](#operation/ExternalApiRentalUnitImageOrder_ReorderRentalUnitImages) \r\n * Upload photos for [rentals](#operation/CreateRentalImageUploadFileRequestAsync) and [rental units](#operation/CreateRentalUnitImageUploadFileRequestAsync)\r\n * Create images using video links for [rentals](#operation/ExternalApiRentalImageVideoLinkRequests_CreateVideoLinkRequest) and [rental units](#operation/ExternalApiRentalUnitImageVideoLinkRequests_CreateUnitVideoLinkRequest)\r\n * Download an image for [rentals](#operation/ExternalApiRentalImageDownloadRequests_GetRentalImageDownloadUrlById) and [rental units](#operation/ExternalApiRentalUnitImageDownloadRequests_GetRentalUnitImageDownloadUrlById)\r\n\r\n### 2023-05-16\r\n#### API Updates\r\n* `TenantIds` and `ApplicantIds` can optionally be provided to the [create a lease](#operation/LeasesExternalApi_CreateLease) endpoint.\r\n* The `Lines` property for recurring charge transactions is now populated on the following endpoints:\r\n * [Retrieve all recurring transactions for a lease](#operation/LeaseRecurringTransactionsExternalApi_GetLeaseRecurringTransactions)\r\n * [Retrieve all recurring transactions for an ownership account](#operation/OwnershipAccountRecurringTransactionsExternalApi_GetAssociationRecurringTransaction)\r\n* EPay settings endpoints have been released:\r\n * [Retrieve EPay settings for a rental](#operation/RentalEpaySettingsExternalApi_GetEPaySettingsForRentalProperty)\r\n * [Update EPay settings for a rental](#operation/RentalEpaySettingsExternalApi_UpdateEPaySettingsForRental)\r\n * [Retrieve EPay settings for an association](#operation/AssociationsEPaySettingsExternalApi_GetEPaySettingsForAssociationById)\r\n * [Update EPay settings for an association](#operation/AssociationsEPaySettingsExternalApi_UpdateEPaySettingsForAssociation)\r\n* The ability to inactivate or reactivate rentals and associations have been released:\r\n * [Inactivate a rental](#operation/ExternalApiRentalsActiveStatus_InactivateRentalProperty)\r\n * [Reactivate a rental](#operation/ExternalApiRentalsActiveStatus_ReactivateRentalProperty)\r\n * [Inactivate an association](#operation/ExternalApiAssociationActiveStatus_InactivateAssociation)\r\n * [Reactivate an association](#operation/ExternalApiAssociationActiveStatus_ReactivateAssociation)\r\n* Renters insurance endpoints have been released:\r\n * [Retrieve all renters insurance policies](#operation/RentersInsuranceExternalApi_GetRentersInsurancePolicies)\r\n * [Retrieve a renters insurance policy](#operation/RentersInsuranceExternalApi_GetRentersInsurancePolicyById)\r\n* Applicant `Status` has been added to the response for the following endpoints:\r\n * [Retrieve all applicants](#operation/ApplicantsExternalApi_GetApplicants)\r\n * [Retrieve an applicant](#operation/ApplicantsExternalApi_GetApplicantById)\r\n * [Create an applicant](#operation/ApplicantsExternalApi_CreateApplicant)\r\n\r\n### 2023-04-18\r\n#### API Updates\r\n* The ability to retrieve accounting lock periods has been released:\r\n - [Retrieve accounting lock periods](#operation/AccountingLockPeriodExternalApi_GetAccountingLockPeriodSettings)\r\n* Email related endpoints have been released:\r\n - [Retrieve all emails](#operation/EmailsExternalApi_GetEmails)\r\n - [Retrieve an email](#operation/EmailsExternalApi_GetEmailById)\r\n - [Create an email](#operation/EmailsExternalApiWrite_CreateEmail)\r\n - [Retrieve all email recipients](#operation/EmailsExternalApi_GetEmailRecipients)\r\n - [Retrieve all communication templates](#operation/MailingTemplatesExternalApi_GetMailingTemplates)\r\n - [Retrieve a communication template](#operation/MailingTemplatesExternalApi_GetMailingTemplatesById)\r\n* The ability to retrieve resident center users has been released:\r\n - [Retrieve all resident center users](#operation/ResidentCenterUsersExternalApi_GetResidentCenterUsers)\r\n* Vendor transaction related endpoints have been released:\r\n - [Create a credit](#operation/VendorCreditsWriteExternalApi_CreateVendorCredit)\r\n - [Retrieve a credit](#operation/VendorCreditsExternalApi_GetVendorCredit)\r\n - [Create a refund](#operation/VendorRefundsWriteExternalApi_CreateVendorRefund)\r\n - [Retrieve a refund](#operation/VendorRefundsExternalApi_GetVendorRefund)\r\n* Lease and ownership account deposit and charge related endpoints have been released:\r\n - [Create an ownership account deposit withholding](#operation/OwnershipAccountDepositWithholdingExternalApi_CreateOwnershipAccountDepositWithholding)\r\n - [Update an ownership account charge](#operation/OwnershipAccountsLedgerExternalApi_UpdateOwnershipAccountCharge)\r\n - [Create a lease deposit withholding](#operation/LeaseLedgerDepositWithholdingExternalApi_CreateLeaseLedgerDepositWithholding)\r\n - [Update a lease charge](#operation/LeaseLedgerTransactionsExternalApi_UpdateLeaseCharge)\r\n* The [create a lease](#operation/LeasesExternalApi_CreateLease) endpoint now includes the ability to provide amounts for `ProratedFirstMonthRent` and `ProratedLastMonthRent`.\r\n\r\n### 2023-03-21\r\n#### API Updates\r\n* Property groups related endpoints have been released:\r\n - [Retrieve all property groups](#operation/PropertyGroupsExternalApi_GetPropertyGroups)\r\n - [Retrieve a property group](#operation/PropertyGroupsExternalApi_GetPropertyGroupById)\r\n - [Create a property group](#operation/PropertyGroupsExternalApi_CreatePropertyGroup)\r\n - [Update a property group](#operation/PropertyGroupsExternalApi_UpdatePropertyGroup)\r\n* Bill files related endpoints have been released:\r\n - [Retrieve all files for a bill](#operation/BillsFilesExternalApi_GetAllFilesForBill)\r\n - [Retrieve a file for a bill](#operation/BillsFilesExternalApi_GetBillFileById)\r\n - [Upload a bill file](#operation/BillFileUploadsExternalApi_CreateUploadFileRequest)\r\n - [Download a bill file](#operation/BillsFilesExternalApi_DownloadBillFile)\r\n - [Delete a bill file](#operation/BillsFilesExternalApi_DeleteBillFile)\r\n* Bill payment creation has been released:\r\n - [Create a bill payment](#operation/BillPaymentsWriteExternalApi_CreateBillPayment)\r\n* Bills can now be filtered by approval statuses:\r\n - [Retrieve all bills](#operation/BillsExternalApi_GetBillsAsync)\r\n* The bill message now includes an `ApprovalStatus` field.\r\n* The lease message now includes a `Tenants` collection, which includes the `Id` and `Status` of all tenants that have ever been associated with the lease.\r\n* The [create a property](#operation/RentalsExternalApi_CreateRentalProperty) now includes an optional `Units` field for providing unit information for the rental property being created.\r\n\r\n### 2023-02-21\r\n#### API Updates\r\n* Lease renewal related endpoints have been released:\r\n - [Retrieve all lease renewals](#operation/LeaseRenewalsExternalApiRead_GetAllLeaseRenewals)\r\n - [Retrieve a lease renewal](#operation/LeaseRenewalsExternalApiRead_GetLeaseRenewalById)\r\n - [Create a lease renewal](#operation/LeaseRenewalsExternalApiWrite_CreateLeaseRenewal)\r\n\r\n### 2022-12-13\r\n#### API Updates\r\n* Accounting related endpoints have been released:\r\n - [Create a general ledger account](#operation/GeneralLedgerAccountsExternalApi_CreateGeneralLedgerAccount)\r\n - [Update a general ledger account](#operation/GeneralLedgerAccountsExternalApi_UpdateGLAccount)\r\n* The general ledger account message will now include `DefaultAccountName` and `ParentGLAccountId`.\r\n* Filtering by last updated date and time capabilities have been released for the following endpoint:\r\n - [Retrieve all leases](#operation/LeasesExternalApi_GetLeases)\r\n* The lease message will now include `LastUpdatedDateTime`.\r\n\r\n### 2022-11-15\r\n#### API Updates\r\n* Endpoints for announcements have been released:\r\n - [Retrieve all announcements](#operation/AnnouncementsExternalApi_GetAllAnnouncements)\r\n - [Retrieve an announcement](#operation/AnnouncementsExternalApi_GetAnnouncementById)\r\n - [Retrieve all announcement properties](#operation/AnnouncementsExternalApi_GetAnnouncementProperties)\r\n - [Create an announcement](#operation/AnnouncementsExternalApi_CreateAnnouncement)\r\n - [Expire an announcement](#operation/AnnouncementsExpirationExternalApi_ExpireAnnouncement)\r\n* The [create an owner](#operation/RentalOwnersExternalApi_CreateRentalOwner) endpoint now accepts optional tax information.\r\n* The [retrieve all owners](#operation/RentalOwnersExternalApi_GetRentalOwners) and [retrieve an owner](#operation/RentalOwnersExternalApi_GetRentalOwnerById) endpoints now return tax information.\r\n\r\n### 2022-10-18\r\n#### API Updates\r\n* Task history related endpoints have been released! You can now retrieve and update task history notes as well as upload and download task history file attachments.\r\n - [Retrieve all task history](#operation/TaskHistoryExternalApi_GetTaskHistories)\r\n - [Retrieve a task history](#operation/TaskHistoryExternalApi_GetTaskHistoryById)\r\n - [Update a task history](#operation/TaskHistoryExternalApi_UpdateTaskHistory)\r\n - [Retrieve task history file meta data](#operation/TaskHistoryFilesExternalApi_GetAllTaskHistoryFiles)\r\n - [Upload a task history file](#operation/TaskHistoryFileUploadsExternalApi_CreateUploadFileRequestAsync)\r\n - [Download a task history file](#operation/TaskHistoryFileDownloadsExternalApi_GetFileDownloadRequest)\r\n - [Delete a task history file](#operation/TaskHistoryFilesExternalApi_DeleteTaskHistoryFile)\r\n\r\n#### Webhook Updates\r\n* New [webhook events](#section/Webhooks/Webhook-Events) have been added for the following resources: \r\n - Bank Accounts\r\n - Bank Account Transactions\r\n - Bills\r\n - Bill Payments\r\n - Budgets\r\n - General Ledger Accounts\r\n - Phone logs\r\n\r\n### 2022-09-20\r\n#### API Updates\r\n* Accounting related endpoints have been released:\r\n - [Create a general journal entry](#operation/GeneralJournalEntriesExternalApi_CreateGeneralJournalEntry)\r\n - [Update a general journal entry](#operation/GeneralJournalEntriesExternalApi_UpdateGeneralJournalEntry)\r\n - [Retrieve a lease ledger refund](#operation/LeaseLedgerRefundsExternalApi_GetLeaseLedgerRefundById)\r\n - [Create a lease ledger refund](#operation/LeaseLedgerRefundsExternalApi_CreateLeaseLedgerRefund)\r\n - [Retrieve an ownership account refund](#operation/OwnershipAccountRefundExternalApi_GetOwnershipAccountRefundById)\r\n - [Create and ownership account refund](#operation/OwnershipAccountRefundExternalApi_CreateOwnershipAccountRefund)\r\n\r\n#### Webhook Updates\r\n* Webhooks have been released! Please refer to the [Webhooks](#section/Webhooks) section of the documentation for more details.\r\n\r\n### 2022-08-16\r\n#### API Updates\r\n* The [retrieve account info](#operation/AdministrationExternalApi_GetAccountInfo) endpoint now includes `Id` and `Url` fields. \r\n* Endpoints for recurring transactions have been released for leases:\r\n - [Retrieve all recurring transactions](#operation/LeaseRecurringTransactionsExternalApi_GetLeaseRecurringTransactions) \r\n - [Retrieve a recurring charge](#operation/LeaseChargeRecurringTransactionsExternalApi_GetLeaseChargeRecurringTransactionById)\r\n - [Create a recurring charge](#operation/LeaseChargeRecurringTransactionsExternalApi_CreateLeaseChargeRecurringTransaction)\r\n - [Retrieve a recurring payment](#operation/LeaseRecurringPaymentsExternalApi_GetRecurringLeasePaymentsById)\r\n - [Create a recurring payment](#operation/LeaseRecurringPaymentsExternalApi_CreateLeaseRecurringPayment)\r\n - [Retrieve a recurring credit](#operation/LeaseRecurringCreditsExternalApi_GetLeaseRecurringCreditById)\r\n - [Create a recurring credit](#operation/LeaseRecurringCreditsExternalApi_CreateLeaseCreditRecurringTransaction)\r\n* Endpoints for recurring transactions have been released for ownership accounts:\r\n - [Retrieve all recurring transactions](#operation/OwnershipAccountRecurringTransactionsExternalApi_GetAssociationRecurringTransaction)\r\n - [Retrieve a recurring charge](#operation/OwnershipAccountChargeRecurringTransactionsExternalApi_GetOwnershipAccountsChargeRecurringTransactionById)\r\n - [Create a recurring charge](#operation/OwnershipAccountChargeRecurringTransactionsExternalApi_CreateOwnershipAccountsChargeRecurringTransaction)\r\n - [Retrieve a recurring payment](#operation/OwnershipAccountRecurringPaymentsExternalApi_GetRecurringOwnershipAccountPaymentsById)\r\n - [Create a recurring payment](#operation/OwnershipAccountRecurringPaymentsExternalApi_CreateOwnershipAccountRecurringPayment)\r\n - [Retrieve a recurring credit](#operation/OwnershipAccountRecurringCreditsExternalApi_GetOwnershipAccountRecurringCreditById)\r\n - [Create a recurring credit](#operation/OwnershipAccountRecurringCreditsExternalApi_CreateOwnershipAccountCreditRecurringTransaction)\r\n* The [Create Resident Requests](#operation/ResidentRequestTasksExternalApi_CreateResource) endpoint now supports `IsEntryPermittedByResident`, `DoesResidentHavePets`, and `ResidentEntryNotes` as optional inputs.\r\n\r\n### 2022-07-19 \r\n#### API Updates\r\n* The general ledger account message will now include the account's status. This value comes back in a property named `IsActive` on the following endpoints:\r\n - [Retrieve all bills](#operation/BillsExternalApi_GetBillsAsync)\r\n - [Create a bill](#operation/BillsExternalApi_CreateBill)\r\n - [Retrieve a bill](#operation/BillsExternalApi_GetBillById)\r\n - [Update a bill](#operation/BillsExternalApi_UpdateBill)\r\n - [Retrieve all general ledger transactions](#operation/GeneralLedgerExternalApi_GetAllTransactions)\r\n - [Retrieve a general ledger transaction](#operation/GeneralLedgerExternalApi_GetTransactionById)\r\n - [Retrieve all general ledger accounts](#operation/AccountingExternalApi_GetAllGLAccounts)\r\n - [Retrieve a general ledger account](#operation/AccountingExternalApi_GetGlAccountById)\r\n - [Retrieve all general ledger account balances](#operation/GLAccountBalancesExternalApi_GetGlAccountBalances)\r\n - [Retrieve all bank accounts](#operation/BankAccountsExternalApi_GetAllBankAccounts)\r\n - [Create a bank account](#operation/BankAccountsExternalApi_CreateBankAccount)\r\n - [Retrieve a bank account](#operation/BankAccountsExternalApi_GetBankAccount)\r\n - [Update a bank account](#operation/BankAccountsExternalApi_UpdateBankAccount)\r\n - [Retrieve a transfer](#operation/BankAccountTransfersExternalApi_GetBankAccountTransferById)\r\n - [Create a ledger charge](#operation/OwnershipAccountsLedgerExternalApi_CreateCharge)\r\n - [Create a ledger credit](#operation/OwnershipAccountsLedgerExternalApi_CreateOwnershipAccountCredit)\r\n - [Create a ledger payment](#operation/OwnershipAccountsLedgerExternalApi_CreateOwnershipAccountLedgerPayment)\r\n - [Retrieve ownership account transactions](#operation/OwnershipAccountsLedgerExternalApi_GetOwnershipAccountLedger)\r\n - [Retrieve an ownership account transaction](#operation/OwnershipAccountsLedgerExternalApi_GetOwnershipAccountTransactionById)\r\n - [Create a charge](#operation/LeaseLedgerTransactionsExternalApi_CreateCharge)\r\n - [Create a credit](#operation/LeaseLedgerTransactionsExternalApi_CreateLeaseCredit)\r\n - [Create a payment](#operation/LeaseLedgerTransactionsExternalApi_CreatePayment)\r\n - [Create a payment reversal](#operation/LeaseLedgerTransactionsExternalApi_CreateLeaseReversePayment)\r\n - [Retrieve all lease transactions](#operation/LeaseLedgerTransactionsExternalApi_CreateLeaseReversePayment)\r\n - [Retrieve a lease transaction](#operation/LeaseLedgerTransactionsExternalApi_GetLeaseLedgers)\r\n* Filtering by last updated date and time capabilities have been released for the following endpoint:\r\n - [Retrieve all vendors](#operation/VendorsExternalApi_GetAllVendors)\r\n\r\n### 2022-06-14\r\n#### API Updates\r\n* Budgets capabilities have been released including:\r\n - The ability to [retrieve all budgets](#operation/BudgetsExternalApi_GetBudgets)\r\n - The ability to [retrieve a budget](#operation/BudgetsExternalApi_GetBudgetById)\r\n - The ability to [create a budget](#operation/BudgetsExternalApi_CreateBudget)\r\n - The ability to [update a budget](#operation/BudgetsExternalApi_UpdateBudget)\r\n\r\n### 2022-05-24\r\n#### API Updates\r\n* When [creating a resident request](#operation/ResidentRequestTasksExternalApi_CreateResource), if AssignedToUserId is not provided, assignment rules in the resident center settings (if configured) will be used for assignment.\r\n* Filtering by last updated date and time capabilities have been released for the following endpoints:\r\n - [Associations](#operation/AssociationsExternalApi_GetAssociations) \r\n - [Association units](#operation/AssociationUnitsExternalApi_GetAllAssociationUnits)\r\n - [Association owners](#operation/AssociationOwnersExternalApi_GetAllAssociationOwners)\r\n - [Association tenants](#operation/AssociationTenantsExternalApi_GetAssociationTenants)\r\n - [Rental properties](#operation/RentalsExternalApi_GetAllRentals)\r\n - [Rental units](#operation/RentalUnitsExternalApi_GetAllRentalUnits)\r\n - [Rental owners](#operation/RentalOwnersExternalApi_GetRentalOwners)\r\n - [Rental tenants](#operation/RentalTenantsExternalApi_GetAllTenants)\r\n\r\n### 2022-04-19\r\n#### API Updates\r\n* Preferred vendor capabilities have been released including:\r\n - The ability to [retrieve](#operation/AssociationPreferredVendorsExternalApi_GetAssociationPreferredVendors) and [update](#operation/AssociationPreferredVendorsExternalApi_UpdateAssociationPreferredVendors) preferred vendors for associations.\r\n - The ability to [retrieve](#operation/RentalPreferredVendorsExternalApi_GetRentalPreferredVendors) and [update](#operation/RentalPreferredVendorsExternalApi_UpdateRentalPreferredVendors) preferred vendors for rental properties.\r\n\r\n### 2022-03-22\r\n#### API Updates\r\n* [Association owners](#operation/AssociationOwnersExternalApi_GetAllAssociationOwners), [association tenants](#operation/AssociationTenantsExternalApi_GetAssociationTenants) and [board members](#operation/AssociationBoardMembersExternalApi_GetAllAssociationBoardMembers) are now filterable by their created date and time.\r\n* Appliance information and service history is now available for [associations](#tag/Association-Appliances) and [rental properties](#tag/Rental-Appliances).\r\n* [Lease rent schedules](#operation/LeaseRentExternalApi_GetRent) are now available.\r\n\r\n\r\n### 2022-02-15\r\n#### API Updates\r\n* Additional rental data is now available including:\r\n - The ability to retrieve and update rental amenities for properties and units.\r\n - The ability to [retrieve](#operation/LeasesExternalApi_GetLeaseMoveOutInformationById), [create](#operation/LeasesExternalApi_CreateMoveOutData) and [delete](#operation/LeasesExternalApi_UndoTenantMoveout) lease move out dates.\r\n - The ability to [create a payment reversal](#operation/LeaseLedgerTransactionsExternalApi_CreateLeaseReversePayment).\r\n* Additional applicant capabilities are available including:\r\n - The ability to [retrieve](#operation/ApplicantNotesExternalApi_GetAllApplicantNotes) and [create](#operation/ApplicantNotesExternalApi_CreateApplicantNote) applicant notes.\r\n - When an applicant is converted to a tenant a new `TenantId` field on the applicant message will link the two resources.\r\n - The ability to filter the [Retrieve all Applicants](#operation/ApplicantsExternalApi_GetApplicants) endpoint by email address.\r\n* The ability to [retrieve file metadata](#operation/FilesExternalApi_GetFiles) as well as [upload](#operation/FilesUploadsExternalApi_CreateUploadFileRequestAsync) and [download](#operation/FileDownloadExternalApi_GetFileDownloadUrlAsync) files related to the following resources - Accounts, Associations, Association Owners, Association Units, Leases, Ownership Accounts, Public Assets, Rentals, Rental Owners, RentalUnits, Tenants and Vendors.\r\n\r\n\r\n### 2022-01-18\r\n#### API Updates\r\n* Additional association data is now available including:\r\n - The ability [retrieve](#operation/AssociationBoardMembersExternalApi_GetAllAssociationBoardMembers), [create](#operation/AssociationBoardMembersExternalApi_CreateBoardMember) and [delete](#operation/AssociationBoardMembersExternalApi_DeleteBoardMember) association board members.\r\n - Association fiscal month and day can now be retrieved and updated as part of the Association endpoints.\r\n - Staff members can now be assigned as the association manager for a given association.\r\n* Additional association owner data is now available including:\r\n - Association owner occupancy status can be [retrieved](#operation/AssociationOwnersExternalApi_GetUnitOccupancyStatusesForAssociationOwner) and [updated](#operation/AssociationOwnersExternalApi_UpdateAssociationOwnerOccupancyStatus).\r\n - Association owner tax payer identification number can be retrieved and updated as part of the association owner endpoints.\r\n - The date and time the association owner record was created is now being returned in the response payload.\r\n* Additional association tenant features are now available including:\r\n - The ability to set the move out date.\r\n - The date and time the association tenant record was created is now being returned in the response payload.\r\n* [Updating bills](#operation/BillsExternalApi_UpdateBill) now includes the ability to edit line items.\r\n* The ability to retrieve [client leads](#tag/Client-Leads) has been introduced. Note, this data is only available if you have an [All Property Management](https://www.allpropertymanagement.com/) account.\r\n\r\n### 2021-12-14\r\n#### API Updates\r\n* Additional bank account endpoints have been added to retrieve, create and update bank accounts and bank account transactions.\r\n\r\n### 2021-11-16\r\n#### API Updates\r\n* The URL to the rental application for listings is now being returned in a new property called `RentalApplicationUrl`. This new property is included in the following endpoints:\r\n - [Retrieve all listings](#operation/ListingsExternalApi_GetListingsAsync)\r\n - [Retrieve a listing](#operation/ListingsExternalApi_GetListingForUnitAsync)\r\n - [Create a listing](#operation/ListingsExternalApi_UpsertListingsAsync)\r\n* `AssignedToUserId` is no longer required as input for the following endpoints:\r\n - [Create a rental owner request](#operation/RentalOwnerRequestTasksExternalApi_CreateRentalOwnerRequestTask)\r\n - [Update a rental owner request](#operation/RentalOwnerRequestTasksExternalApi_UpdateRentalOwnerRequestTask)\r\n - [Create a resident request](#operation/ResidentRequestTasksExternalApi_CreateResource)\r\n - [Update a resident request](#operation/ResidentRequestTasksExternalApi_UpdateResource)\r\n* Ability to retrieve a single association ownership account transaction has been released:\r\n - [Retrieve a single ownership account transaction](#operation/OwnershipAccountsLedgerExternalApi_GetOwnershipAccountTransactionById)\r\n\r\n### 2021-10-19\r\n#### API Updates\r\n* The taxpayer identifier for rental tenants is now being returned in a new property named `TaxId`. This new property is included in the following endpoints:\r\n - [Retrieve all tenants](#operation/TenantsExternalApi_GetAllTenants)\r\n - [Retrieve a tenant](#operation/TenantsExternalApi_GetTenantById)\r\n - [Create a rental tenant](#operation/TenantsExternalApi_CreateRentalTenant)\r\n - [Update a rental tenant](#operation/TenantsExternalApi_UpdateRentalTenant)\r\n - [Retrieve all leases](#operation/LeasesExternalApi_GetLeases)\r\n - [Retrieve a lease](#operation/LeasesExternalApi_GetLeaseById)\r\n - [Create a lease](#operation/LeasesExternalApi_CreateLease)\r\n - [Update a lease](#operation/LeasesExternalApi_UpdateLease)\r\n* The lease message has been updated to include the day of the month the tenant payments are due. This value comes back in a property named `PaymentDueDay` on the following the following endpoints:\r\n - [Retrieve all leases](#operation/LeasesExternalApi_GetLeases)\r\n - [Retrieve a lease](#operation/LeasesExternalApi_GetLeaseById)\r\n - [Create a lease](#operation/LeasesExternalApi_CreateLease)\r\n - [Update a lease](#operation/LeasesExternalApi_UpdateLease)\r\n* Rental and association messages will now include the operating bank account identifier. This value comes back in a new property named `OperatingBankAccountId` on the following endpoints:\r\n - [Retrieve all associations](#operation/AssociationsExternalApi_GetAssociations)\r\n - [Retrieve an association](#operation/AssociationsExternalApi_GetAssociationById)\r\n - [Create an association](#operation/AssociationsExternalApi_CreateAssociation)\r\n - [Update an association](#operation/AssociationsExternalApi_UpdateAssociation)\r\n - [Retrieve all rental properties](#operation/RentalsExternalApi_GetAllRentals)\r\n - [Retrieve a rental property](#operation/RentalsExternalApi_GetRentalById)\r\n - [Create a rental property](#operation/RentalsExternalApi_CreateRentalProperty)\r\n - [Update a rental property](#operation/RentalsExternalApi_UpdateRentalProperty)\r\n\r\n### 2021-09-21\r\n#### API Updates\r\n* Outstanding balance resource capabilities have been released. Outstanding balances can be retrieved for the following resources:\r\n - [Leases](#operation/LeasesExternalApi_GetLeaseOutstandingBalances)\r\n - [Ownership Accounts](#operation/OwnershipAccountsExternalApi_GetOwnershipAccountOutstandingBalances)\r\n* Work order id will be returned on bills, and is an optional input for creating a bill:\r\n - [Retrieve all bills](#operation/BillsExternalApi_GetBillsAsync)\r\n - [Retrieve a bill](#operation/BillsExternalApi_GetBillById)\r\n - [Create a bill](#operation/BillsExternalApi_CreateBill)\r\n\r\n\r\n### 2021-08-24\r\n#### API Updates\r\n* Note read and write capabilities have been released. Notes can be retrieved, created, updated for the following resources:\r\n - Rentals - [properties](#operation/RentalsExternalApi_GetRentalNotes), [units](#operation/RentalsExternalApi_GetRentalUnitNotes), [owners](#operation/RentalsExternalApi_GetRentalOwnerNotes), [leases](#operation/LeasesExternalApi_GetLeaseNotes) and [tenants](#operation/TenantsExternalApi_GetAllTenantNotes)\r\n - Associations - [properties](#operation/AssociationsExternalApi_GetAssociationNotes), [units](#operation/AssociationsExternalApi_GetAssociationUnitNotes), [owners](#operation/AssociationOwnersExternalApi_GetAssociationOwnerNotes), [ownership accounts](#operation/OwnershipAccountsExternalApi_GetAssociationOwnershipAccountNotes) and [tenants](#operation/AssociationTenantsExternalApi_GetAssociationTenantNotes)\r\n - [Vendors](#operation/VendorExternalApi_GetVendorNotes)\r\n - [Applicant Groups](#operation/ApplicantGroupsExternalApi_GetApplicantGroupNotes)\r\n\r\n\r\n\r\n### 2021-07-20\r\n#### API Updates\r\n* Rental applicant, applicant groups and application write capabilities have been released. These new endpoints will support creating and updating rental applicants and applicant groups as well as enabling the updating of rental application statuses.\r\n - [Create an Applicant Group](#operation/ApplicantGroupsExternalApi_CreateApplicantGroup)\r\n - [Update an Applicant Group](#operation/ApplicantGroupsExternalApi_UpdateApplicantGroup)\r\n - [Create an Applicant](#operation/ApplicantsExternalApi_CreateApplicant)\r\n - [Update an Applicant](#operation/ApplicantsExternalApi_UpdateApplicant)\r\n - [Update an Application](#operation/ApplicantsExternalApi_UpdateApplication)\r\n\r\n\r\n### 2021-06-22\r\n#### API Updates\r\n* Bill and bill payment resources have been released. These new endpoints will support retrieve, create and update functionality for bills and retrieve functionality for bill payments. Creating and updating bill payments will be available in a future release.\r\n - [Retrieve bills](#operation/BillsExternalApi_GetBillsAsync)\r\n - [Create a bill](#operation/BillsExternalApi_CreateBill)\r\n - [Update a bill](#operation/BillsExternalApi_UpdateBill)\r\n - [Retrieve bill payments](#operation/BillsExternalApi_GetBillPayments)\r\n* Rental applicant, applicant groups and application read capabilities have been released. These new endpoints will support retrieving rental applicants, applicant groups and their rental applications. Creating and updating applicants and applicant groups will be available in a future release.\r\n - [Retrieve Applicant Groups](#operation/ApplicantGroupsExternalApi_GetApplicantGroups)\r\n - [Retrieve Applicants](#operation/ApplicantsExternalApi_GetApplicants)\r\n - [Retrieve Applications](#operation/ApplicantsExternalApi_GetApplicationsForApplicant)\r\n* Rental leases can now be filtered by the date and time they were created. The lease created date and time are also being returned as part of the lease response message.\r\n - [Retrieve all leases](#operation/LeasesExternalApi_GetLeases)\r\n\r\n\r\n\r\n### 2021-05-18\r\n#### API Updates\r\n* Work order resources have been released. These new endpoints will support retrieve, create and update functionality for work orders. Review the [Work Order](#tag/Work-Orders) documentation for more information.\r\n* Create capabilities have been released for association ownership account and rental lease ledger transactions. These new endpoints will allow for the creation of ledger charges, payments and credits.\r\n - [Create Rental Lease Ledger Payments](#operation/LeaseLedgerTransactionsExternalApi_CreatePayment)\r\n - [Create Rental Lease Ledger Credits](#operation/LeaseLedgerTransactionsExternalApi_CreateLeaseCredit)\r\n - [Create Association Ownership Account Ledger Charges](#operation/OwnershipAccountsLedgerExternalApi_CreateCharge)\r\n - [Create Association Ownership Account Ledger Payments](#operation/OwnershipAccountsLedgerExternalApi_CreateOwnershipAccountLedgerPayment)\r\n - [Create Association Ownership Account Ledger Credits](#operation/OwnershipAccountsLedgerExternalApi_CreateOwnershipAccountCredit)\r\n\r\n\r\n### 2021-04-20\r\n#### API Updates\r\n* Task resources have been released. These new endpoints will support retrieve, create and update functionality for all task request types. Review the [Tasks](#tag/Tasks) documentation for more information.\r\n* Vendor create and update capabilities have been released. These new endpoints will support creating and updating vendors.\r\n - [Create Vendors](#operation/VendorExternalApi_CreateVendor)\r\n - [Update Vendors](#operation/VendorExternalApi_UpdateVendor)\r\n\r\n### 2021-02-16\r\n#### API Updates\r\n* Phone log resources have been released. These new endpoints will support create, update and retrieve functionality for [phone logs](#operation/PhoneLogsExternalApi_GetPhoneLogs).\r\n* Enhancements to the leases resource have been released. These new endpoints will support create and update functionality for [leases](#operation/LeasesExternalApi_CreateLease).\r\n* Ability to filter by phone has been released for the following:\r\n - [Rental Owners](#operation/RentalsExternalApi_GetRentalOwners)\r\n - [Vendors](#operation/VendorExternalApi_GetAllVendors)\r\n\r\n### 2020-12-15\r\n#### API Updates\r\n* Rental listing resources have been released. These new endpoints will support create and retrieve functionality for:\r\n - [Listing Contacts](#operation/ListingContactsExternalApi_GetAllListingContacts)\r\n - [Listings](#operation/ListingsExternalApi_GetListingsAsync)\r\n\r\n### 2020-11-17\r\n#### API Updates\r\n* Create capabilities have been released for the following resources:\r\n - [Rental Tenants](#operation/TenantsExternalApi_CreateRentalTenant)\r\n - [Association Ownership Accounts](#operation/OwnershipAccountsExternalApi_CreateAssociationOwnershipAccount)\r\n - [Association Owners](#operation/AssociationOwnersExternalApi_CreateAssociationOwner)\r\n* Update capabilities have been released for the following resources:\r\n - [Rental Tenants](#operation/TenantsExternalApi_UpdateRentalTenant)\r\n - [Association Owners](#operation/AssociationOwnersExternalApi_UpdateAssociationOwner)\r\n* Retrieve all [Association Owners](#operation/AssociationOwnersExternalApi_GetAllAssociationOwners) and [Association Tenants](#operation/AssociationTenantsExternalApi_GetAssociationTenants) can now be filtered by statuses: `Active`, `Past` and `Future`.\r\n* The [rental tenant](#operation/TenantsExternalApi_CreateRentalTenant) message now returns the following properties:\r\n - `AlternateEmail`\r\n - `Comment`\r\n - `MailingPreference`\r\n* The [rental property](#operation/RentalsExternalApi_GetRentalById) message now includes the following properties:\r\n - `OperatingBankAccountId`\r\n - `Reserve`\r\n* The [Association Ownership Account](#operation/OwnershipAccountsExternalApi_GetOwnershipAccountById) message now includes `AssociationOwnerIds` which is a list of all of the association owner identifiers that belong to the ownership account.\r\n\r\n### 2020-10-20\r\n#### API Updates\r\n* Create capabilities have been released for the following resources:\r\n - [Rental Properties](#operation/RentalsExternalApi_CreateRentalProperty)\r\n - [Rental Owners](#operation/RentalsExternalApi_CreateRentalOwner)\r\n - [Rental Units](#operation/RentalsExternalApi_CreateRentalUnit)\r\n - [Asssociation Properties](#operation/AssociationsExternalApi_CreateAssociation)\r\n - [Asssociation Units](#operation/AssociationsExternalApi_CreateAssociationUnit)\r\n - [Asssociation Tenants](#operation/AssociationTenantsExternalApi_CreateAssociationTenant)\r\n* Update capabilities have been released for the following resources:\r\n - [Rental Properties](#operation/RentalsExternalApi_UpdateRentalProperty)\r\n - [Rental Owners](#operation/RentalsExternalApi_UpdateRentalOwner)\r\n - [Rental Units](#operation/RentalsExternalApi_UpdateRentalUnit)\r\n - [Asssociation Properties](#operation/AssociationsExternalApi_UpdateAssociation)\r\n - [Asssociation Units](#operation/AssociationsExternalApi_UpdateAssociationUnit)\r\n - [Asssociation Tenants](#operation/AssociationTenantsExternalApi_UpdateAssociation)\r\n\r\n#### Feature Enhancements\r\n* Sandbox environments can now be created for developing and testing your integrations. Learn more about how to take advantage of this new capability in the [API Sandbox](#section/API-Sandbox) section of the documentation.\r\n\r\n### 2020-09-15\r\n#### API Updates\r\n* General ledger account balances are now available through the [Retrieve all general ledger account balances](#operation/GLAccountBalancesExternalApi_GetGlAccountBalances) endpoint. This new endpoint provides the ability to retrieve the general ledger account balances as of a given date.\r\n\r\n### 2020-08-18\r\n#### API Updates\r\n* General ledger transactions are now available through the [Retrieve all general ledger transactions](#operation/GeneralLedgerExternalApi_GetAllTransactions) endpoint. These new endpoints provide the ability to retrieve all transactions or use a set of filters including specific rental/association properties, rental owners, date ranges, and others to find specific transactions.\r\n\r\n### 2020-07-21\r\n#### API Updates\r\n* [Association Owners](#operation/AssociationOwnersExternalApi_GetAllAssociationOwners) response message now returns board member terms including the start date, end date and position.\r\n* Two new resources were added to retrieve [Users](#operation/UsersExternalApi_GetAllUsers) and [User Roles](#operation/UserRolesExternalApi_GetAllUserRoles).\r\n* The [general ledger](#operation/AccountingExternalApi_GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account.\r\n* A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address. \r\n",
"x-logo": {
"url": "Buildium-RP-Color-Logo.png",
"backgroundColor": "#FFFFFF",
"altText": "Buildium Logo",
"href": "https://www.buildium.com"
}
},
"paths": {
"/v1/associations": {
"get": {
"tags": [
"Associations"
],
"summary": "Retrieve all associations",
"description": "Retrieves a list of associations.\r\n![](\"request_example.png\")
\r\n\r\n![](\"response_example.png\")
\r\n\r\n![](\"sandbox_provisioning.gif\")
\r\n\r\n7. Once the sandbox has been created an email will be sent to the address you entered in the \"Create sandbox\" modal. To complete the activation of the sandbox open the email and click on the \"Activate Account\". This will allow you to create a password for your account and log into the sandbox.\r\n\r\n8. You are now ready to begin making API requests to your sandbox! Please see [Accessing the Sandbox](#section/API-Sandbox/Accessing-the-Sandbox) for next steps on how to start making API requests.\r\n\r\n\r\n## Accessing the Sandbox\r\nOnce your sandbox is created you can begin to access it through the Open API. Requests are made following all the same versioning, authentication, messages, etc that are used in the production environment with the exception of the base URL. The base URL for the sandbox is:\r\n![](\"webhook-architecture.png\")
\r\n\r\n## Webhook Events Overview\r\nEvent notifications are Buildium’s way of letting you know when something interesting happens in your account. When a subscribed event occurs a new Event object is created and sent to your endpoint as part of a HTTPS POST request.\r\n\r\nEvent objects are simple data structures with fields that describe the entity and the event that occurred. The object will have the following fields:\r\n\r\n| Field | Description |\r\n| ---- | ---- |\r\n| EventName | This value indicates the entity and operation that occurred. |\r\n| EventDateTime| The date and time that the operation occurred. The value is in UTC and formatted as YYYY-MM-DDTHH:MM:SSSSSSSZ. |\r\n| AccountId | Your Buildium account identifier. This is used to distinguish between accounts if you have configured webhook callbacks across multiple Buildium accounts to the same endpoint. |\r\n| Entity Identifier(s) | These field(s) constitute the identifier of the entity. Use these values to query the Buildium Open API for the full entity data. |\r\n\r\nHere is an example of an Event object, serialized as JSON, when a rental property has been updated:\r\n```json\r\n{\r\n\"EventName\": \"Rental.Updated\",\r\n\"EventDateTime\": \"2022-05-10T15:12:46.2317653Z\",\r\n\"AccountId\": 123456,\r\n\"PropertyId\": 23\r\n}\r\n```\r\n\r\nNote that the EventName is a constant value that can be used to determine the entity and the operation that triggered the event. This value is concatenation of the entity name and operation separated by a period. For example, if a rental property was updated the EventName value would be: `Rental.Updated`.\r\n\r\nThe event identifiers included in the Event object will provide the data necessary to query the Buildium Open API and retrieve the full entity.\r\n\r\nThe [Webhook Events section](#section/Webhooks/Webhook-Events) below lists all of the available entities and their corresponding events that can be subscribed to. The grid also includes the EventName constants and sample JSON for each entity.\r\n\r\n## Receiving Callbacks\r\nTo take advantage of webhooks you’ll need to establish an endpoint that our Buildium servers can make a request to whenever the data you’re interested in changes. You can use one endpoint to handle several different event types at once or set up individual endpoints for specific events.\r\n\r\nYour endpoint must be implemented to support the following:\r\n * HTTPS protocol\r\n * Be publicly available\r\n * POST requests that consist of a JSON formatted payload sent as raw body type and a Content-Type of application/json.\r\n\r\nWhen receiving webhook callbacks it is important that your endpoint responds promptly. If Buildium doesn’t receive a response within 10 seconds the callback is considered unsuccessful. As a best practice your endpoint should return a response prior to executing any complex logic to ensure a response within the 10 second duration. Any HTTP response code from your endpoint other than a 2XX is also considered an unsuccessful request. Buildium will retry unsuccessful events on the following intervals:\r\n 1. 1 minute\r\n 2. 10 minutes\r\n 3. 1 hour\r\n\r\nIf a callback for an event is unsuccessful after all three attempts Buildium will stop attempting to send the event message.\r\n\r\nThe webhook subscription will be suspended if there 20 consecutive failed attempts to send events to the URL. Upon suspension an email will be sent notifying you that the subscription has been paused. You can troubleshoot issues and enable the webhook by browsing to [Settings > Developer Tools > Webhooks](https://signin.managebuilding.com/manager/app/settings/developer-tools/webhooks). The email is sent to the contact email address that is set when the webhook subscription is created or updated.\r\n\r\nAs you develop the callback endpoint you can use the JSON examples found in the webhook event grid to generate the mock payloads for testing. Once you are able to successfully receive the event callback you should implement a signature check to ensure the authenticity of of the request.\r\n\r\n### Signature Checks\r\nIt is *strongly recommended* that you validate webhook event signatures in your application to ensure that the request came from Buildium and not a bad actor attempting to impersonate Buildium, alter event messages after they have been sent, or perform replay attacks. While validating the request isn’t required to read the payload, it is *strongly recommended* to ensure the authenticity of the request and ensure the overall security and data integrity of your application.\r\n\r\nAll webhook callback requests include the signature and a timestamp in the HTTP headers.\r\n\r\n| HTTP Header | Description |\r\n| ---- | ---- |\r\n| buildium-webhook-timestamp | A UNIX timestamp of when the message was sent. NOTE: This is not the time the event occurred within the system, but rather the time the event was sent.|\r\n| buildium-webhook-signature | A computed signature using the secret key that can be used to verify that the request came from Buildium. The secret key is generated when the webhook subscription is created.|\r\n\r\nThe signature is a concatenation of the timestamp value and the event message hashed by a secret key. The secret key is generated for you when creating webhook subscriptions. It is important to keep this key stored safely as you would with any other credentials.\r\n\r\nThe following steps outline how to use the secret key, the event message and the HTTP header values to verify the request:\r\n\r\n 1. Concatenate the value of the buildium-webhook-timestamp header with the body of the event with a period character in between the two values. The body of the event must have all newlines removed and not contain spaces after the colon between property names and values. For example\r\n```json\r\n{\r\n \"EventName\": \"Rental.Created\",\r\n \"EventDateTime\": \"2022-12-22T16:18:20.876772Z\",\r\n \"AccountId\": 123456,\r\n \"PropertyId\": 78910\r\n}\r\n```\r\nwould be passed into your verification method as:\r\n```json\r\n{\"EventName\":\"Rental.Created\",\"EventDateTime\":\"2022-12-22T16:18:20.876772Z\",\"AccountId\":123456,\"PropertyId\":78910}\r\n```\r\n 2. Hash the concatenated string using the HMACSHA256 algorithm setting the webhook secret key as the algorithm key.\r\n 3. Convert the resulting hash bytes to a base64 string.\r\n 4. Compare the base64 string to the value of the buildium-webhook-signature header. If the values match with a case sensitive comparison, the message has been validated to have come from Buildium.\r\n\r\n### Sample Validation Code (C#)\r\n```c#\r\nprivate static bool ClientSideValidate(\r\nstring eventNotificationMessage, \r\nstring timestamp, \r\nstring signature)\r\n{\r\n var signedPayload = $\"{timestamp}.{eventNotificationMessage}\";\r\n var hasher = new HMACSHA256(Encoding.UTF8.GetBytes(m_secretKey));\r\n var computedHash = hasher.ComputeHash(Encoding.UTF8.GetBytes(signedPayload));\r\n var computedHashString = Convert.ToBase64String(computedHash);\r\n\r\n return computedHashString.Equals(signature);\r\n}\r\n```\r\nOnce you’ve successfully validated the message you can begin to process it with confidence it came from the Buildium platform and has not been altered after it has been sent.\r\n\r\nTo test your validation logic you can generate requests to your URL with headers you generate using the similar logic you created for validating the values.\r\n\r\n## Webhook Creation\r\nOnce your endpoint is ready to be tested end to end you will need to create a webhook subscription in your Buildium account. The subscription can be created by browsing to [Settings > Developer Tools > Webhooks](https://signin.managebuilding.com/manager/app/settings/developer-tools/webhooks) and then clicking the “Add webhook” button.\r\n\r\nOnce you’ve configured a new webhook, events will be sent to your endpoint as they are triggered within the account. So all you have to do is execute the action you want to test. You can expect webhook callbacks to your endpoint to fire within a few seconds to a few minutes from the event occurring in the Buildium platform. To determine if the events have been sent and/or see the resulting response from your platform you can view the webhook subscription event history page.\r\n\r\nWe strongly suggest you test your webhooks in your Buildium API sandbox account to ensure you don’t corrupt data in your production account. Once the integration is fully tested you can register the webhook in your production account.\r\n\r\n> NOTE: Due to our current security policies we do not support webhook callbacks to the Ngrok platform. We understand Ngrok can be useful for testing local webhook development and we hope to be able to support that platform safely and securely soon. In the meantime, we recommend using other websites and tools that can capture the webhook event HTTP request payload and headers and replay it manually on your local machine with a tool such as Postman.\r\n\r\n## Best Practices\r\n* Be sure to validate the signature on all incoming requests and consider rolling your secret keys on a regular basis. A new secret key can be generated by clicking the \"Generate key\" link next to the current secret key value when updating the webhook subscription.\r\n* Your webhook endpoints should be configured to receive only the types of events required by your integration. Listening for extra events (or all events) will put undue strain on your server and is not recommended.\r\n* Be sure your platform can handle duplicate events correctly. We do our best to ensure an event is only sent one time, but due to the distributed nature of the process we can not make any guarantees. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events.\r\n* Buildium does not guarantee delivery of events in the order in which they are generated within the platform. For example, creating a lease might generate the following events - `Lease.Created`, `Tenant.Created`. Your endpoint shouldn’t expect delivery of these events in this order and should handle this accordingly. You can use the API to fetch any missing data. For example, you can fetch the lease resource using the information from tenant if you happen to receive that event first.\r\n\r\n## Webhook Events\r\nThe grid below details the available webhooks events along with their EventName and JSON message schema.\r\n\r\n![](\"file-upload-example.png\")