TRANXACT.AI Help

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.

Type REST9 operationsBase path /api/accounting/cash-applicationsPublished as /api/v1/cash-applications

Download specification (OpenAPI 3.1) Screen: Cash Application

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.cash_applications · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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):

bankAccountId

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/run" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"bankAccountId":"value"}'
POST/api/accounting/cash-applications/{id}/applyApply

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

amount

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/apply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount":"value"}'
POST/api/accounting/cash-applications/{id}/rejectReject

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
bank_transaction_iduuidread onlyBank transaction id
ar_invoice_iduuidread onlyAr invoice id
amountnumericread onlyAmount
confidencenumericread onlyConfidence
reasonsjsonbread onlyReasons
statustextread onlyStatus
ar_receipt_iduuidread onlyAr receipt id
applied_viatextread onlyApplied via
applied_attimestamp with time zoneread onlyApplied at
applied_byuuidread onlyApplied by
decided_reasontextread onlyDecided reason
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Cash Application for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.