Parent API: GST API Quickstart guide Authentication guide

Utilize GST ITC Ledger Against Tax Liability

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

Requests are submitted via HTTP POST to '/ledgers/utlitc'. Required parameters: 'email' (query parameter), 'gstin' (header parameter), 'ret_period' (header parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). A JSON request body ('Content-Type: application/json') is accepted per the schema specifications shown in the request documentation.

Q: What response status codes and format does Utilize ITC return?

For Utilize ITC (POST '/ledgers/utlitc'), 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).

POSThttps://apisandbox.whitebooks.in/ledgers/utlitc

This API call is to utilize the ITC Balance for paying the liability.

Ledger Analytics

Explore Feature

Electronic Cash, Credit & Liability Ledger Reports

Get consolidated electronic cash, credit, and liability ledger balances with drill-down transaction histories for all your GSTINs.

Parameters

query parameters

emailstringrequired

User Email

header parameters

gstinstringrequired

GST Number

ret_periodstringrequired

Return Period (MMYYYY)

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Request Body

application/jsonrequired

string

Response

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

Frequently Asked Questions

Requests are submitted via HTTP POST to /ledgers/utlitc. Required parameters: email (query parameter), gstin (header parameter), ret_period (header parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). A JSON request body (Content-Type: application/json) is accepted per the schema specifications shown in the request documentation.

For Utilize ITC (POST /ledgers/utlitc), 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 to utilize the ITC Balance for paying the liability.

Utilize Cash

Get E-Invice HSN Summary

POST/ledgers/utlitc

1const response = await fetch('https://apisandbox.whitebooks.in/ledgers/utlitc?email=value', {

2 method: 'POST',

3 headers: {

4 gstin: "value",

5 ret_period: "value",

6 gst_username: "value",

7 state_cd: "value",

8 ip_address: "value",

9 txn: "value",

10 client_id: "value",

11 client_secret: "value",

12 Content-Type: "application/json"

13},

14 body: JSON.stringify("string"),

15});

17const data = await response.json();

18console.log(data);

No example available.