Fetch Report

4 min

Introduction

This API allows you to fetch detailed GST analytics reports for an organization. Using a POST request with necessary headers and authorization, you can provide the required input parameters like GSTIN and request ID to retrieve the report. The response contains various details like tax liability, returns filed, refund claims, and more.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../gstanalytics \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task": "getGstAnalyticsReport", "type": "Detailed", "essentials": { "requestId": 1645165505556, "gstin": [ "<<gstin_of_organization>>" ] }}'

Parameter	Data Type	Required	Description
task	string	Yes	The task name for the API. For this API, the value should be "getGstAnalyticsReport".
type	string	Yes	The type of report to generate. For this API, the value should be "Detailed".
essentials	object	Yes	The essential parameters required for the API.
requestId	integer	Yes	The unique identifier for the request.
gstin	array of strings	Yes	The GST Identification Number(s) for the organization(s) to generate the report for.
Authorization	string	Yes	The access token to authenticate the API request.
Accept	string	No	The HTTP Accept header field indicates the response format accepted by the client.
Accept-Language	string	No	The HTTP Accept-Language header field indicates the preferred language of the response.
content-type	string	Yes	The HTTP Content-Type header field indicates the format of the request payload.

Sample Response

 {
        "task": "getGstAnalyticsReport",
        "essentials": {
            "requestId": 1644501723789,
            "gstin": [
                "29AAWCS3552Q1Z6"
            ],
            "refId": [
                "4615fb9f-fc0e-4fbd-9652-eac016fb5f95"
            ]
        },
        "id": "620537b0405e22bc4caf9b9c",
        "patronId": "5f10016e2d5764779b1703dd",
        "result": {
            "jsonDataUrl": "https://staging-persist.signzy.tech/api/files/4434705/download/0f73effbac4c45aba8853a82f520c3305d62a2c7e4764af986e225b4d91d2c2c.json",
            "excelUrl": "https://staging-persist.signzy.tech/api/files/4434706/download/432ae7fbe5e94a5d85d45706a282877ee3b26e178c094d899a51063d6e051e45.xlsx"
        }
     }

Parameter	Data Type	Required	Description
task	string	Yes	The task name to be executed
essentials	object	Yes	Essential details for the execution
requestId	integer	Yes	Unique identifier for the request
gstin	array	Yes	GST identification number(s)
refId	array	Yes	Unique reference identifier
id	string	Yes	Unique identifier for the execution
patronId	string	Yes	Patron identification number
result	object	Yes	Results of the execution
jsonDataUrl	string	Yes	URL to download the JSON data file
excelUrl	string	Yes	URL to download the Excel data file