TRANXACT.AI Help

Accounting · Financial Controls

Account Reconciliations

Ageing the reconciling items is the whole discipline: a difference that has been there for eleven months is not a timing difference.

Type REST10 operationsBase path /api/accounting/account-reconciliationsPublished as /api/v1/account-reconciliations

Download specification (OpenAPI 3.1) Screen: Account Reconciliations

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 › Account Reconciliations 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.account_reconciliations · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/account-reconciliationsList account reconciliations

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",
      "recon_no": "REC-000001",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "close_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_code": "PER-000001",
      "as_of_date": "2026-10-30",
      "currency": "USD",
      "gl_balance": "1250.00",
      "supporting_balance": "1250.00",
      "difference": "1250.00",
      "explained_amount": "1250.00",
      "unexplained_amount": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/account-reconciliations?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/account-reconciliations/{id}Read one account reconciliation

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",
  "recon_no": "REC-000001",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "close_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "currency": "USD",
  "gl_balance": "1250.00",
  "supporting_balance": "1250.00",
  "difference": "1250.00",
  "explained_amount": "1250.00",
  "unexplained_amount": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/account-reconciliationsCreate a account reconciliation

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
gl_account_iduuidYesGl account id
policy_iduuidNoPolicy id
close_run_iduuidNoClose run id
period_codetextYesPeriod code
as_of_datedateYesAs of date
currencytextNoCurrency
gl_balancenumericNoGl balance
supporting_balancenumericNoSupporting balance
explained_amountnumericNoExplained amount
unexplained_amountnumericNoUnexplained amount
oldest_item_daysintegerNoOldest item days
due_datedateNoDue date
evidence_urltextNoEvidence url
notestextNoNotes

Sample body

{
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "close_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "gl_balance": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recon_no": "REC-000001",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "close_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "currency": "USD",
  "gl_balance": "1250.00",
  "supporting_balance": "1250.00",
  "difference": "1250.00",
  "explained_amount": "1250.00",
  "unexplained_amount": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/account-reconciliations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"gl_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_code":"PER-000001","as_of_date":"2026-10-30","policy_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","close_run_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","currency":"USD","gl_balance":"1250.00"}'
PUT/api/accounting/account-reconciliations/{id}Change a account reconciliation

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
gl_account_iduuidYesGl account id
policy_iduuidNoPolicy id
close_run_iduuidNoClose run id
period_codetextYesPeriod code
as_of_datedateYesAs of date
currencytextNoCurrency
gl_balancenumericNoGl balance
supporting_balancenumericNoSupporting balance
explained_amountnumericNoExplained amount
unexplained_amountnumericNoUnexplained amount
oldest_item_daysintegerNoOldest item days
due_datedateNoDue date
evidence_urltextNoEvidence url
notestextNoNotes

Sample body

{
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recon_no": "REC-000001",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "close_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "currency": "USD",
  "gl_balance": "1250.00",
  "supporting_balance": "1250.00",
  "difference": "1250.00",
  "explained_amount": "1250.00",
  "unexplained_amount": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"gl_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_code":"PER-000001"}'
DELETE/api/accounting/account-reconciliations/{id}Delete a account reconciliation

Path parameters

NameTypeDescription
idstring (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/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/account-reconciliations/{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/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/accounting/account-reconciliations/{parentId}/itemsItems

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/account-reconciliations/{parentId}/itemsItems

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/account-reconciliations/{parentId}/items/{lineId}Items

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/account-reconciliations/{parentId}/items/{lineId}Items

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/account-reconciliations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a account reconciliation, 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
recon_notextread onlyRecon no
gl_account_iduuidread, writeGl account id
policy_iduuidread, writePolicy id
close_run_iduuidread, writeClose run id
period_codetextread, writePeriod code
as_of_datedateread, writeAs of date
currencytextread, writeCurrency
gl_balancenumericread, writeGl balance
supporting_balancenumericread, writeSupporting balance
differencenumericread onlyDifference
explained_amountnumericread, writeExplained amount
unexplained_amountnumericread, writeUnexplained amount
oldest_item_daysintegerread, writeOldest item days
statustextread onlyStatus
prepared_byuuidread onlyPrepared by
prepared_attimestamp with time zoneread onlyPrepared at
reviewed_byuuidread onlyReviewed by
reviewed_attimestamp with time zoneread onlyReviewed at
due_datedateread, writeDue date
evidence_urltextread, writeEvidence url
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Account Reconciliations 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.