Accounting · Finance Automation
Cash Application
Bank receipts matched to the open customer invoices they pay, by the invoice number in the remittance, the customer and the amount. Those at or above the company's confidence threshold are applied when its autonomy level allows; the rest wait here with a suggestion for a person to apply or turn down.
/api/accounting/cash-applicationsPublished as /api/v1/cash-applicationsDownload specification (OpenAPI 3.1) Screen: Cash Application
Overview
| 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 › Cash Application 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.cash_applications · kept per company (and organisational unit where it has one) |
| Record | Read only; 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/cash-applicationsList cash application
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_transaction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"confidence": "1250.00",
"reasons": {},
"status": "draft",
"ar_receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"applied_via": "text",
"applied_at": "2026-10-30T09:00:00Z",
"applied_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"decided_reason": "text",
"created_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/cash-applications?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/cash-applications/{id}Read one cash application
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bank_transaction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"amount": "1250.00",
"confidence": "1250.00",
"reasons": {},
"status": "draft",
"ar_receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"applied_via": "text",
"applied_at": "2026-10-30T09:00:00Z",
"applied_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"decided_reason": "text",
"created_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/cash-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/cash-applications/runRun
Request body
The keys this action reads (* = required; "one of" lists the only values):
bankAccountIdResponse
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/cash-applications/run" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"bankAccountId":"value"}'POST/api/accounting/cash-applications/{id}/applyApply
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):
amountResponse
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/cash-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/apply" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"amount":"value"}'POST/api/accounting/cash-applications/{id}/rejectReject
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/cash-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/cash-applicationsPost cash application
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/cash-applications" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/cash-applications/{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/cash-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/accounting/cash-applications/{id}Put cash application
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 PUT "https://demo.tranxact.ai/api/accounting/cash-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/cash-applications/{id}Delete cash application
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 DELETE "https://demo.tranxact.ai/api/accounting/cash-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a cash application, 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 |
org_unit_id | uuid | read only | Org unit id |
bank_transaction_id | uuid | read only | Bank transaction id |
ar_invoice_id | uuid | read only | Ar invoice id |
amount | numeric | read only | Amount |
confidence | numeric | read only | Confidence |
reasons | jsonb | read only | Reasons |
status | text | read only | Status |
ar_receipt_id | uuid | read only | Ar receipt id |
applied_via | text | read only | Applied via |
applied_at | timestamp with time zone | read only | Applied at |
applied_by | uuid | read only | Applied by |
decided_reason | text | read only | Decided reason |
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 |
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 |
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 › Cash Application 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.