Get IMS File Details

Route

/basic/gstn/{flynn-version}/taxpayerapi/{gstn-api-version}/returns/ims/FILEDET?gstin={gstin}&token={token}

• 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, v0.3	string

Query Parameters

Name	Description	Type	Mandatory
gstin	GSTIN of the taxpayer for example, 33GSPTN0791G1Z5	string	Yes
token	Token for getting a particular return file	string	Yes

Headers

All required headers to make an authenticated API call.

Response

200

Successful response will be the same payload as per the ‘GST API Documentation’.

Example

{
  "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
404	Invalid GSTIN
502	Error at GSTN end

Common Errors

check here for other common errors.