iotoms Docs

Get India HSN summary

GET
/api/v1/reports/tax/india/hsn-summary

Returns outward supplies for the filing month grouped by HSN code (the product classification used in GST returns). month and year are required.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

month*integer

Filing month (1–12)

Formatint32
year*integer

Filing year (>= 2017)

Formatint32

Header Parameters

X-TenantID*string

Tenant identifier

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?array<>|

One row per HSN code sold in the filing month. Items without an HSN code are left out.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/india/hsn-summary?month=0&year=0' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "hsnCode": "string",      "description": "string",      "uom": "string",      "totalQuantity": 0,      "totalValue": 0,      "taxableValue": 0,      "cgstAmount": 0,      "sgstAmount": 0,      "igstAmount": 0,      "totalTax": 0    }  ]}