TRANXACT.AI Help

India statutory · Records

Gstr2b lines

Read and maintain gstr2b lines records (india.gstr2b_detail).

Type REST6 operationsBase path /api/india/gstr2b-linesPublished as /api/v1/gstr2b-lines

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 › Gstr2b 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.
Tableindia.gstr2b_detail · 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

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

GET/api/india/gstr2b-linesList gstr2b lines

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",
      "import_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "section": "text",
      "supplier_gstin": "text",
      "supplier_name": "Example",
      "document_no": "DOC-000001",
      "document_date": "2026-10-30",
      "document_type": "text",
      "place_of_supply": "text",
      "is_reverse_charge": true,
      "itc_available": "text",
      "taxable_value": "1250.00",
      "igst": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "import_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "section": "text",
  "supplier_gstin": "text",
  "supplier_name": "Example",
  "document_no": "DOC-000001",
  "document_date": "2026-10-30",
  "document_type": "text",
  "place_of_supply": "text",
  "is_reverse_charge": true,
  "itc_available": "text",
  "taxable_value": "1250.00",
  "igst": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/india/gstr2b-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/gstr2b-linesPost gstr2b 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/gstr2b-lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/gstr2b-lines/{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/gstr2b-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/gstr2b-lines/{id}Put gstr2b lines

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/gstr2b-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/india/gstr2b-lines/{id}Delete gstr2b lines

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/gstr2b-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a gstr2b lines, 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
import_iduuidread onlyImport id
org_iduuidread onlyOrg id
line_nointegerread onlyLine no
sectiontextread onlySection
supplier_gstintextread onlySupplier gstin
supplier_nametextread onlySupplier name
document_notextread onlyDocument no
document_datedateread onlyDocument date
document_typetextread onlyDocument type
place_of_supplytextread onlyPlace of supply
is_reverse_chargebooleanread onlyIs reverse charge
itc_availabletextread onlyItc available
taxable_valuenumericread onlyTaxable value
igstnumericread onlyIgst
cgstnumericread onlyCgst
sgstnumericread onlySgst
cessnumericread onlyCess
invoice_valuenumericread onlyInvoice value
match_statustextread onlyMatch status
ap_invoice_iduuidread onlyAp invoice id
ap_invoice_notextread onlyAp invoice no
books_valuenumericread onlyBooks value
books_taxnumericread onlyBooks tax
differencenumericread onlyDifference
notetextread onlyNote
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
import_notextread onlyImport no
gstintextread onlyGstin
return_periodtextread onlyReturn period
org_unit_iduuidread onlyOrg unit id

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 › Gstr2b lines 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.