Gst Returns Download Lite for CMP
Gst Returns Download Lite for CMP#
This API helps to download the data for all CMP document types
Route
/basic/gstn/{flynn-version}/taxpayerapi/{gstn-api-version}/returns?gstn_ret_type=cmp
- active 'flynn-version': v1.0
- method: GET
URL Parameters#
| Name | Description | Type |
|---|---|---|
| flynn-version | version of the API for example, v1.0 |
string |
| gstn-api-version | as per the version of the GST API Documentation for example, v3.0 |
string |
Query Parameters#
- The Query parameter gstn_ret_type should pass mandatorily with value as ‘cmp’.
- Along with this, one need to pass all the required Parameters specified by GSTN portal.
- Refer to the GSTN Developer Portal for document type specific query parameters.
Headers#
- EAS required headers
- Along with these headers, one need to pass all the mandatory headers required for return type as specified by GSTN Developer Portal.
- GSTN authentication/common headers like clientid, client-secret, username, state-cd, auth-token, ip-usr, txn will be taken care by EAS.
Response#
200#
Successful response will be the same payload as per the ‘GST API Documentation’
Example
{
"status": "1",
"data": {
"gstin": "01AAAAB1726H1ZI",
"ret_period": "032018",
"isnil": "N",
"arn": "AA1212180000410",
"arn_dt": "30/04/2018",
"table3": {
"out_sup": {
"tax_val": 40,
"camt": 20,
"samt": 20
},
"in_sup": {
"tax_val": 40,
"iamt": 10,
"camt": 20,
"samt": 20,
"csamt": 10
},
"intr_pay": {
"iamt": 10,
"camt": 20,
"samt": 20,
"csamt": 10
},
"tax_pay": {
"tax_val": 1000,
"iamt": 20,
"camt": 10,
"samt": 10,
"csamt": 5
}
},
"table4": {
"rchrg": {
"iamt": 10,
"camt": 10,
"samt": 10,
"csamt": 10
},
"otr_rchrg": {
"iamt": 10,
"camt": 10,
"samt": 10,
"csamt": 10
},
"neg_liab": {
"rchrg": {
"iamt": 10,
"camt": 10,
"samt": 10,
"csamt": 10
},
"otr_rchrg": {
"iamt": 10,
"camt": 10,
"samt": 10,
"csamt": 10
}
},
"intr_pay": {
"iamt": 10,
"camt": 10,
"samt": 10,
"cess": 10
}
},
"tax_pay": [
{
"igst": {
"tx": 50,
"intr": 20,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cgst": {
"tx": 30,
"intr": 10,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"sgst": {
"tx": 50,
"intr": 20,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cess": {
"tx": 30,
"intr": 10,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"liab_id": 8855,
"trancd": 30002,
"trandate": "12-02-2018"
},
{
"igst": {
"tx": 50,
"intr": 20,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cgst": {
"tx": 30,
"intr": 10,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"sgst": {
"tx": 50,
"intr": 20,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cess": {
"tx": 30,
"intr": 10,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"liab_id": 8855,
"trancd": 30003,
"trandate": "12-02-2018"
}
],
"tax_paid": {
"pd_by_cash": [
{
"sgst": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cgst": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"igst": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cess": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"liab_id": 8855,
"debit_id": "DC1202180000007",
"trancd": 30002,
"trandate": "12-02-2018"
},
{
"sgst": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cgst": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"igst": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"cess": {
"tx": 0,
"intr": 0,
"pen": 0,
"fee": 0,
"oth": 0,
"tot": 0
},
"liab_id": 8855,
"debit_id": "DC1202180000007",
"trancd": 30003,
"trandate": "12-02-2018"
}
]
}
},
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
}
Errors#
Invalid GSTIN Format
{
"status": "0",
"data": null,
"error": {
"message": "err-invalid-gstin-format",
"type": "ClientRequest",
"args": {
"parameter-name": "gstin"
}
},
"info": null,
"additionalInfo": null,
"alert": null
}
Invalid GSTN API Version
{
"status": "0",
"data": null,
"error": {
"message": "err-invalid-gst-returns-api-version",
"type": "ClientRequest",
"args": {
"version": "v8.0"
}
},
"info": null,
"additionalInfo": null,
"alert": null
}
GSTN Error
{
"status": "0",
"data": null,
"error": {
"message": "err-gstn-returned-error",
"type": "Gstn",
"args": {
"gstn-err": {
"status-code": "0",
"error-code": "RET11402",
"message": "Unauthorized User"
}
}
},
"info": null,
"additionalInfo": null,
"alert": null
}
| Response Status | Description |
|---|---|
| 400 | Invalid GSTIN format in the request |
| 400 | Invalid GSTN API Version |
| 502 | Error at GSTN end |
Common Errors
click here for other common errors.