Gst Returns Download Lite for GSTR-3b#
This API helps to download the data for all GSTR-3b document types
Route
/basic/gstn/{flynn-version}/taxpayerapi/{gstn-api-version}/returns?gstn_ret_type=gstr3b
- 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 ‘gstr3b’.
- 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": "29HJKPS9689A8Z4",
"ret_period": "072016",
"sup_details": {
"osup_det": {
"txval": 250,
"iamt": 100,
"camt": 200,
"samt": 300,
"csamt": 400
},
"osup_zero": {
"txval": 250,
"iamt": 100,
"csamt": 400
},
"osup_nil_exmp": {
"txval": 250
},
"isup_rev": {
"txval": 250,
"iamt": 100,
"camt": 200,
"samt": 300,
"csamt": 400
},
"osup_nongst": {
"txval": 250
}
},
"inter_sup": {
"unreg_details": [
{
"pos": "07",
"txval": 250,
"iamt": 200
},
{
"pos": "07",
"txval": 250,
"iamt": 200
},
{
"pos": "07",
"txval": 250,
"iamt": 200
}
],
"comp_details": [
{
"pos": "07",
"txval": 250,
"iamt": 200
},
{
"pos": "07",
"txval": 250,
"iamt": 200
},
{
"pos": "07",
"txval": 250,
"iamt": 200
}
],
"uin_details": [
{
"pos": "07",
"txval": 250,
"iamt": 200
},
{
"pos": "07",
"txval": 250,
"iamt": 200
},
{
"pos": "07",
"txval": 250,
"iamt": 200
}
]
},
"eco_dtls": {
"eco_sup": {
"txval": 250,
"iamt": 100,
"camt": 200,
"samt": 300,
"csamt": 400
},
"eco_reg_sup": {
"txval": 250
}
},
"itc_elg": {
"itc_avl": [
{
"ty": "IMPG",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
{
"ty": "IMPS",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
{
"ty": "ISRC",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
{
"ty": "ISD",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
{
"ty": "OTH",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
}
],
"itc_rev": [
{
"ty": "RUL",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
{
"ty": "OTH",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
}
],
"itc_net": {
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
" itc_inelg": [
{
"ty": "RUL",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
},
{
"ty": "OTH",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
}
]
},
"inward_sup": {
"isup_details": [
{
"ty": "GST",
"inter": 100,
"intra": 200
},
{
"ty": "NONGST",
"inter": 300,
"intra": 400
}
]
},
"tx_pmt": {
"tx_py": [
{
"trans_typ": 30002,
"trans_desc": "Other than reverse charge",
"liab_ldg_id": 11191,
"sgst": {
"intr": 100,
"tx": 100,
"fee": 100
},
"cgst": {
"intr": 100,
"tx": 100,
"fee": 100
},
"cess": {
"intr": 100,
"tx": 100
},
"igst": {
"intr": 100,
"tx": 100
}
},
{
"trans_typ": 30003,
"trans_desc": "Reverse charge",
"liab_ldg_id": 11191,
"sgst": {
"intr": 100,
"tx": 100,
"fee": 100
},
"cgst": {
"intr": 100,
"tx": 100,
"fee": 100
},
"cess": {
"intr": 100,
"tx": 100
},
"igst": {
"intr": 100,
"tx": 100
}
}
],
"pdcash": [
{
"liab_ldg_id": 1233,
"trans_typ": 30002,
"ipd": 3517817,
"cpd": 3517817,
"spd": 3517817,
"cspd": 3517817,
"i_intrpd": 20,
"c_intrpd": 30,
"s_intrpd": 10,
"cs_intrpd": 15,
"c_lfeepd": 13,
"s_lfeepd": 13
},
{
"liab_ldg_id": 1233,
"trans_typ": 30003,
"ipd": 3517817,
"cpd": 3517817,
"spd": 3517817,
"cspd": 3517817,
"i_intrpd": 20,
"c_intrpd": 30,
"s_intrpd": 10,
"cs_intrpd": 15,
"c_lfeepd": 13,
"s_lfeepd": 13
}
],
"pditc": {
"liab_ldg_id": 12321,
"trans_typ": 30002,
"i_pdi": 3517817,
"i_pdc": 2290459,
"i_pds": 2290459,
"c_pdi": 3517817,
"c_pdc": 2290459,
"s_pdi": 3517817,
"s_pds": 2290459,
"cs_pdcs": 2290459
},
"pdnls": [
{
"trans_typ": 30002,
"trans_desc": "Other than reverse charge",
"liab_ldg_id": 11191,
"ipd": 100,
"spd": 100,
"cpd": 100,
"cspd": 100
},
{
"trans_typ": 30003,
"trans_desc": "Reverse charge",
"liab_ldg_id": 11191,
"ipd": 100,
"spd": 100,
"cpd": 100,
"cspd": 100
}
]
},
"intr_ltfee": {
"intr_details": {
"iamt": 10,
"camt": 20,
"samt": 30,
"csamt": 40
},
"ltfee_details": {
"camt": 50,
"samt": 60
}
},
"liab_breakup": [
{
"ret_period": "032020",
"liability": {
"iamt": 1000,
"camt": 150,
"samt": 200,
"csamt": 300
}
},
{
"ret_period": "022020",
"liability": {
"iamt": 1000,
"camt": 150,
"samt": 200,
"csamt": 300
}
}
]
},
"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.