Get GST Return Status
Sandbox API where the authenticated taxpayers can get GSTR status after uploading JSON to the GST portal.
Overview
- This API provides details regarding the status of returns the taxpayer (
gstin) for the particularyearandmonth.
Endpoint
| HTTP Method | Resource | Description |
|---|---|---|
Get | gsp/tax-payer/{gstin}/gstrs/{year}/{month}/status | Takes in gstin, year and month and provides returns status |
Request
Follow the below guidelines to pass GSTIN, year & month for getting GST Return details.
Path Parameters
| Param | Type | Description | Example |
|---|---|---|---|
| gstin | string | 15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime | 22AAAAA0000A1Z5 |
| year | string | Year for which Advance Tax needs to be fetched. | 2020 |
| month | string | Month for which Advance Tax needs to be fetched. | 01 |
Once the values are added, Your curl will look something like this
curl --request GET \
--url 'https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/gstrs/2020/01/status?reference_id=243255' \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0'
Test Environment Not Available
Response
The response includes the following GST Return Status details below
| Param | Type | Description | Example |
|---|---|---|---|
| status_cd | string | Status of request | PROCESSED-P/PROCESSED with Error- PE/ERROR-ER |
| form_typ | string | Form Type (R1=GSTR1, R2=GSTR2...) | R1 |
| Error Report | List (Error Details) | Refer to the Table below |
errorReportDetails
| Param | Type | Description | Example |
|---|---|---|---|
| b2b | object | B2B Error Report | |
| error_cd | string | Error code | RET100 |
| error_msg | string | Error Message | Duplicate Invoice |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Get GST Return Status is a Paid API, a wallet charge of INR 0.25 + GST per API call will be applicable.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 2 months ago