Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Bank Transactions

Retrieves a bank transaction

Fetches one bank transaction with counterparty text, amounts, and reconciliation flags used by cash teams during month-end. Use before update-a-bank-transaction to preserve memos or matched invoice references embedded in the payload.

get/bank-transactions/{bank_transaction_id}

Path parameters

bank_transaction_idstring required

UUID of the bank transaction to be used in this operation.

Response

OK

idstring uuid required
bank_account_idstring uuid required
subsidiary_idstring uuid required
datestring date required
namestring required

Transaction description

merchantstring required

Merchant or counterparty name

pendingboolean required

Whether the transaction is still pending

excludedboolean required

Whether the transaction is excluded from reconciliation

Example response

{
  "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"
    }
  ]
}