Company By Name

4 min

Introduction

The curl command mentioned above is a sample request for the Signzy API v2 to retrieve the GST returns for a given GSTIN and financial year. The API endpoint used in the curl request is "/api/v2/patrons/{patron-id}/gstns", where "{patron-id}" refers to the unique identifier of the patron associated with the request.

To use the API, the client needs to pass an access token in the "Authorization" header of the request. The access token can be obtained by following the authentication process provided in the API documentation.

The request data is sent in JSON format, which includes a task parameter set to "viewReturns" and essentials parameter, which includes the GSTIN and financial year for which the client wants to view the returns.

Once the request is sent to the API endpoint, it will respond with the GST returns data for the given GSTIN and financial year.

Sample Curl

curl --request POST \
  --url http://signzy.tech/api/v2/patrons/..your-patron-id../gstns \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"viewReturns","essentials":{"gstin":"...gstin...","financialYear":"...financialYear..."}}'

Parameter	Description
request	HTTP request method (POST)
url	API endpoint URL
Accept	Media type(s) that are acceptable for the response
Accept-Language	Preferred natural language(s) for the response
Authorization	Access token for authentication
content-type	Data format (JSON)
task indicates	Indicates the task that needs to be performed (viewReturns)
essentials	A JSON object that contains the following parameters:<br>- gstin: The Goods and Services Tax Identification Number for which returns need to be viewed.<br>- financial year: The financial year for which returns need to be viewed.

Sample Response

{
  	"result": {
  		"filedReturns": [{
  				"valid": "..valid..",
  				"methodOfFilling": "..methodOfFilling..",
  				"dateOfFilling": "..dateOfFilling..",
  				"returnPeriod": "..returnPeriod..",
  				"returnType": "..returnType..",
  				"applicationReferenceNumber": "..applicationReferenceNumber..",
  				"status": "..status.."
  			}

  		]
  	}

  }

Parameter	Description
result	The top-level JSON object that contains the result of the API request.
filedReturns	An array of JSON objects that contains the details of filed returns for the specified GSTIN and financial year.
valid	Indicates if the return is valid or not.
methodOfFilling	Specifies the method of filing the return.
dateOfFilling	Specifies the date on which the return was filed.
returnPeriod	Specifies the period for which the return was filed.
returnType	Specifies the type of return filed.
applicationReferenceNumber	Specifies the unique reference number for the filed return.
status	Specifies the current status of the filed return.