1. Request Details
HTTP Method | POST |
URL PATH | https://my.gstzen.in/api/gstn-gstr-1-report-download/ |
Request Payload Type | application/json |
Response Type | application/json |
Authentication | Bearer (Paste the access token you recieved from REST Api Authentication) |
2. Request Payload Example
Request Payload
{ "gstin": "17AAFCC9980MZZT", "year": 2021, "month": 4, "api_name": "b2b" }
Here, api_name
should be any one of the following:
retsum | Return Summary |
at | Tax Liability (Advances Received) |
ata | Tax Liability (Advances Received) Amendments |
b2b | B2B Invoices |
b2b-einv | B2B Invoices (E-Invoices) |
b2ba | B2B Invoice Amendments |
b2cl | B2C (Large) Invoices |
b2cla | B2C (Large) Invoice Amendments |
b2cs | B2C (Small) Invoices |
b2csa | B2C (Small) Invoice Amendments |
cdnr | Credit/Debit Notes (Registered) |
cdnr-einv | Credit/Debit Notes (E-Invoices) |
cdnra | Credit/Debit Notes (Registered) Amendments |
cdnur | Credit/Debit Notes (against B2CL and Exports) |
cdnur-einv | Credit/Debit Notes (E-Invoices) |
cdnura | Credit/Debit Notes (against B2CL and Exports) Amendments |
exp | Export Invoices |
exp-einv | Export Invoices (E-Invoices) |
expa | Export Invoice Amendments |
hsnsum | HSN/SAC Summary |
nil | NIL, Exempt, and non-GST Invoices |
txp | Adjustment of Advances |
txpa | Adjustment of Advances - Amendments |
3. Response Example
If payload is correct and there is data in the protal
{ "status": 1, "api_call": "gstr1-b2b", "message": { "b2b": [ { "cfs": "N", "inv": [ { "idt": "17-04-2021", "pos": "06", "val": 101445, "flag": "U", "inum": "210052", "itms": [ { "num": 1801, "itm_det": { "rt": 18, "iamt": "15474.6", "csamt": 0, "txval": 85970 } } ], "cflag": "N", "rchrg": "N", "updby": "S", "chksum": "47720fabaf7f6f30ba13cdsdksldklkdldsdsd34343cb5c71d954736c346f7dcb99", "inv_typ": "R" . . . . } ], "ctin": "33AAGFM0079D1ZO" } ] } }
If payload is correct and there is no data in the protal
{ "status": 1, "api_call": "gstr1-b2b", "message": { "b2b": [] } }
To reduce api calls, call
retsum
api first and download
only from api where data is present.
If api is called multiple times
To avoid mis-use of api, cooling-off period has been set until which
api with same payload cannot be called again.
{ "status": 0, "message": "GSTR1 B2B for Apr 2021 has been downloaded recently. Please avoid calling the api multiple times." }