Parent API: GST API Quickstart guide Authentication guide

GST e-Invoice File Download URL

Q: What parameters and payload format are required for Get file URL?

Requests are submitted via HTTP GET to '/gst/einvoice/filedtl'. Required parameters: 'email' (query parameter), 'gstin' (query parameter), 'rtnprd' (query parameter), 'token' (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 URL return?

For Get file URL (GET '/gst/einvoice/filedtl'), 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/gst/einvoice/filedtl

This API is called for get file URL

Parameters

query parameters

emailstringrequired

gstinstringrequired

GSTIN of the taxpayer

rtnprdstringrequired

Return Period (MMYYYY)

tokenstringrequired

Token

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 /gst/einvoice/filedtl. Required parameters: email (query parameter), gstin (query parameter), rtnprd (query parameter), token (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 URL (GET /gst/einvoice/filedtl), 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 for get file URL

Get list of IRN Jsons

Get Json for IRN

GET/gst/einvoice/filedtl

1const response = await fetch('https://apisandbox.whitebooks.in/gst/einvoice/filedtl?email=value&gstin=value&rtnprd=value&token=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.