TRANXACT.AI Help

India statutory · Records

Hsn codes

Read and maintain hsn codes records (india.hsn_codes).

Type REST7 operationsBase path /api/india/hsn-codesPublished as /api/v1/hsn-codes

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 › Hsn codes 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.hsn_codes
RecordCreated, changed and (where the screen allows) deleted; key code
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/hsn-codesList hsn codes

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": [
    {
      "code": "COD-000001",
      "description": "text",
      "kind": "text",
      "chapter": "text",
      "gst_rate": "1250.00",
      "cess_rate": "1250.00",
      "uqc": "text",
      "effective_from": "2026-10-30",
      "is_active": true,
      "created_at": "2026-10-30T09:00:00Z",
      "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "updated_at": "2026-10-30T09:00:00Z",
      "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Response 200

{
  "code": "COD-000001",
  "description": "text",
  "kind": "text",
  "chapter": "text",
  "gst_rate": "1250.00",
  "cess_rate": "1250.00",
  "uqc": "text",
  "effective_from": "2026-10-30",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
descriptiontextYesDescription
kindtextNoKind
chaptertextNoChapter
gst_ratenumericNoGst rate
cess_ratenumericNoCess rate
uqctextNoUqc
is_activebooleanNoIs active

Sample body

{
  "description": "text",
  "kind": "text",
  "chapter": "text",
  "gst_rate": "1250.00",
  "cess_rate": "1250.00"
}

Response 201

{
  "code": "COD-000001",
  "description": "text",
  "kind": "text",
  "chapter": "text",
  "gst_rate": "1250.00",
  "cess_rate": "1250.00",
  "uqc": "text",
  "effective_from": "2026-10-30",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/hsn-codes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"text","kind":"text","chapter":"text","gst_rate":"1250.00","cess_rate":"1250.00"}'
PUT/api/india/hsn-codes/{code}Change a hsn codes

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
descriptiontextYesDescription
kindtextNoKind
chaptertextNoChapter
gst_ratenumericNoGst rate
cess_ratenumericNoCess rate
uqctextNoUqc
is_activebooleanNoIs active

Sample body

{
  "description": "text",
  "kind": "text"
}

Response 200

{
  "code": "COD-000001",
  "description": "text",
  "kind": "text",
  "chapter": "text",
  "gst_rate": "1250.00",
  "cess_rate": "1250.00",
  "uqc": "text",
  "effective_from": "2026-10-30",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/india/hsn-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"text","kind":"text"}'
DELETE/api/india/hsn-codes/{code}Delete a hsn codes

Path parameters

NameTypeDescription
codestring (uuid)The record's code, 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/hsn-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/india/hsn-codes/{code}/rateRate

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/india/hsn-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/hsn-codes/{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/hsn-codes/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 hsn codes, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
codetextread, writeCode
descriptiontextread, writeDescription
kindtextread, writeKind
chaptertextread, writeChapter
gst_ratenumericread, writeGst rate
cess_ratenumericread, writeCess rate
uqctextread, writeUqc
effective_fromdateread onlyEffective from
is_activebooleanread, writeIs active
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 › Hsn codes 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.