Bank Transfers

The Bank Transfer Object

From the Bank Transfers endpoint, you can retrieve all Bank Transfers recorded in the accounting service providers for a specified business.

FieldTypeDescription
id
sortable, filterable
string Identifier for the bank transfer, unique to the business in the accounting service provider.
date
sortable, filterable
string
See Date
Date of the bank transfer as recorded in the accounting service provider.
currencyRef Reference TypesCurrency of the bank transfer.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.
currencyRate decimalRate between the currency of the bank transfer and the base currency of the business. Not applicable when multi-currency is not supported.
fromAccountRefReference TypesReference to the account to which the bank transfer was sent from.

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 TypesReference to the account to which the bank transfer was sent to.

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
filterable
stringThe bank transaction id for the source account in the accounting service provider.
toBankTransactionId
filterable
stringThe bank transaction id for the destination account in the accounting service provider.
totalAmount
sortable, filterable
decimalAmount of the bank transfer.
memo stringUser-friendly reference for the bank transfer.
sourceModifiedDate
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.