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.
/api/scm/invoice-capturesPublished as /api/v1/invoice-capturesDownload specification (OpenAPI 3.1) Screen: Invoice Capture
Overview
| Package | Supply Chain |
|---|---|
| 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 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. |
| Table | scm.invoice_captures · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; 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/scm/invoice-capturesList invoice capture
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",
"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_id | uuid | No | Supplier |
invoice_no | text | No | Invoice number |
invoice_date | date | No | Invoice date |
due_date | date | No | Due date |
currency | text | No | Currency |
subtotal | numeric | No | Subtotal |
tax | numeric | No | Tax |
total | numeric | No | Total |
po_reference | text | No | Order quoted |
po_id | uuid | No | Order |
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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_id | uuid | No | Supplier |
invoice_no | text | No | Invoice number |
invoice_date | date | No | Invoice date |
due_date | date | No | Due date |
currency | text | No | Currency |
subtotal | numeric | No | Subtotal |
tax | numeric | No | Tax |
total | numeric | No | Total |
po_reference | text | No | Order quoted |
po_id | uuid | No | Order |
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
| Name | Type | Description |
|---|---|---|
id | string (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
| 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/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|apiResponse
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
| 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):
priceTolerancePct, quantityTolerancePctResponse
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
| 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/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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
capture_no | text | read only | Capture no |
source | text | read only | Source |
file_name | text | read only | File name |
content_hash | text | read only | Content hash |
provider | text | read only | Provider |
model | text | read only | Model |
extraction | jsonb | read only | Extraction |
confidence | numeric | read only | Confidence |
supplier_id | uuid | read, write | Supplier |
supplier_name_raw | text | read only | Supplier name raw |
invoice_no | text | read, write | Invoice number |
invoice_date | date | read, write | Invoice date |
due_date | date | read, write | Due date |
currency | text | read, write | Currency |
subtotal | numeric | read, write | Subtotal |
tax | numeric | read, write | Tax |
total | numeric | read, write | Total |
po_reference | text | read, write | Order quoted |
po_id | uuid | read, write | Order |
ap_invoice_id | uuid | read only | Ap invoice id |
status | text | read only | Status |
exceptions | jsonb | read only | Exceptions |
reviewed_by | uuid | read only | Reviewed by |
reviewed_at | timestamp with time zone | read only | Reviewed at |
captured_at | timestamp with time zone | read only | Captured at |
org_unit_id | uuid | read only | Org unit id |
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 |
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 |
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 Supply Chain › Invoice Capture 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.