The Bank Transfer 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 Transfers endpoint, you can retrieve all Bank Transfers recorded in the accounting service providers for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the bank transfer, unique for the business in the accounting service. |
| date sortable, filterable | string See Date | Date on which the bank transfer was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date. |
| currency | string | ISO-4217 currency code of the transfer. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| totalAmount sortable, filterable | decimal | Amount of the bank transfer. |
| fromAccountRef | Reference Types | Reference to the source account the bank transfer is recorded against. Pushing data requires a valid bank account reference. Query Accounts and use the id parameter of an account with isBankAccount=true as a value. |
| toAccountRef sortable, filterable | Reference Types | Reference to the destination account the bank transfer is recorded against. Pushing data requires a valid bank account reference. Query Accounts and use the id parameter of an account with isBankAccount=true as a value. |
| fromBankTransactionId sortable, filterable | string | Identifier of the source bank transaction account. |
| toBankTransactionId sortable, filterable | string | Identifier of the destination bank transaction account. |
| memo | string | Any additional information or business notes about the transfer. |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |