Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Bank Transactions

Lists all bank transactions

Streams imported or manually entered cash activity for reconciliation, optionally scoped by bank account, subsidiary, or updated-since filters. Pair results with retrieve-a-bank-transaction when you need memo-level detail before marking items cleared.

get/bank-transactions

Query parameters

bank_account_idstring uuid

Filter by bank account

subsidiary_idstring uuid

Subsidiary to be used when filtering data

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter bank transactions updated after this timestamp

date.gtestring date
Example:2023-01-01

Filter bank transactions with date on or after this date

date.ltestring date
Example:2023-12-31

Filter bank transactions with date on or before this date

sort_by'created' | 'updated'

Field to sort results by (see enum values).

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

Response

OK

Example response

{
  "bank_transactions": [
    {
      "net_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "fee": {
        "amount": "1.01",
        "currency": "USD"
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}