Accounting · Payables & Receivables
AR Invoices
Read and maintain ar invoices records (acct.ar_invoices).
/api/accounting/ar-invoicesPublished as /api/v1/ar-invoicesOverview
| Package | Accounting |
|---|---|
| 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 Accounting › AR Invoices 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 | acct.ar_invoices · 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
16 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/ar-invoicesList ar invoices
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",
"invoice_no": "INV-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_ref": "text",
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00",
"amount_paid": "1250.00",
"status": "draft"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/ar-invoices?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/ar-invoices/{id}Read one ar invoices
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",
"invoice_no": "INV-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_ref": "text",
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00",
"amount_paid": "1250.00",
"status": "draft"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-invoicesCreate a ar invoices
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
customer_account_id | uuid | No | Customer account id |
invoice_date | date | Yes | Invoice date |
due_date | date | Yes | Due date |
subtotal | numeric | No | Subtotal |
tax | numeric | No | Tax |
total | numeric | No | Total |
status | text | No | Status |
memo_reason | text | No | Memo reason |
invoice_subtype | text | No | Invoice subtype |
supply_date | date | No | Supply date |
supply_end_date | date | No | Supply end date |
Sample body
{
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"invoice_no": "INV-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_ref": "text",
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00",
"amount_paid": "1250.00",
"status": "draft"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/ar-invoices" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"invoice_date":"2026-10-30","due_date":"2026-10-30","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","subtotal":"1250.00","tax":"1250.00","total":"1250.00"}'PUT/api/accounting/ar-invoices/{id}Change a ar invoices
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 |
|---|---|---|---|
customer_account_id | uuid | No | Customer account id |
invoice_date | date | Yes | Invoice date |
due_date | date | Yes | Due date |
subtotal | numeric | No | Subtotal |
tax | numeric | No | Tax |
total | numeric | No | Total |
status | text | No | Status |
memo_reason | text | No | Memo reason |
invoice_subtype | text | No | Invoice subtype |
supply_date | date | No | Supply date |
supply_end_date | date | No | Supply end date |
Sample body
{
"invoice_date": "2026-10-30",
"due_date": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"invoice_no": "INV-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_ref": "text",
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00",
"amount_paid": "1250.00",
"status": "draft"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"invoice_date":"2026-10-30","due_date":"2026-10-30"}'DELETE/api/accounting/ar-invoices/{id}Delete a ar invoices
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/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/ar-invoices/{id}/e-invoiceE invoice
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/e-invoice" \
-H "Authorization: Bearer $TOKEN"PATCH/api/accounting/ar-invoices/{id}Patch ar invoices
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):
totalResponse
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 PATCH "https://demo.tranxact.ai/api/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"total":"value"}'POST/api/accounting/ar-invoices/{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/accounting/ar-invoices/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/ar-invoices/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-invoices/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/ar-invoices/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/ar-invoices/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-invoices/createCreate
Request body
The keys this action reads (* = required; "one of" lists the only values):
shipTo, shipToSiteId, shipFrom, documentNo, invoiceSubtype, exchangeRate, costCenterId, costCenterCode, profitCenterId, profitCenterCode, supplyDate, supplyEndDate, customerAccountId, customerAccountNo, customerName, invoiceDate, dueDate, sourceRef, currency, subtotal, tax; invoiceSubtype one of standard|simplified; lines: [{ taxCodeId, vatCategory, quantity, unitPrice, description, itemId, item_id, uom, hsnCode, hsn_code, currency, exchangeRate, glAccountId, accountId, accountNo, accountCode, costCenterId, costCenterCode, profitCenterId, profitCenterCode, exemptionReasonCode, exemptionReason }]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/ar-invoices/create" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"shipTo":"value","shipToSiteId":"value","shipFrom":"value","documentNo":"value","invoiceSubtype":"value","exchangeRate":"value"}'GET/api/accounting/ar-invoices/{id}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-invoices/{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/accounting/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-invoices/{id}/apply-receiptApply receipt
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):
amount, receiptDate, method, exchangeRateResponse
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/ar-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/apply-receipt" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"amount":"value","receiptDate":"value","method":"value","exchangeRate":"value"}'Data model
Every field of a ar invoices, 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 |
invoice_no | text | read only | Invoice no |
customer_account_id | uuid | read, write | Customer account id |
patient_id | uuid | read only | Patient id |
source_module | text | read only | Source module |
source_ref | text | read only | Source ref |
invoice_date | date | read, write | Invoice date |
due_date | date | read, write | Due date |
currency | text | read only | Currency |
subtotal | numeric | read, write | Subtotal |
tax | numeric | read, write | Tax |
total | numeric | read, write | Total |
amount_paid | numeric | read only | Amount paid |
status | text | read, write | Status |
journal_id | uuid | read only | Journal id |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
cost_center_id | uuid | read only | Cost center id |
profit_center_id | uuid | read only | Profit center id |
document_type | text | read only | Document type |
related_invoice_id | uuid | read only | Related invoice id |
memo_reason | text | read, write | Memo reason |
cancelled_at | timestamp with time zone | read only | Cancelled at |
cancelled_by | uuid | read only | Cancelled by |
cancel_reason | text | read only | Cancel reason |
reversed_by_id | uuid | read only | Reversed by id |
reverses_id | uuid | read only | Reverses id |
exchange_rate | numeric | read only | Exchange rate |
base_total | numeric | read only | Base total |
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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
invoice_subtype | text | read, write | Invoice subtype |
issued_at | timestamp with time zone | read only | Issued at |
supply_date | date | read, write | Supply date |
supply_end_date | date | read, write | Supply end date |
seller_snapshot | jsonb | read only | Seller snapshot |
buyer_snapshot | jsonb | read only | Buyer snapshot |
zatca_qr | text | read only | Zatca qr |
vat_total_sar | numeric | read only | Vat total sar |
zatca_regime | text | read only | Zatca regime |
issued_backfilled | boolean | read only | Issued backfilled |
zatca_uuid | uuid | read only | Zatca uuid |
invoice_hash | text | read only | Invoice hash |
previous_invoice_hash | text | read only | Previous invoice hash |
icv | bigint | read only | Icv |
subtype_changed_by | uuid | read only | Subtype changed by |
subtype_changed_at | timestamp with time zone | read only | Subtype changed at |
backfill_repaired_at | timestamp with time zone | read only | Backfill repaired at |
backfill_repair | jsonb | read only | Backfill repair |
supplier_gstin | text | read only | Supplier gstin |
buyer_gstin | text | read only | Buyer gstin |
supply_state_code | text | read only | Supply state code |
place_of_supply | text | read only | Place of supply |
is_interstate | boolean | read only | Is interstate |
is_reverse_charge | boolean | read only | Is reverse charge |
is_export | boolean | read only | Is export |
export_type | text | read only | Export type |
shipping_bill_no | text | read only | Shipping bill no |
cgst_total | numeric | read only | Cgst total |
sgst_total | numeric | read only | Sgst total |
igst_total | numeric | read only | Igst total |
cess_total | numeric | read only | Cess total |
round_off | numeric | read only | Round off |
duplicate_reason | text | read only | Duplicate reason |
duplicate_of | _text | read only | Duplicate of |
duplicate_confirmed_by | uuid | read only | Duplicate confirmed by |
duplicate_confirmed_at | timestamp with time zone | read only | Duplicate confirmed at |
egs_unit_id | uuid | read only | Egs unit id |
zatca_invoice_type_code | text | read only | Zatca invoice type code |
zatca_transaction_code | text | read only | Zatca transaction code |
zatca_status | text | read only | Zatca status |
signed_xml | text | read only | Signed xml |
zatca_signed_at | timestamp with time zone | read only | Zatca signed at |
cleared_xml | text | read only | Cleared xml |
zatca_response | jsonb | read only | Zatca response |
submitted_at | timestamp with time zone | read only | Submitted at |
cleared_at | timestamp with time zone | read only | Cleared at |
zatca_attempts | integer | read only | Zatca attempts |
zatca_next_attempt_at | timestamp with time zone | read only | Zatca next attempt at |
zatca_last_error | text | read only | Zatca last error |
payment_means_code | text | read only | Payment means code |
eway_bill_required | boolean | read only | Eway bill required |
gst_doc_series_id | uuid | read only | Gst doc series id |
gst_financial_year | text | read only | Gst financial year |
draft_invoice_no | text | read only | Draft invoice no |
irn | text | read only | Irn |
irn_ack_no | text | read only | Irn ack no |
irn_ack_date | timestamp with time zone | read only | Irn ack date |
irn_signed_qr | text | read only | Irn signed qr |
irn_status | text | read only | Irn status |
zatca_replaced_by_id | uuid | read only | Zatca replaced by id |
receivable_account_no | text | read only | Receivable account no |
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 Accounting › AR Invoices 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.