India statutory · Records
Einvoices
Read and maintain einvoices records (india.einvoices).
/api/india/einvoicesPublished as /api/v1/einvoicesOverview
| Package | India statutory |
|---|---|
| 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 India statutory › Einvoices 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 | india.einvoices · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/india/einvoicesList einvoices
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"registration_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_resource": "text",
"source_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"document_type": "text",
"document_date": "2026-10-30",
"financial_year": "text",
"supplier_gstin": "text",
"buyer_gstin": "text",
"place_of_supply": "text",
"is_interstate": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/india/einvoices?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/india/einvoices/{id}Read one einvoices
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"registration_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_resource": "text",
"source_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"document_no": "DOC-000001",
"document_type": "text",
"document_date": "2026-10-30",
"financial_year": "text",
"supplier_gstin": "text",
"buyer_gstin": "text",
"place_of_supply": "text",
"is_interstate": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/india/einvoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/india/einvoices/generateGenerate
Request body
The keys this action reads (* = required; "one of" lists the only values):
invoiceId*, force, documentType; documentType one of INV|CRN|DBNResponse
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/india/einvoices/generate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"invoiceId":"value","force":"value","documentType;":"value"}'POST/api/india/einvoicesPost einvoices
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/india/einvoices" \
-H "Authorization: Bearer $TOKEN"POST/api/india/einvoices/{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/india/einvoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/india/einvoices/{id}Put einvoices
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 PUT "https://demo.tranxact.ai/api/india/einvoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/india/einvoices/{id}Delete einvoices
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 DELETE "https://demo.tranxact.ai/api/india/einvoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a einvoices, 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 |
org_unit_id | uuid | read only | Org unit id |
registration_id | uuid | read only | Registration id |
source_module | text | read only | Source module |
source_resource | text | read only | Source resource |
source_record_id | uuid | read only | Source record id |
document_no | text | read only | Document no |
document_type | text | read only | Document type |
document_date | date | read only | Document date |
financial_year | text | read only | Financial year |
supplier_gstin | text | read only | Supplier gstin |
buyer_gstin | text | read only | Buyer gstin |
place_of_supply | text | read only | Place of supply |
is_interstate | boolean | read only | Is interstate |
taxable_value | numeric | read only | Taxable value |
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 |
invoice_total | numeric | read only | Invoice total |
irn | text | read only | Irn |
ack_no | text | read only | Ack no |
ack_date | timestamp with time zone | read only | Ack date |
signed_invoice | text | read only | Signed invoice |
signed_qr_code | text | read only | Signed qr code |
payload | jsonb | read only | Payload |
status | text | read only | Status |
irp_status | text | read only | Irp status |
errors | jsonb | read only | Errors |
cancelled_at | timestamp with time zone | read only | Cancelled at |
cancel_reason | text | read only | Cancel reason |
submitted_at | timestamp with time zone | read only | Submitted at |
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 |
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 |
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 India statutory › Einvoices 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.