TRANXACT.AI Help

India statutory · Records

Einvoices

Read and maintain einvoices records (india.einvoices).

Type REST7 operationsBase path /api/india/einvoicesPublished as /api/v1/einvoices

Download specification (OpenAPI 3.1)

Overview

PackageIndia statutory
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 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.
Tableindia.einvoices · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

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",
      "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

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",
  "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|DBN

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/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

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/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

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

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 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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
registration_iduuidread onlyRegistration id
source_moduletextread onlySource module
source_resourcetextread onlySource resource
source_record_iduuidread onlySource record id
document_notextread onlyDocument no
document_typetextread onlyDocument type
document_datedateread onlyDocument date
financial_yeartextread onlyFinancial year
supplier_gstintextread onlySupplier gstin
buyer_gstintextread onlyBuyer gstin
place_of_supplytextread onlyPlace of supply
is_interstatebooleanread onlyIs interstate
taxable_valuenumericread onlyTaxable value
cgst_totalnumericread onlyCgst total
sgst_totalnumericread onlySgst total
igst_totalnumericread onlyIgst total
cess_totalnumericread onlyCess total
invoice_totalnumericread onlyInvoice total
irntextread onlyIrn
ack_notextread onlyAck no
ack_datetimestamp with time zoneread onlyAck date
signed_invoicetextread onlySigned invoice
signed_qr_codetextread onlySigned qr code
payloadjsonbread onlyPayload
statustextread onlyStatus
irp_statustextread onlyIrp status
errorsjsonbread onlyErrors
cancelled_attimestamp with time zoneread onlyCancelled at
cancel_reasontextread onlyCancel reason
submitted_attimestamp with time zoneread onlySubmitted at
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 India statutory › Einvoices 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.