Get Return Liability Ledger
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month} \
--header 'authorization: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}"
headers = {
"authorization": "<api-key>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>', 'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"authorization: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<api-key>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}")
.header("authorization", "<api-key>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"status_cd": "1",
"data": {
"cl_bal": {
"cessbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"desc": "Closing Balance",
"igstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"sgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"tot_rng_bal": 24
},
"fr_dt": "092018",
"gstin": "06AAAAA0000A1Z6",
"to_dt": "122018",
"tr": [
{
"cess": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"cessbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"cgst": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"cgstbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"desc": "Other than reverse charge",
"dschrg_typ": "",
"dt": "09/03/2017",
"igst": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"igstbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"ref_no": "AM051216747183N",
"sgst": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"sgstbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"tot_rng_bal": 48,
"tot_tr_amt": 48,
"tr_typ": "Dr"
},
{
"cess": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cessbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cgst": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"desc": "Other than reverse charge",
"dschrg_typ": "credit",
"dt": "10/03/2017",
"igst": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"igstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"ref_no": "DI0506170000004",
"sgst": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"sgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"tot_rng_bal": 24,
"tot_tr_amt": 24,
"tr_typ": "Cr"
},
{
"cess": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cessbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"desc": "Negative liability adjusted in GSTR3B Other than reverse charge",
"dschrg_typ": "credit",
"dt": "10/03/2017",
"igst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"igstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"ref_no": "DI0506170000004",
"sgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"sgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"tot_rng_bal": 24,
"tot_tr_amt": 24,
"tr_typ": "Cr"
},
{
"cess": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cessbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"desc": "Negative liability adjusted in GSTR3B reverse charge",
"dschrg_typ": "credit",
"dt": "10/03/2017",
"igst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"igstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"ref_no": "DI0506170000004",
"sgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"sgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"tot_rng_bal": 24,
"tot_tr_amt": 24,
"tr_typ": "Cr"
}
]
}
},
"timestamp": 1763446641000,
"transaction_id": "66b13aa7-f255-447c-bc68-997f2a54a278"
}Return Liability Ledger
Get return related ledger for the specified date range.
GET
/
gst
/
compliance
/
tax-payer
/
ledgers
/
tax
/
{year}
/
{month}
Get Return Liability Ledger
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month} \
--header 'authorization: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}"
headers = {
"authorization": "<api-key>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>', 'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"authorization: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<api-key>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}")
.header("authorization", "<api-key>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/tax/{year}/{month}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"status_cd": "1",
"data": {
"cl_bal": {
"cessbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"desc": "Closing Balance",
"igstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"sgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"tot_rng_bal": 24
},
"fr_dt": "092018",
"gstin": "06AAAAA0000A1Z6",
"to_dt": "122018",
"tr": [
{
"cess": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"cessbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"cgst": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"cgstbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"desc": "Other than reverse charge",
"dschrg_typ": "",
"dt": "09/03/2017",
"igst": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"igstbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"ref_no": "AM051216747183N",
"sgst": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"sgstbal": {
"fee": 2,
"intr": 2,
"oth": 2,
"pen": 2,
"tot": 12,
"tx": 2
},
"tot_rng_bal": 48,
"tot_tr_amt": 48,
"tr_typ": "Dr"
},
{
"cess": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cessbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cgst": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"cgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"desc": "Other than reverse charge",
"dschrg_typ": "credit",
"dt": "10/03/2017",
"igst": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"igstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"ref_no": "DI0506170000004",
"sgst": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"sgstbal": {
"fee": 1,
"intr": 1,
"oth": 1,
"pen": 1,
"tot": 6,
"tx": 1
},
"tot_rng_bal": 24,
"tot_tr_amt": 24,
"tr_typ": "Cr"
},
{
"cess": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cessbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"desc": "Negative liability adjusted in GSTR3B Other than reverse charge",
"dschrg_typ": "credit",
"dt": "10/03/2017",
"igst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"igstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"ref_no": "DI0506170000004",
"sgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"sgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"tot_rng_bal": 24,
"tot_tr_amt": 24,
"tr_typ": "Cr"
},
{
"cess": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cessbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"cgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"desc": "Negative liability adjusted in GSTR3B reverse charge",
"dschrg_typ": "credit",
"dt": "10/03/2017",
"igst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"igstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"ref_no": "DI0506170000004",
"sgst": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"sgstbal": {
"fee": 0,
"intr": 0,
"oth": 0,
"pen": 0,
"tot": 0,
"tx": 1000
},
"tot_rng_bal": 24,
"tot_tr_amt": 24,
"tr_typ": "Cr"
}
]
}
},
"timestamp": 1763446641000,
"transaction_id": "66b13aa7-f255-447c-bc68-997f2a54a278"
}Response schema
For successful responses, these resources describe the GSTN payload atdata.data.
View JSON schema
View Excel field reference
Authorizations
GST taxpayer access token returned by Verify OTP.
Sandbox API key from your Sandbox account.
Headers
API version
Path Parameters
Year of the return period.
Month of the return period.
Response
200 - application/json
GSTN response. data.status_cd is "1" for success and "0" for a business error.
- Option 1
- GSTN business error
A GSTN success or GSTN business-failure response. Both variants use HTTP 200.
The HTTP status code reported in the response body.
Available options:
200 Example:
200
The response timestamp in Unix epoch milliseconds.
Example:
1763446641000
The transaction identifier used to trace the request.
Example:
"41bb8041-fb83-4654-8d75-85a19f329158"
The GSTN success wrapper.
Show child attributes
Show child attributes