Parent API: GST API Quickstart guide Authentication guide

GST Return Download File Details

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

Requests are submitted via HTTP GET to '/all/filedet'. Required parameters: 'gstin' (query parameter), 'returnperiod' (query parameter), 'token' (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 File Details return?

For Get File Details (GET '/all/filedet'), 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/filedet

This API is called with the file_num to get the file URL

Parameters

query parameters

gstinstringrequired

GSTIN of the taxpayer

returnperiodstringrequired

Return Period

tokenstringrequired

Transaction ID

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/filedet. Required parameters: gstin (query parameter), returnperiod (query parameter), token (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 File Details (GET /all/filedet), 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 file_num to get the file URL

Get User Masters

Get Large File Details

GET/all/filedet

1const response = await fetch('https://apisandbox.whitebooks.in/all/filedet?gstin=value&returnperiod=value&token=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.