Cash Ledger

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"
}

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"
}

Headers

Authorization

string

required

Taxpayer access token

x-api-key

string

required

API key for identification

x-api-version

string

default:1.0.0

API version

Query Parameters

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

Show child attributes

data.data

object

Show child attributes

data.data.cl_bal

object

Show child attributes

data.data.cl_bal.cessbal

object

Show child attributes

data.data.cl_bal.cessbal.fee

number

Example:

0

data.data.cl_bal.cessbal.intr

number

Example:

0

data.data.cl_bal.cessbal.oth

number

Example:

0

data.data.cl_bal.cessbal.pen

number

Example:

0

data.data.cl_bal.cessbal.tot

number

Example:

0

data.data.cl_bal.cessbal.tx

number

Example:

0

data.data.cl_bal.cgstbal

object

Show child attributes

data.data.cl_bal.cgstbal.fee

number

Example:

0

data.data.cl_bal.cgstbal.intr

number

Example:

0

data.data.cl_bal.cgstbal.oth

number

Example:

0

data.data.cl_bal.cgstbal.pen

number

Example:

0

data.data.cl_bal.cgstbal.tot

number

Example:

0

data.data.cl_bal.cgstbal.tx

number

Example:

0

data.data.cl_bal.desc

string

Example:

"Closing Balance"

data.data.cl_bal.igstbal

object

Show child attributes

data.data.cl_bal.igstbal.fee

number

Example:

0

data.data.cl_bal.igstbal.intr

number

Example:

0

data.data.cl_bal.igstbal.oth

number

Example:

0

data.data.cl_bal.igstbal.pen

number

Example:

0

data.data.cl_bal.igstbal.tot

number

Example:

0

data.data.cl_bal.igstbal.tx

number

Example:

0

data.data.cl_bal.sgstbal

object

Show child attributes

data.data.cl_bal.sgstbal.fee

number

Example:

0

data.data.cl_bal.sgstbal.intr

number

Example:

0

data.data.cl_bal.sgstbal.oth

number

Example:

0

data.data.cl_bal.sgstbal.pen

number

Example:

0

data.data.cl_bal.sgstbal.tot

number

Example:

0

data.data.cl_bal.sgstbal.tx

number

Example:

0

data.data.cl_bal.tot_rng_bal

number

Example:

0

data.data.fr_dt

string

Example:

"01/04/2024"

data.data.gstin

string

Example:

"24AAACQ3770E1ZP"

data.data.op_bal

object

Show child attributes

data.data.op_bal.cessbal

object

Show child attributes

data.data.op_bal.cessbal.fee

number

Example:

0

data.data.op_bal.cessbal.intr

number

Example:

0

data.data.op_bal.cessbal.oth

number

Example:

0

data.data.op_bal.cessbal.pen

number

Example:

0

data.data.op_bal.cessbal.tot

number

Example:

0

data.data.op_bal.cessbal.tx

number

Example:

0

data.data.op_bal.cgstbal

object

Show child attributes

data.data.op_bal.cgstbal.fee

number

Example:

0

data.data.op_bal.cgstbal.intr

number

Example:

0

data.data.op_bal.cgstbal.oth

number

Example:

0

data.data.op_bal.cgstbal.pen

number

Example:

0

data.data.op_bal.cgstbal.tot

number

Example:

0

data.data.op_bal.cgstbal.tx

number

Example:

0

data.data.op_bal.desc

string

Example:

"Opening Balance"

data.data.op_bal.igstbal

object

Show child attributes

data.data.op_bal.igstbal.fee

number

Example:

0

data.data.op_bal.igstbal.intr

number

Example:

0

data.data.op_bal.igstbal.oth

number

Example:

0

data.data.op_bal.igstbal.pen

number

Example:

0

data.data.op_bal.igstbal.tot

number

Example:

0

data.data.op_bal.igstbal.tx

number

Example:

0

data.data.op_bal.sgstbal

object

Show child attributes

data.data.op_bal.sgstbal.fee

number

Example:

0

data.data.op_bal.sgstbal.intr

number

Example:

0

data.data.op_bal.sgstbal.oth

number

Example:

0

data.data.op_bal.sgstbal.pen

number

Example:

0

data.data.op_bal.sgstbal.tot

number

Example:

0

data.data.op_bal.sgstbal.tx

number

Example:

0

data.data.op_bal.tot_rng_bal

number

Example:

0

data.data.to_dt

string

Example:

"11/04/2024"

data.data.tr

any[]

Example:

[]

data.error

object

Show child attributes

data.error.error_cd

string

Example:

"LG9089"

data.error.message

string

Example:

"To Date cannot be beyond the current date"

data.status_cd

string

Example:

"0"

timestamp

number

Example:

1763446641000

transaction_id

string

Example:

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

Cash ITC Balance

ITC Ledger

⌘I

Analytics

Compliance

Headers

Query Parameters

Response