The Bank Transaction object
From the Bank Transactions endpoint, you can retrieve and refresh 24 months of historical bank transaction data, including geolocation, merchant, and category information.
| Field | Type | Description |
|---|---|---|
| id sortable, _filterable | string | Identifier 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 | string | The bank transaction type. |
| accountRef sortable, _filterable | Reference Types | Reference 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. |
| currency | string | ISO-4217 currency code of the transaction. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| isReconciled sortable, _filterable | boolean | Specifies whether a transaction has been reconciles in the accounting service or not. |
| totalAmount sortable, _filterable | decimal | Total amount of the transaction. |
| entityRef | Reference Types | Reference to the customer/vendor the line item is linked to. |
| lines | array | An array of bank transaction line items. |
| memo | string | Any 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
| Field | Type | Description |
|---|---|---|
| id sortable, _filterable | string | Line item Id. |
| accountRef | Reference Types | Reference 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 | integer | Line item quantity. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
| taxAmount sortable, filterable | decimal | Line item tax amount. |
| amount sortable, filterable | decimal | Line item total amount, inclusive of tax. |
| trackingCategoryRefs | Reference Types | Reference to the tracking categories associated with this transaction, e.g. classes or departments. |