Parent API: GST API Quickstart guide Authentication guide

GST Electronic Credit Ledger (ITC) API

Q: What parameters and payload format are required for ITC Ledger Details?

Requests are submitted via HTTP GET to '/ledgers/itc'. Required parameters: 'gstin' (query parameter), 'frdt' (query parameter), 'todt' (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 ITC Ledger Details return?

For ITC Ledger Details (GET '/ledgers/itc'), 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/ledgers/itc

This API call is for get detailed ITC ledger for the specified period .

Parameters

query parameters

gstinstringrequired

GSTIN of the taxpayer

frdtstringrequired

From Date (DD-MM-YYYY,20-12-2016)

todtstringrequired

To Date (DD-MM-YYYY,20-12-2016)

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 /ledgers/itc. Required parameters: gstin (query parameter), frdt (query parameter), todt (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 ITC Ledger Details (GET /ledgers/itc), 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 call is for get detailed ITC ledger for the specified period .

Cash Ledger Details

Get Liability Ledger Details

GET/ledgers/itc

1const response = await fetch('https://apisandbox.whitebooks.in/ledgers/itc?gstin=value&frdt=value&todt=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.