View & Track Returns#

This API is Deprecated. Please use VERSION TWO OH (v2.0)

View and Track Return API fetches public information on return filing of a particular GSTIN. You need to provide the financial year (FY) along with the GSTIN to fetch the results (return filings) done during that FY.

Route

/basic/gstn/{flynn-version}/commonapi/{gstn-api-version}/returns/{gstin}?fy={fy}

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
gstin	GSTIN of the taxpayer _for example, 33GSPTN0791G1Z5__	string

Query Parameters#

Name	Description	Type
fy	Financial Year of filing date, to filter the results format = YYYY-YY min-value = 2017-18	mandatory, string

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’ for the “View and Track Returns” API.

Example

{
    "data": "{\"EFiledlist\":[{\"arn\":\"AA010143556585B\",\"ret_prd\":\"022017\",\"mof\":\"ONLINE\",\"dof\":\"08-02-2017\",\"rtntype\":\"GSTR2\",\"status\":\"Filed\",\"valid\":\"Y\"},{\"arn\":\"AA010143556585B\",\"ret_prd\":\"022017\",\"mof\":\"ONLINE\",\"dof\":\"07-02-2017\",\"rtntype\":\"GSTR1\",\"status\":\"Filed\",\"valid\":\"Y\"},{\"arn\":\"AA010143556587A\",\"ret_prd\":\"032017\",\"mof\":\"ONLINE\",\"dof\":\"07-03-2017\",\"rtntype\":\"GSTR3\",\"status\":\"Filed\",\"valid\":\"N\"}]}"
}

Errors#

Invalid GSTIN Format

{
  "error" : {
    "message" : "err-invalid-request-params",
    "type" : "ClientRequest",
    "args" : {
      "parameter-name" : "gstin",
      "orig-err" : "err-invalid-gstin-format"
    }
  }
}

Invalid GSTN API Version

{
  "error" : {
    "message" : "err-invalid-gstn-version",
    "type" : "ClientRequest",
    "args" : {
      "api-type" : "view-and-track-returns"
    }
  }
}

GSTN Error

{
  "error" : {
    "message" : "err-gstn-returned",
    "type" : "Gstn",
    "args" : {
      "status-code" : "0",
      "gstn-err" : {
        "code" : "RET11402",
        "message" : "Unauthorized User"
      }
    }
  }
}

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.