Parent API: GST API Quickstart guide Authentication guide

GST Large Return File Download

Q: What parameters and payload format are required for Get Large File Details?

Requests are submitted via HTTP GET to '/all/largefile'. Required parameters: 'url' (query parameter), 'ek' (query parameter), 'gstin' (query parameter), 'returnperiod' (query parameter), 'email' (query parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). No request body payload is required for this call.

Q: What response status codes and format does Get Large File Details return?

For Get Large File Details (GET '/all/largefile'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

GEThttps://apisandbox.whitebooks.in/all/largefile

This API is called with the large file url to get the data

Parameters

query parameters

urlstringrequired

Large file url

ekstringrequired

Encryption key from file details response

gstinstringrequired

GSTIN of the taxpayer

returnperiodstringrequired

Return Period

emailstringrequired

header parameters

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Response

Not Found. If requested entity is not found or if requested API is not found.

Frequently Asked Questions

Requests are submitted via HTTP GET to /all/largefile. Required parameters: url (query parameter), ek (query parameter), gstin (query parameter), returnperiod (query parameter), email (query parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). No request body payload is required for this call.

For Get Large File Details (GET /all/largefile), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

This API is called with the large file url to get the data

Get File Details

Late Fee

GET/all/largefile

1const response = await fetch('https://apisandbox.whitebooks.in/all/largefile?url=value&ek=value&gstin=value&returnperiod=value&email=value', {

2 method: 'GET',

3 headers: {

4 gst_username: "value",

5 state_cd: "value",

6 ip_address: "value",

7 txn: "value",

8 client_id: "value",

9 client_secret: "value"

10},

11});

13const data = await response.json();

14console.log(data);

No example available.