Skip to main content
GET
/
gst
/
compliance
/
tax-payer
/
ledgers
/
cash
Cash Ledger
curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/cash \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'
{
  "code": 200,
  "data": {
    "data": {
      "cl_bal": {
        "cessbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "cgstbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "desc": "Closing Balance",
        "igstbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "sgstbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "tot_rng_bal": 0
      },
      "fr_dt": "01/04/2024",
      "gstin": "24AAACQ3770E1ZP",
      "op_bal": {
        "cessbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "cgstbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "desc": "Opening Balance",
        "igstbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "sgstbal": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tot": 0,
          "tx": 0
        },
        "tot_rng_bal": 0
      },
      "to_dt": "11/04/2024",
      "tr": []
    },
    "status_cd": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "01459da0-b84b-4aab-9867-bb84e8c67348"
}

ā€‹
Response body schema

View response body schema

Headers

ā€‹
authorization
string
required

GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.

ā€‹
x-api-key
string
required

API key for identification

ā€‹
x-api-version
string
default:1.0.0

API version

Query Parameters

ā€‹
to
string

required To Date (DD/MM/YYYY)

Example:

"{{to_date}}"

ā€‹
from
string

From Date (DD/MM/YYYY)

Example:

"{{from_date}}"

Response

200 - application/json

LG9089 To date cannot be beyond the current date / 200 Success

ā€‹
code
number
Example:

200

ā€‹
data
object
ā€‹
timestamp
number
Example:

1763446641000

ā€‹
transaction_id
string
Example:

"6fd2b813-bc69-40cf-a033-2d4f319ef728"