Accounting · Cash Movement
Bank Feed
Every movement the bank has reported, what it was accounted for as, and what in the ledger it matches. A movement delivered twice is the same row.
/api/accounting/bank-transactionsPublished as /api/v1/bank-transactionsOverview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › Bank Feed on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.bank_transactions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
9 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/bank-transactionsList bank feed
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"statement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"external_id": "text",
"posted_date": "2026-10-30",
"value_date": "2026-10-30",
"direction": "text",
"amount": "1250.00",
"running_balance": "1250.00",
"currency": "USD",
"description": "text",
"counterparty": "text",
"counterparty_account": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/bank-transactions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/bank-transactions/{id}Read one bank transactions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"statement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"external_id": "text",
"posted_date": "2026-10-30",
"value_date": "2026-10-30",
"direction": "text",
"amount": "1250.00",
"running_balance": "1250.00",
"currency": "USD",
"description": "text",
"counterparty": "text",
"counterparty_account": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/bank-transactionsCreate a bank transactions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
category | text | No | Category |
gl_account_id | uuid | No | Account it belongs to |
cost_center_id | uuid | No | Cost center |
match_status | text | No | Match status |
Sample body
{
"category": "text",
"gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"match_status": "draft"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"statement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"external_id": "text",
"posted_date": "2026-10-30",
"value_date": "2026-10-30",
"direction": "text",
"amount": "1250.00",
"running_balance": "1250.00",
"currency": "USD",
"description": "text",
"counterparty": "text",
"counterparty_account": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/bank-transactions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"category":"text","gl_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","cost_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","match_status":"draft"}'PUT/api/accounting/bank-transactions/{id}Change a bank transactions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
category | text | No | Category |
gl_account_id | uuid | No | Account it belongs to |
cost_center_id | uuid | No | Cost center |
match_status | text | No | Match status |
Sample body
{
"category": "text",
"gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"statement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"external_id": "text",
"posted_date": "2026-10-30",
"value_date": "2026-10-30",
"direction": "text",
"amount": "1250.00",
"running_balance": "1250.00",
"currency": "USD",
"description": "text",
"counterparty": "text",
"counterparty_account": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"category":"text","gl_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/bank-transactions/{id}Delete a bank transactions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/bank-transactions/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/accounting/bank-transactions/{id}/matchMatch
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
allowDifference, apPaymentId, arReceiptId, journalId, ignoreResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"allowDifference":"value","apPaymentId":"value","arReceiptId":"value","journalId":"value","ignore":"value"}'POST/api/accounting/bank-transactions/{id}/unmatchUnmatch
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/unmatch" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/bank-transactions/{id}/postPost
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
glAccountId*, costCenterId, fundIdResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/bank-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"glAccountId":"value","costCenterId":"value","fundId":"value"}'Data model
Every field of a bank transactions, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
bank_account_id | uuid | read only | Bank account id |
connection_id | uuid | read only | Connection id |
statement_id | uuid | read only | Statement id |
external_id | text | read only | External id |
posted_date | date | read only | Posted date |
value_date | date | read only | Value date |
direction | text | read only | Direction |
amount | numeric | read only | Amount |
running_balance | numeric | read only | Running balance |
currency | text | read only | Currency |
description | text | read only | Description |
counterparty | text | read only | Counterparty |
counterparty_account | text | read only | Counterparty account |
bank_reference | text | read only | Bank reference |
customer_reference | text | read only | Customer reference |
check_no | text | read only | Check no |
bai_code | text | read only | Bai code |
transaction_code | text | read only | Transaction code |
category | text | read, write | Category |
gl_account_id | uuid | read, write | Account it belongs to |
cost_center_id | uuid | read, write | Cost center |
matched_rule_id | uuid | read only | Matched rule id |
match_status | text | read, write | Match status |
match_confidence | numeric | read only | Match confidence |
ap_payment_id | uuid | read only | Ap payment id |
ar_receipt_id | uuid | read only | Ar receipt id |
journal_id | uuid | read only | Journal id |
reconciliation_id | uuid | read only | Reconciliation id |
status | text | read only | Status |
raw | jsonb | read only | Raw |
received_at | timestamp with time zone | read only | Received at |
seq | bigint | read only | Seq |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Bank Feed for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.