TRANXACT.AI Help

Accounting · Travel & Expense

Receipts

A receipt arrives before the claim — photographed at the restaurant. What was read off it is kept apart from what was typed so a mismatch is visible, and the image fingerprint is the cheapest duplicate check there is.

Type REST8 operationsBase path /api/accounting/expense-receiptsPublished as /api/v1/expense-receipts

Download specification (OpenAPI 3.1) Screen: Receipts

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 › Receipts 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.
Tablescm.expense_receipts · 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

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

GET/api/accounting/expense-receiptsList receipts

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",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "uploaded_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "file_name": "Example",
      "file_url": "https://example.com",
      "mime_type": "text",
      "file_size": 10,
      "content_hash": "text",
      "extracted_merchant": "text",
      "extracted_date": "2026-10-30",
      "extracted_amount": "1250.00",
      "extracted_currency": "USD",
      "extracted_tax": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uploaded_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "file_url": "https://example.com",
  "mime_type": "text",
  "file_size": 10,
  "content_hash": "text",
  "extracted_merchant": "text",
  "extracted_date": "2026-10-30",
  "extracted_amount": "1250.00",
  "extracted_currency": "USD",
  "extracted_tax": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/expense-receipts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expense-receiptsCreate a receipt

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidNoClaimant
uploaded_byuuidNoUploaded by
file_nametextNoFile name
file_urltextNoFile
mime_typetextNoType
file_sizeintegerNoFile size
content_hashtextNoContent hash — Two byte-identical images are the same receipt claimed twice.
extracted_merchanttextNoMerchant read from it
extracted_datedateNoDate read from it
extracted_amountnumericNoAmount read from it
extracted_currencytextNoCurrency read from it
extracted_taxnumericNoTax read from it
extracted_tax_notextNoTax number read from it — Without it an authority may refuse the reclaim.
extraction_confidencenumericNoExtraction confidence
extraction_enginetextNoExtracted by
raw_texttextNoRaw text
line_iduuidNoClaim line

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uploaded_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "file_url": "https://example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uploaded_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "file_url": "https://example.com",
  "mime_type": "text",
  "file_size": 10,
  "content_hash": "text",
  "extracted_merchant": "text",
  "extracted_date": "2026-10-30",
  "extracted_amount": "1250.00",
  "extracted_currency": "USD",
  "extracted_tax": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/expense-receipts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","uploaded_by":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","file_name":"Example","file_url":"https://example.com"}'
PUT/api/accounting/expense-receipts/{id}Change a receipt

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
employee_iduuidNoClaimant
uploaded_byuuidNoUploaded by
file_nametextNoFile name
file_urltextNoFile
mime_typetextNoType
file_sizeintegerNoFile size
content_hashtextNoContent hash — Two byte-identical images are the same receipt claimed twice.
extracted_merchanttextNoMerchant read from it
extracted_datedateNoDate read from it
extracted_amountnumericNoAmount read from it
extracted_currencytextNoCurrency read from it
extracted_taxnumericNoTax read from it
extracted_tax_notextNoTax number read from it — Without it an authority may refuse the reclaim.
extraction_confidencenumericNoExtraction confidence
extraction_enginetextNoExtracted by
raw_texttextNoRaw text
line_iduuidNoClaim line

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uploaded_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uploaded_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "file_url": "https://example.com",
  "mime_type": "text",
  "file_size": 10,
  "content_hash": "text",
  "extracted_merchant": "text",
  "extracted_date": "2026-10-30",
  "extracted_amount": "1250.00",
  "extracted_currency": "USD",
  "extracted_tax": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/expense-receipts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","uploaded_by":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/accounting/expense-receipts/{id}Delete a receipt

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/expense-receipts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expense-receipts/{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/expense-receipts/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/expense-receipts/{id}/match-lineMatch line

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/expense-receipts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match-line" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expense-receipts/{id}/verifyVerify

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/expense-receipts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a receipt, 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
employee_iduuidread, writeClaimant
uploaded_byuuidread, writeUploaded by
file_nametextread, writeFile name
file_urltextread, writeFile
mime_typetextread, writeType
file_sizeintegerread, writeFile size
content_hashtextread, writeContent hash — Two byte-identical images are the same receipt claimed twice.
extracted_merchanttextread, writeMerchant read from it
extracted_datedateread, writeDate read from it
extracted_amountnumericread, writeAmount read from it
extracted_currencytextread, writeCurrency read from it
extracted_taxnumericread, writeTax read from it
extracted_tax_notextread, writeTax number read from it — Without it an authority may refuse the reclaim.
extraction_confidencenumericread, writeExtraction confidence
extraction_enginetextread, writeExtracted by
extracted_attimestamp with time zoneread onlyExtracted at
raw_texttextread, writeRaw text
line_iduuidread, writeClaim line
statustextread onlyStatus
match_variancenumericread onlyMatch variance
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 › Receipts 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.