Overview

Track GST Return API accepts gstin and year (Financial year). It then responds with the status of all the GSTRs filed by the given GSTIN and financial year.

Problem

If you are a GST entity, you need to claim an input tax credit (ITC) to offset your GST liability. However, if the Seller has not filed his GST Return then you won't be able to claim the ITC.
Furthermore, you wish to know a GST entity's compliance performance.

Solution

It is important to make sure that the seller you are dealing with has filed their returns, which can be known using this API.
GST entity periodically and rightly filing GSTRs is a positive indication of its business and compliance performance.
This is especially true in the case of E-Commerce platforms that want to allow businesses that have a good track record of compiling GSTRs

Endpoint

HTTP Method	Resource	Description
`GET`	/gsp/public/gstr?gstin={{gstin}}&financial_year={{financial_year}}	Endpoint takes GSTIN and financial year as Query parameter and returns the e-filed details

Request

You would only require the GSTIN of the entity and the financial year for which you want the GSTR filing status. These would be passed as path parameters.

Query Parameters

Param	Type	Description	Example
gstin	`string`	GSTIN of the GST Taxpayer.	24AAACJ3770E2ZV
year	`string`	Financial Year for obtaining the status of GST Returns.	FY 2019-20

Once the values are added, Your curl will look something like this

curl --request GET \
     --url 'https://api.sandbox.co.in/gsp/public/gstr?gstin=gstin&financial_year=financial_year' \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxxxxxxxxxxxxxx' \
     --header 'x-api-key: xxxxxxxxxxxxxxxxx' \
     --header 'x-api-version: 1.0'

📘
Test this API
We provide Test Data for this API. You can access it on the endpoint page. Note that you need to use your test keys with this data.

Response

The response would have the following params

Param	Type	Description	Example
arn	`string`	ARN Number generated after filing	AA241220607741S
ret_prd	`string`	Tax Period Selected by user	122020
mof	`string`	Mode of Filing(OFFLINE/ONLINE)	ONLINE
dof	`string`	Date of Filing	12-01-2021
rtntype	`string`	Return Type	GSTR3B
status	`string`	Status of the Return filed	Filed
valid	`string`	Is Return Valid/Invalid ?	Y/N

Let's go over the response table

E Filed list provides a list of returns that were filled by the entity during the selected financial period. Each block provides details regarding a particular GST return. These details are string type.

For every filed return, you have a valid param, which tells us whether the return filed by the entity is valid or not. The response would be either a Yes (Y) or No (N).
We are also provided with mof, which tells us the mode by which the entity filed its GST return. The response would be either ONLINE or OFFLINE, while dof tells us the date at which the filing was done.
The rtntype param helps in identifying the types of returns filed by that entity. While the arn tells us the ARN number, which is generated after filing. Finally, the status tells us the status of the GST Return

Wallet Charge

Since Track GST Return is not a Paid API, no wallet charge will take place.