Create a bank account
Registers a bank account and returns it, active. Leave chartOfAccountIds out and an asset chart-of-account entry named "Bank: {name}" is created for it. Requires the bank_accounts:write permission.
Authorization
AuthorizationstringrequiredBody
application/json
accountNumber and routingNumber are optional, but once stored neither can be changed — nor can type. Supply them only when you have the real values.
namestringrequiredDisplay name, 1 to 200 characters.
descriptionstringFree-text note, up to 1000 characters.
accountNumberstringThe bank account number: 4 to 17 digits, no separators. Rejected with 400 otherwise.
routingNumberstringThe nine-digit ABA routing number. Its check digit is verified, so a made-up number is rejected with 400.
typeenum<string>What kind of account this is at the bank.
companyAccountbooleanSet true when the money belongs to the management company itself rather than to owners or tenants. This cannot be changed afterwards.
scheduledSweepDaysinteger[]Days of the month, 1 to 31, on which a sweep is scheduled. Duplicates are rejected with 400.
chartOfAccountIdsstring[]Snowflake ids of existing asset chart-of-account entries to post this account's cash side to. Every id must be an asset account in the same company. Omit the field and one is created automatically.
Response
200 · The bank account that was created. It starts active.
idstringSnowflake id of the bank account.
createdstring · date-timeWhen the bank account was created, in the company's timezone.
updatedstring · date-timeWhen the bank account was last changed, in the company's timezone.
namestringThe name property managers see in account pickers, for example "Operating — Chase".
descriptionstringFree-text note about the account. Absent when none was set.
accountNumberstringThe bank account number, 4 to 17 digits. Absent when the account was created without one.
routingNumberstringThe nine-digit ABA routing number. Absent when the account was created without one.
typeenum<string>What kind of account this is at the bank. Absent when it was never set.
companyAccountbooleantrue when the money in this account belongs to the management company itself rather than to owners or tenants. Fixed at creation; no endpoint changes it.
activebooleanfalse after a deactivate call. An inactive account stays readable and keeps its history, and its routing and account number no longer block another account from using the same pair.
scheduledSweepDaysinteger[]Days of the month, 1 to 31, on which a sweep is scheduled for this account. Empty when no sweep is scheduled.
chartOfAccountIdsstring[]Snowflake ids of the asset chart-of-account entries this bank account posts its cash side to. Always at least one.
creatorobjectWho last touched the bank account. Deprecated mirrors of id — propertyManagerId, tenantId, vendorId, ownerId — are also present, whichever matches type.