GSTR-9 Details
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9 \
--header 'authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9"
headers = {
"authorization": "<authorization>",
"x-api-key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};
fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9', 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/gstrs/gstr-9",
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: <authorization>",
"x-api-key: <x-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/gstrs/gstr-9"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("x-api-key", "<x-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/gstrs/gstr-9")
.header("authorization", "<authorization>")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"status_cd": "1",
"data": {
"aggTurnover": 34376971.41,
"fp": "032024",
"gstin": "29AAACQ3770E000",
"table10": {
"total_turnover": {
"camt": 255908.16,
"csamt": 0,
"iamt": 5676040.91,
"samt": 255908.16,
"txval": 34376971.41
}
},
"table17": {
"chksum": "b828f456ff6dfd375ac7b875c60c4fd02d60b3dd8479b2f865cfa3eea8e34828",
"items": [
{
"camt": 255908.16,
"csamt": 0,
"desc": "Individual tax preparation and planning services",
"hsn_sc": "998232",
"iamt": 5676040.91,
"isconcesstional": "N",
"rt": 18,
"samt": 255908.16,
"txval": 34376971.41
}
]
},
"table4": {
"b2b": {
"camt": 222404.68,
"csamt": 0,
"iamt": 50984.24,
"samt": 222404.68,
"txval": 2754408.56
},
"b2c": {
"camt": 33512.24,
"csamt": 0,
"iamt": 5701789.17,
"samt": 33512.24,
"txval": 32048951.84
},
"chksum": "4d91bdfa51ceaea1b5003dfdd20fa6e4cff26b261a82901ea07fdb82fe3dfd89",
"cr_nt": {
"camt": 8.76,
"csamt": 0,
"iamt": 76732.5,
"samt": 8.76,
"txval": 426388.99
},
"sub_totalAG1": {
"camt": 255916.92,
"csamt": 0,
"iamt": 5752773.41,
"samt": 255916.92,
"txval": 34803360.4
},
"sub_totalIL": {
"camt": -8.76,
"csamt": 0,
"iamt": -76732.5,
"samt": -8.76,
"txval": -426388.99
},
"sup_adv": {
"camt": 255908.16,
"csamt": 0,
"iamt": 5676040.91,
"samt": 255908.16,
"txval": 34376971.41
}
},
"table5": {
"amd_neg": {
"txval": 0
},
"amd_pos": {
"txval": 0
},
"chksum": "3e16d88c52a85601f04cf06b5cd6d9b9a59300457f9851668253abedb0dde848",
"cr_nt": {
"txval": 0
},
"dr_nt": {
"txval": 0
},
"ecom_14": {
"txval": 0
},
"exmt": {
"txval": 0
},
"nil": {
"txval": 0
},
"non_gst": {
"txval": 0
},
"rchrg": {
"txval": 0
},
"sez": {
"txval": 0
},
"sub_totalAF": {
"txval": 0
},
"sub_totalHK": {
"txval": 0
},
"total_tover": {
"camt": 255908.16,
"csamt": 0,
"iamt": 5676040.91,
"samt": 255908.16,
"txval": 34376971.41
},
"tover_tax_np": {
"txval": 0
},
"zero_rtd": {
"txval": 0
}
},
"table6": {
"chksum": "cf3a7e38a220ef732ad7cf504b080dbdcc8676c603f59dcadb8055c830338fdb",
"difference": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_3b": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"sub_totalBH": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"sub_totalKM": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"supp_non_rchrg": [
{
"camt": 782.55,
"csamt": 0,
"iamt": 16745.52,
"itc_typ": "cg",
"samt": 782.55
},
{
"camt": 169159.01,
"csamt": 0,
"iamt": 810052.26,
"itc_typ": "is",
"samt": 169159.01
}
],
"total_itc_availed": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
}
},
"table7": {
"chksum": "452bff4cb1704395ccfe07162f983680bdb6a406e6129a2d4a2b91bc31b5c26a",
"net_itc_aval": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"revsl_tran1": {
"camt": 0,
"samt": 0
},
"revsl_tran2": {
"camt": 0,
"samt": 0
},
"rule37": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"rule39": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"rule42": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"rule43": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"sec17": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"tot_itc_revd": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
}
},
"table8": {
"chksum": "4b171cb877aadc52cae1a0aeb584a99f8876cd9096c7ac3b8c18ebc3ba960e05",
"differenceABC": {
"camt": 6878.36,
"csamt": 0,
"iamt": -7855,
"samt": 6878.36
},
"differenceGH": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"iog_itc_availd": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"iog_itc_ntavaild": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"iog_taxpaid": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_2b": {
"camt": 176819.92,
"csamt": 0,
"iamt": 818942.78,
"samt": 176819.92
},
"itc_inwd_supp": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_nt_availd": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_nt_eleg": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_tot": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"tot_itc_lapsed": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
}
},
"table9": {
"camt": {
"tax_paid_itc_camt": 61419,
"tax_paid_itc_iamt": 16529,
"txpaid_cash": 177960,
"txpyble": 255908
},
"chksum": "54c119848512bda3faf6cac75ba729b0645c71c80d0dc89d845ffd4e6e2ee002",
"csamt": {
"tax_paid_itc_csamt": 0,
"txpaid_cash": 0,
"txpyble": 0
},
"fee": {
"txpaid_cash": 50,
"txpyble": 50
},
"iamt": {
"tax_paid_itc_camt": 108521,
"tax_paid_itc_iamt": 824879,
"tax_paid_itc_samt": 108521,
"txpaid_cash": 4669454,
"txpyble": 5711375
},
"intr": {
"txpaid_cash": 0,
"txpyble": 0
},
"other": {
"txpyble": 0
},
"pen": {
"txpyble": 0
},
"samt": {
"tax_paid_itc_iamt": 16529,
"tax_paid_itc_samt": 61419,
"txpaid_cash": 177960,
"txpyble": 255908
}
}
}
},
"timestamp": 1734691912000,
"transaction_id": "253683e4-71cb-4ed9-9f9c-44d5b7c7f6d6"
}GSTR-9 Details
Fetch GSTR-9 details saved with the Save GSTR-9 API. This data needs to be passed in the File GSTR-9 API to complete the filing workflow.
GET
/
gst
/
compliance
/
tax-payer
/
gstrs
/
gstr-9
GSTR-9 Details
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9 \
--header 'authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9"
headers = {
"authorization": "<authorization>",
"x-api-key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};
fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9', 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/gstrs/gstr-9",
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: <authorization>",
"x-api-key: <x-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/gstrs/gstr-9"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("x-api-key", "<x-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/gstrs/gstr-9")
.header("authorization", "<authorization>")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-9")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"status_cd": "1",
"data": {
"aggTurnover": 34376971.41,
"fp": "032024",
"gstin": "29AAACQ3770E000",
"table10": {
"total_turnover": {
"camt": 255908.16,
"csamt": 0,
"iamt": 5676040.91,
"samt": 255908.16,
"txval": 34376971.41
}
},
"table17": {
"chksum": "b828f456ff6dfd375ac7b875c60c4fd02d60b3dd8479b2f865cfa3eea8e34828",
"items": [
{
"camt": 255908.16,
"csamt": 0,
"desc": "Individual tax preparation and planning services",
"hsn_sc": "998232",
"iamt": 5676040.91,
"isconcesstional": "N",
"rt": 18,
"samt": 255908.16,
"txval": 34376971.41
}
]
},
"table4": {
"b2b": {
"camt": 222404.68,
"csamt": 0,
"iamt": 50984.24,
"samt": 222404.68,
"txval": 2754408.56
},
"b2c": {
"camt": 33512.24,
"csamt": 0,
"iamt": 5701789.17,
"samt": 33512.24,
"txval": 32048951.84
},
"chksum": "4d91bdfa51ceaea1b5003dfdd20fa6e4cff26b261a82901ea07fdb82fe3dfd89",
"cr_nt": {
"camt": 8.76,
"csamt": 0,
"iamt": 76732.5,
"samt": 8.76,
"txval": 426388.99
},
"sub_totalAG1": {
"camt": 255916.92,
"csamt": 0,
"iamt": 5752773.41,
"samt": 255916.92,
"txval": 34803360.4
},
"sub_totalIL": {
"camt": -8.76,
"csamt": 0,
"iamt": -76732.5,
"samt": -8.76,
"txval": -426388.99
},
"sup_adv": {
"camt": 255908.16,
"csamt": 0,
"iamt": 5676040.91,
"samt": 255908.16,
"txval": 34376971.41
}
},
"table5": {
"amd_neg": {
"txval": 0
},
"amd_pos": {
"txval": 0
},
"chksum": "3e16d88c52a85601f04cf06b5cd6d9b9a59300457f9851668253abedb0dde848",
"cr_nt": {
"txval": 0
},
"dr_nt": {
"txval": 0
},
"ecom_14": {
"txval": 0
},
"exmt": {
"txval": 0
},
"nil": {
"txval": 0
},
"non_gst": {
"txval": 0
},
"rchrg": {
"txval": 0
},
"sez": {
"txval": 0
},
"sub_totalAF": {
"txval": 0
},
"sub_totalHK": {
"txval": 0
},
"total_tover": {
"camt": 255908.16,
"csamt": 0,
"iamt": 5676040.91,
"samt": 255908.16,
"txval": 34376971.41
},
"tover_tax_np": {
"txval": 0
},
"zero_rtd": {
"txval": 0
}
},
"table6": {
"chksum": "cf3a7e38a220ef732ad7cf504b080dbdcc8676c603f59dcadb8055c830338fdb",
"difference": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_3b": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"sub_totalBH": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"sub_totalKM": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"supp_non_rchrg": [
{
"camt": 782.55,
"csamt": 0,
"iamt": 16745.52,
"itc_typ": "cg",
"samt": 782.55
},
{
"camt": 169159.01,
"csamt": 0,
"iamt": 810052.26,
"itc_typ": "is",
"samt": 169159.01
}
],
"total_itc_availed": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
}
},
"table7": {
"chksum": "452bff4cb1704395ccfe07162f983680bdb6a406e6129a2d4a2b91bc31b5c26a",
"net_itc_aval": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"revsl_tran1": {
"camt": 0,
"samt": 0
},
"revsl_tran2": {
"camt": 0,
"samt": 0
},
"rule37": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"rule39": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"rule42": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"rule43": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"sec17": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"tot_itc_revd": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
}
},
"table8": {
"chksum": "4b171cb877aadc52cae1a0aeb584a99f8876cd9096c7ac3b8c18ebc3ba960e05",
"differenceABC": {
"camt": 6878.36,
"csamt": 0,
"iamt": -7855,
"samt": 6878.36
},
"differenceGH": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"iog_itc_availd": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"iog_itc_ntavaild": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"iog_taxpaid": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_2b": {
"camt": 176819.92,
"csamt": 0,
"iamt": 818942.78,
"samt": 176819.92
},
"itc_inwd_supp": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_nt_availd": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_nt_eleg": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
},
"itc_tot": {
"camt": 169941.56,
"csamt": 0,
"iamt": 826797.78,
"samt": 169941.56
},
"tot_itc_lapsed": {
"camt": 0,
"csamt": 0,
"iamt": 0,
"samt": 0
}
},
"table9": {
"camt": {
"tax_paid_itc_camt": 61419,
"tax_paid_itc_iamt": 16529,
"txpaid_cash": 177960,
"txpyble": 255908
},
"chksum": "54c119848512bda3faf6cac75ba729b0645c71c80d0dc89d845ffd4e6e2ee002",
"csamt": {
"tax_paid_itc_csamt": 0,
"txpaid_cash": 0,
"txpyble": 0
},
"fee": {
"txpaid_cash": 50,
"txpyble": 50
},
"iamt": {
"tax_paid_itc_camt": 108521,
"tax_paid_itc_iamt": 824879,
"tax_paid_itc_samt": 108521,
"txpaid_cash": 4669454,
"txpyble": 5711375
},
"intr": {
"txpaid_cash": 0,
"txpyble": 0
},
"other": {
"txpyble": 0
},
"pen": {
"txpyble": 0
},
"samt": {
"tax_paid_itc_iamt": 16529,
"tax_paid_itc_samt": 61419,
"txpaid_cash": 177960,
"txpyble": 255908
}
}
}
},
"timestamp": 1734691912000,
"transaction_id": "253683e4-71cb-4ed9-9f9c-44d5b7c7f6d6"
}Response schema
For successful responses, these resources describe the GSTN payload atdata.data.
View JSON schema
View Excel field reference
Headers
GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.
API key for identification
API version
Query Parameters
Financial year. E.g., FY 2023-24
Example:
"{{financial_year}}"
Response
200 - application/json
GSTR-1/GSTR-3B not filed / 200 Success
- Option 1
- Option 2
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