GROSS PROFIT

4 min

Introduction

This API documentation provides instructions for making a POST request to the Signzy API endpoint for retrieving GSTR gross profits. The request requires the patron's ID, access token, and essential information such as GSTIN, username, and authentication details. The response provides details of the gross profits for the specified return period.

Sample cURL

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

Parameter	Data Type	Required	Description
patron-id	string	Yes	The unique identifier for the patron.
Access-Token	string	Yes	The access token for authentication.
Accept	string	No	The accepted response content type.
Accept-Language	string	No	The preferred language of the response.
content-type	string	Yes	The content type of the request payload.
gstin	string	Yes	The Goods and Services Tax Identification Number (GSTIN) of the user.
username	string	Yes	The username of the user.
sek	string	Yes	The Secret Encryption Key (SEK) for the user's account.
appKey	string	Yes	The application key for the user's account.
authToken	string	Yes	The authentication token for the user's account.
retPeriod	string	Yes	The return period for which the GSTR gross profits are to be retrieved.

Sample Response

{
    "result":{
        "grossProfit" : "..grossProfit.."
      }
  }

Parameter	Data Type	Required	Description
grossProfit	string	Yes	The gross profit amount for the specified return period.