India statutory · Records
Gstr1 lines
Read and maintain gstr1 lines records (india.gstr1_detail).
/api/india/gstr1-linesPublished as /api/v1/gstr1-linesOverview
| 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 › Gstr1 lines 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.gstr1_detail · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/india/gstr1-linesList gstr1 lines
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",
"return_no": "RET-000001",
"gstin": "text",
"financial_year": "text",
"period_month": 10,
"line_no": 10,
"table_ref": "text",
"document_type": "text",
"counterparty_gstin": "text",
"counterparty_name": "Example",
"document_no": "DOC-000001",
"document_date": "2026-10-30",
"original_document_no": "ORI-000001",
"place_of_supply": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/india/gstr1-lines?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/india/gstr1-lines/{id}Read one gstr1 lines
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",
"return_no": "RET-000001",
"gstin": "text",
"financial_year": "text",
"period_month": 10,
"line_no": 10,
"table_ref": "text",
"document_type": "text",
"counterparty_gstin": "text",
"counterparty_name": "Example",
"document_no": "DOC-000001",
"document_date": "2026-10-30",
"original_document_no": "ORI-000001",
"place_of_supply": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/india/gstr1-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/india/gstr1-linesPost gstr1 lines
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/gstr1-lines" \
-H "Authorization: Bearer $TOKEN"POST/api/india/gstr1-lines/{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/gstr1-lines/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/gstr1-lines/{id}Put gstr1 lines
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/gstr1-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/india/gstr1-lines/{id}Delete gstr1 lines
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/gstr1-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a gstr1 lines, 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 |
return_no | text | read only | Return no |
gstin | text | read only | Gstin |
financial_year | text | read only | Financial year |
period_month | integer | read only | Period month |
line_no | integer | read only | Line no |
table_ref | text | read only | Table ref |
document_type | text | read only | Document type |
counterparty_gstin | text | read only | Counterparty gstin |
counterparty_name | text | read only | Counterparty name |
document_no | text | read only | Document no |
document_date | date | read only | Document date |
original_document_no | text | read only | Original document no |
place_of_supply | text | read only | Place of supply |
is_reverse_charge | boolean | read only | Is reverse charge |
hsn_code | text | read only | Hsn code |
uqc | text | read only | Uqc |
quantity | numeric | read only | Quantity |
gst_rate | numeric | read only | Gst rate |
taxable_value | numeric | read only | Taxable value |
cgst | numeric | read only | Cgst |
sgst | numeric | read only | Sgst |
igst | numeric | read only | Igst |
cess | numeric | read only | Cess |
invoice_value | numeric | read only | Invoice value |
doc_from | text | read only | Doc from |
doc_to | text | read only | Doc to |
doc_count | integer | read only | Doc count |
cancelled_count | integer | read only | Cancelled count |
return_id | uuid | read only | Return id |
supply_section | text | read only | Supply section |
hsn_description | text | read only | Hsn description |
supply_type | text | read only | Supply type |
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 › Gstr1 lines 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.