Gst Returns Download Lite for ‘All - Get File Details’

This API helps to download the large file data using token received in the response of GSTR-1 or 2A

Route

/basic/gstn/{flynn-version}/taxpayerapi/{gstn-api-version}/returns

• 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

• 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 for ‘All - Get File Details’

{
  "status": "1",
  "data": {
    "fc": 1,
    "urls": [
      {
        "ul": "https://domain-name/taxpayerapi-doc/{unique-key}",
        "ic": 500,
        "hash": "cxvzcxvzxvcx"
      }
    ],
    "ek": "Fni+ZDUy33UH55tDJsBsimNFDlZ/Vph2hgtpAasHczY="
  },
  "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.