The Bank Account object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Bank Accounts endpoint, you can retrieve a list of all bank-accounts for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the bank account, unique for the business in the accounting service. |
| nominalCode sortable, filterable | string | The nominal code of the bank account used to classify accounts by department or account type. |
| name sortable, filterable | string | Name of the bank account in the accounting service. |
| accountType sortable, filterable | string | The bank account type. |
| accountNumber sortable, filterable | string | Account number for the bank account. For privacy and security, Account numbers that are 6 digits or less: all but the last 2 digits are masked Account numbers that are 7 digits or longer: all but the last 4 digits are masked |
| routingNumber sortable, filterable | string | Routing number for the bank associated with the account. For privacy and security, we only display the last four digits of the routing number. |
| bankCode sortable, filterable | string | Bank code of the bank account. Can have the same value as routingNumber for certain countries, e.g. US. |
| iBan sortable, filterable | string | International bank account number of the account. Often used when making or receiving international payments. |
| institutionName sortable, filterable | string | Bank account institution |
| currency sortable, filterable | string | ISO-4217 currency code of the bank account. |
| currentBalance sortable, filterable | decimal | Balance of the bank account. |
| overdraftLimit sortable, filterable | decimal | Pre-arranged overdraft limit of the account. The value is always positive. For example, an overdraftLimit of 1000 means that the balance of the account can go down to -1000. |
| availableBalance sortable, filterable | decimal | Total available balance of the bank account as reported by the data source in the accounting service. This may take into account overdrafts or pending transactions for example. |
| isActive sortable, filterable | boolean | Specifies whether the Bank account is an active account or not. |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |