Bank Transactions (Accounting)

The Bank Transaction 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 Transactions endpoint, you can retrieve and refresh 24 months of historical bank transaction data, including geolocation, merchant, and category information.

FieldTypeDescription
id
sortable, _filterable
stringIdentifier for the bank transaction, unique for the business in the accounting service.
postedDate
sortable, _filterable
string
See Date
Date on which the transaction was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date.
transactionType
sortable, _filterable
stringThe bank transaction type.
accountRef
sortable, _filterable
Reference TypesReference to the account the transaction is recorded against. Query the Chart of Accounts endpoint to determine the appropriate Account object for this reference, where isBankAccount is true.
currencystringISO-4217 currency code of the transaction.
currencyRate decimalRate to convert the total amount of the transaction into the base currency for the business at the time of the transaction.
isReconciled
sortable, _filterable
booleanSpecifies whether a transaction has been reconciles in the accounting service or not.
totalAmount
sortable, _filterable
decimalTotal amount of the transaction.
entityRefReference TypesReference to the customer/vendor the line item is linked to.
linesarrayAn array of bank transaction line items.
memostringAny additional information or business notes about the transaction.
sourceModifiedDate
sortable, filterable
string
See Date
The date on which this record was last modified in the accounting service.

Lines

FieldTypeDescription
accountRefReference TypesReference to the account the line item is linked to.
description string Description of the line item.
unitAmount
sortable, filterable
decimal Line item unit amount.
quantity
sortable, filterable
integerLine item quantity.
taxRateRefReference TypesReference to the tax rate the line item is linked to.
taxAmount
sortable, filterable
decimalLine item tax amount.
amount
sortable, filterable
decimalLine item total amount, inclusive of tax.
trackingCategoryRefsReference TypesReference to the tracking categories associated with this transaction, e.g. classes or departments.