Entity Turn Over

4 min

Introduction

This API endpoint allows users to retrieve the GST returns turnover details for a specific GSTIN number. The endpoint accepts a POST request with a JSON payload containing the necessary information to process the request

Sample CURL

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

Parameter	Type	Required	Description
patron-id	string	Yes	Unique identifier for the user's account.
Access-Token	string	Yes	Valid Access Token generated using the user's credentials.
Accept	string	Yes	The desired response format, such as JSON or XML.
Accept-Language	string	Yes	The preferred language of the response.
task	string	Yes	The task type, such as "gstrturnovers" for retrieving GST returns turnover details.
gstin	string	Yes	The GSTIN number for which to retrieve the GST returns turnover details.
username	string	Yes	The user's username.
sek	string	Yes	The user's Sek key.
appKey	string	Yes	The App Key provided by the API.
authToken	string	Yes	The Auth Token provided by the API.
retPeriod	string	Yes	The return period for which to retrieve the GST returns turnover details.

Sample API Response

{
    "essentials": {
        "gstin": "..gstin..",
        "username": "..username..",
        "authToken": "..authToken..",
        "appKey": "..appKey..",
        "sek": "..sek..",
        "retPeriod": "..retPeriod..",
        "task": "monthlyTurnover/compositionQuarterlyTurnover/ecomMonthlyTurnover/regularYearlyTurnover"
    },
    "id": "...accessToken...",
    "patronId": "...patronId...",
    "result":{
        "turnoverAmount" : "...turnoverAmount...",
        "information" : "...information..."

        }
      }

Parameter	Type	Description
gstin	string	The GSTIN number for which the GST returns turnover details are retrieved.
username	string	The username of the user who requested the GST returns turnover details.
authToken	string	The Auth Token used by the user to authenticate the API request.
appKey	string	The App Key provided by the API to the user.
sek	string	The Sek key provided by the API to the user.
retPeriod	string	The return period for which the GST returns turnover details are retrieved.
task	string	The task type specified in the request, such as "gstrturnovers".
id	string	The access token generated for the user.
patronId	string	The unique identifier of the user's account.
turnoverAmount	string	The total turnover amount for the specified GSTIN number and return period.
information	string	Additional information, if any, related to the GST returns turnover details. This could include any notes or remarks related to the calculations or any warnings or errors encountered during the processing of the request.