Entity Turn Over Request
Introduction
 The API allows users to fetch the GST return turnover details for a particular GST identification number (GSTIN) by providing various authentication details such as username, sek, appKey, authToken, and retPeriod.
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 | Description |
|---|---|
task | The task to be performed, in this case, retrieving GST return turnover data |
gstin | The GST identification number of the organization for which data is being requested |
username | The username of the user making the request |
sek | The secret encryption key for authentication purposes |
appKey | The application key used for authentication |
authToken | The authentication token used for authentication |
retPeriod | The return period for which GST return turnover data is being requested in the format "MMYYYY" (e.g., "042022") |
Sample 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 | Description |
|---|---|
gstin | The GST identification number of the organization for which data is being requested |
username | The username of the user making the request |
authToken | The authentication token used for authentication |
appKey | The application key used for authentication |
sek | The secret encryption key for authentication purposes |
retPeriod | The return period for which GST return turnover data is being requested |
task | The type of task being performed, such as monthlyTurnover or compositionQuarterlyTurnover |
id | The access token for the response |
patronId | The unique identifier of the patron making the request |
turnoverAmount | The turnover amount for the requested GST period |
information | Any additional information related to the GST return turnover |