Skip to content

Gst Returns Download Lite for FILEDOWNLOAD#

This API helps to download invoice level data for URLs received in ‘All - Get File Details’ API.

Route

/basic/gstn/{flynn-version}{file-download-url}

- active 'flynn-version': v1.0
- method: GET

URL Parameters#

Name Description Type
flynn-version version of the API
for example, v1.0		 string
file-download-url the url received in the FILEDET api string

Headers#

  • EAS required headers
  • Along with these headers, one need to pass eKey received in FILEDET API with header key X-FLYNN-N-FILEDET-EKEY
  • 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": {
    "b2b": [
      {
        "ctin": "01AABCE2207R1Z5",
        "cfs": "Y",
        "inv": [
          {
            "chksum": "BBUIBUIUIJKKBJKGUYFTFGUY",
            "updby": "S",
            "inum": "S008400",
            "idt": "24-11-2016",
            "val": 729248.16,
            "pos": "06",
            "rchrg": "N",
            "etin": "01AABCE5507R1Z4",
            "inv_typ": "R",
            "cflag": "N",
            "diff_percent": 0.65,
            "opd": "2016-12",
            "srctyp": "EInvoice",
            "irn": "897ADG56RTY78956HYUG90BNHHIJK453GFTD99845672FDHHHSHGFH4567FG56TR",
            "irngendate": "24-12-2019",
            "itms": [
              {
                "num": 1,
                "itm_det": {
                  "rt": 5,
                  "txval": 10000,
                  "iamt": 325,
                  "camt": 0,
                  "samt": 0,
                  "csamt": 10
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "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.