TRANXACT.AI Help

India statutory · Records

Eway bills

Read and maintain eway bills records (india.eway_bills).

Type REST6 operationsBase path /api/india/eway-billsPublished as /api/v1/eway-bills

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 › Eway bills 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.eway_bills · 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

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

GET/api/india/eway-billsList eway bills

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",
      "ewb_no": "EWB-000001",
      "einvoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "source_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "document_no": "DOC-000001",
      "document_date": "2026-10-30",
      "supply_type": "text",
      "sub_type": "text",
      "from_gstin": "text",
      "from_state_code": "FRO-000001",
      "from_pincode": "FRO-000001",
      "to_gstin": "text",
      "to_state_code": "TO-000001"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "ewb_no": "EWB-000001",
  "einvoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "document_no": "DOC-000001",
  "document_date": "2026-10-30",
  "supply_type": "text",
  "sub_type": "text",
  "from_gstin": "text",
  "from_state_code": "FRO-000001",
  "from_pincode": "FRO-000001",
  "to_gstin": "text",
  "to_state_code": "TO-000001"
}

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

Sample request

curl "https://demo.tranxact.ai/api/india/eway-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/eway-billsCreate a eway bills

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
ewb_notextNoEwb no
document_notextYesDocument no
document_datedateYesDocument date
supply_typetextNoSupply type
from_state_codetextNoFrom state code
from_pincodetextNoFrom pincode
to_state_codetextNoTo state code
to_pincodetextNoTo pincode
distance_kmintegerNoDistance km
transport_modetextNoTransport mode
vehicle_notextNoVehicle no
invoice_valuenumericNoInvoice value
valid_fromtimestamp with time zoneNoValid from
valid_untiltimestamp with time zoneNoValid until
statustextNoStatus

Sample body

{
  "document_no": "DOC-000001",
  "document_date": "2026-10-30",
  "ewb_no": "EWB-000001",
  "supply_type": "text",
  "from_state_code": "FRO-000001",
  "from_pincode": "FRO-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ewb_no": "EWB-000001",
  "einvoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "document_no": "DOC-000001",
  "document_date": "2026-10-30",
  "supply_type": "text",
  "sub_type": "text",
  "from_gstin": "text",
  "from_state_code": "FRO-000001",
  "from_pincode": "FRO-000001",
  "to_gstin": "text",
  "to_state_code": "TO-000001"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/eway-bills" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"document_no":"DOC-000001","document_date":"2026-10-30","ewb_no":"EWB-000001","supply_type":"text","from_state_code":"FRO-000001","from_pincode":"FRO-000001"}'
PUT/api/india/eway-bills/{id}Change a eway bills

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
ewb_notextNoEwb no
document_notextYesDocument no
document_datedateYesDocument date
supply_typetextNoSupply type
from_state_codetextNoFrom state code
from_pincodetextNoFrom pincode
to_state_codetextNoTo state code
to_pincodetextNoTo pincode
distance_kmintegerNoDistance km
transport_modetextNoTransport mode
vehicle_notextNoVehicle no
invoice_valuenumericNoInvoice value
valid_fromtimestamp with time zoneNoValid from
valid_untiltimestamp with time zoneNoValid until
statustextNoStatus

Sample body

{
  "document_no": "DOC-000001",
  "document_date": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ewb_no": "EWB-000001",
  "einvoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "document_no": "DOC-000001",
  "document_date": "2026-10-30",
  "supply_type": "text",
  "sub_type": "text",
  "from_gstin": "text",
  "from_state_code": "FRO-000001",
  "from_pincode": "FRO-000001",
  "to_gstin": "text",
  "to_state_code": "TO-000001"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/india/eway-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"document_no":"DOC-000001","document_date":"2026-10-30"}'
DELETE/api/india/eway-bills/{id}Delete a eway bills

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

Data model

Every field of a eway bills, 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
ewb_notextread, writeEwb no
einvoice_iduuidread onlyEinvoice id
source_record_iduuidread onlySource record id
document_notextread, writeDocument no
document_datedateread, writeDocument date
supply_typetextread, writeSupply type
sub_typetextread onlySub type
from_gstintextread onlyFrom gstin
from_state_codetextread, writeFrom state code
from_pincodetextread, writeFrom pincode
to_gstintextread onlyTo gstin
to_state_codetextread, writeTo state code
to_pincodetextread, writeTo pincode
distance_kmintegerread, writeDistance km
transport_modetextread, writeTransport mode
vehicle_notextread, writeVehicle no
transporter_idtextread onlyTransporter id
transporter_doc_notextread onlyTransporter doc no
invoice_valuenumericread, writeInvoice value
valid_fromtimestamp with time zoneread, writeValid from
valid_untiltimestamp with time zoneread, writeValid until
statustextread, writeStatus
cancel_reasontextread onlyCancel reason
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 › Eway bills 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.