Create Report

Introduction:

This API is used to create a gst analytics request based on GST data fetched from AA frameork

Sample cURL:

curl --location 'https://api-preproduction.signzy.app/api/v3/account-aggregator-switch/create-gst-request' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth token>' \
--data '{
    "requestId": [
        "2f57244b-5ffd-46db-a3bd-ddb6dc779932"
    ],
    "linkedRefNo": [
        "d6e50c2b-c72a-495b-bd87-993c732d0b39"
    ],
    "callbackUrl": "",
    "entityDetails": true,
    "differentPan": true,
    "pdf": true,
    "fromDate": "012023",
    "toDate": "102023"
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
requestId	Array of Strings	Request Id of all the AA requests.	Mandatory
linkedRefNo	Array of Strings	Linked reference number corresponding to each requestId. Note: For each linkedRefNo there should be a requestId associated with it and vice versa. If a requestId have two linkedRefNo with it then write requestId two times.	Mandatory
callbackUrl	String	Callback url where the final reports will be posted.	Optional
entityDetails	Boolean	Entity details entry will be present or not.	Optional
differentPan	Boolean	Different PAN is present or not.	Optional
pdf	Boolean	Pdf report will be present or not.	Optional
fromDate	String	Starting date of the report.	Optional
toDate	String	Ending date of the report.	Optional

Output Parameters:

Key	Type	Description
requestId	String	The request Id that will be created during the report creation.

Status Codes:

{
    "requestId": "79f7b232-4dc2-421c-818f-8acbd4b5e2bf"
}