TRANXACT.AI Help

Supply Chain · Invoices & Payment

Invoice Capture

An invoice however it arrived — scanned, emailed, EDI or keyed. Capture finds the supplier and the order, and flags a duplicate before it becomes a double payment.

Type REST9 operationsBase path /api/scm/invoice-capturesPublished as /api/v1/invoice-captures

Download specification (OpenAPI 3.1) Screen: Invoice Capture

Overview

PackageSupply Chain
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 Supply Chain › Invoice Capture 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.invoice_captures · 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

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

GET/api/scm/invoice-capturesList invoice capture

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",
      "capture_no": "CAP-000001",
      "source": "text",
      "file_name": "Example",
      "content_hash": "text",
      "provider": "text",
      "model": "text",
      "extraction": {},
      "confidence": "1250.00",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_name_raw": "Example",
      "invoice_no": "INV-000001",
      "invoice_date": "2026-10-30",
      "due_date": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/invoice-captures?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/invoice-captures/{id}Read one invoice captures

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "capture_no": "CAP-000001",
  "source": "text",
  "file_name": "Example",
  "content_hash": "text",
  "provider": "text",
  "model": "text",
  "extraction": {},
  "confidence": "1250.00",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_name_raw": "Example",
  "invoice_no": "INV-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/invoice-captures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/invoice-capturesCreate a invoice captures

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidNoSupplier
invoice_notextNoInvoice number
invoice_datedateNoInvoice date
due_datedateNoDue date
currencytextNoCurrency
subtotalnumericNoSubtotal
taxnumericNoTax
totalnumericNoTotal
po_referencetextNoOrder quoted
po_iduuidNoOrder

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "invoice_no": "INV-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "capture_no": "CAP-000001",
  "source": "text",
  "file_name": "Example",
  "content_hash": "text",
  "provider": "text",
  "model": "text",
  "extraction": {},
  "confidence": "1250.00",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_name_raw": "Example",
  "invoice_no": "INV-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/invoice-captures" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","invoice_no":"INV-000001","invoice_date":"2026-10-30","due_date":"2026-10-30"}'
PUT/api/scm/invoice-captures/{id}Change a invoice captures

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
supplier_iduuidNoSupplier
invoice_notextNoInvoice number
invoice_datedateNoInvoice date
due_datedateNoDue date
currencytextNoCurrency
subtotalnumericNoSubtotal
taxnumericNoTax
totalnumericNoTotal
po_referencetextNoOrder quoted
po_iduuidNoOrder

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "invoice_no": "INV-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "capture_no": "CAP-000001",
  "source": "text",
  "file_name": "Example",
  "content_hash": "text",
  "provider": "text",
  "model": "text",
  "extraction": {},
  "confidence": "1250.00",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_name_raw": "Example",
  "invoice_no": "INV-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/invoice-captures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","invoice_no":"INV-000001"}'
DELETE/api/scm/invoice-captures/{id}Delete a invoice captures

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/scm/invoice-captures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/invoice-captures/{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/scm/invoice-captures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/scm/invoice-captures/captureCapture

Request body

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

source, fileName, supplierName, invoiceNo*, invoiceDate, dueDate, currency, subtotal, tax, total, poReference, lines, confidence; source one of upload|email|scan|edi|portal|api

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/scm/invoice-captures/capture" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"source":"value","fileName":"value","supplierName":"value","invoiceNo":"value","invoiceDate":"value","dueDate":"value"}'
POST/api/scm/invoice-captures/{id}/matchMatch

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):

priceTolerancePct, quantityTolerancePct

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/scm/invoice-captures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"priceTolerancePct":"value","quantityTolerancePct":"value"}'
POST/api/scm/invoice-captures/{id}/postPost

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/scm/invoice-captures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a invoice captures, 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
capture_notextread onlyCapture no
sourcetextread onlySource
file_nametextread onlyFile name
content_hashtextread onlyContent hash
providertextread onlyProvider
modeltextread onlyModel
extractionjsonbread onlyExtraction
confidencenumericread onlyConfidence
supplier_iduuidread, writeSupplier
supplier_name_rawtextread onlySupplier name raw
invoice_notextread, writeInvoice number
invoice_datedateread, writeInvoice date
due_datedateread, writeDue date
currencytextread, writeCurrency
subtotalnumericread, writeSubtotal
taxnumericread, writeTax
totalnumericread, writeTotal
po_referencetextread, writeOrder quoted
po_iduuidread, writeOrder
ap_invoice_iduuidread onlyAp invoice id
statustextread onlyStatus
exceptionsjsonbread onlyExceptions
reviewed_byuuidread onlyReviewed by
reviewed_attimestamp with time zoneread onlyReviewed at
captured_attimestamp with time zoneread onlyCaptured at
org_unit_iduuidread onlyOrg unit id
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_attimestamp with time zoneread onlyCreated at
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 Supply Chain › Invoice Capture 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.