Update a bank account
Changes the fields you send and leaves the rest alone. Requires the bank_accounts:write permission.
Authorization
AuthorizationstringrequiredPath parameters
bankAccountIdstringrequiredSnowflake id of the bank account.
Body
application/json
Only the fields present in the body are applied. accountNumber, routingNumber and type are write-once: if the account already has a value the one you send is silently ignored, so they can only ever be filled in, never corrected. chartOfAccountIds replaces the whole list rather than adding to it.
namestringDisplay name, 1 to 200 characters.
descriptionstringFree-text note, up to 1000 characters.
accountNumberstringThe bank account number: 4 to 17 digits. Applied only if the account does not already have one.
routingNumberstringThe nine-digit ABA routing number, check digit verified. Applied only if the account does not already have one.
typeenum<string>Applied only if the account does not already have a type.
scheduledSweepDaysinteger[]Replaces the sweep days. Values 1 to 31, no duplicates.
chartOfAccountIdsstring[]Replaces the linked asset chart-of-account entries. Every id must be an asset account in the same company. An entry can only be dropped if no transaction on this bank account uses it and neither the rent nor the deposit payment settings still point at the pair.
Response
200 · The bank account after the change. Sending a body with no fields returns it unchanged.
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.