Cash ITC Balance

Cash ITC Balance

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/bal/{year}/{month} \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

{
  "code": 200,
  "data": {
    "data": {
      "cash_bal": {
        "cess": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "cess_tot_bal": 0,
        "cgst": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "cgst_tot_bal": 0,
        "igst": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "igst_tot_bal": 0,
        "sgst": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "sgst_tot_bal": 0
      },
      "gstin": "29AAACQ3770E000",
      "itc_bal": {
        "cess_bal": 0,
        "cgst_bal": 0,
        "igst_bal": 0,
        "sgst_bal": 0
      },
      "itc_blck_bal": {
        "cess_blck_bal": 0,
        "cgst_blck_bal": 0,
        "igst_blck_bal": 0,
        "sgst_blck_bal": 0
      }
    },
    "status_cd": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "401d25c5-c6bf-47c3-a7f2-7e396c7ca331"
}

GET

gst

compliance

tax-payer

ledgers

bal

{year}

{month}

Cash ITC Balance

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/ledgers/bal/{year}/{month} \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

{
  "code": 200,
  "data": {
    "data": {
      "cash_bal": {
        "cess": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "cess_tot_bal": 0,
        "cgst": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "cgst_tot_bal": 0,
        "igst": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "igst_tot_bal": 0,
        "sgst": {
          "fee": 0,
          "intr": 0,
          "oth": 0,
          "pen": 0,
          "tx": 0
        },
        "sgst_tot_bal": 0
      },
      "gstin": "29AAACQ3770E000",
      "itc_bal": {
        "cess_bal": 0,
        "cgst_bal": 0,
        "igst_bal": 0,
        "sgst_bal": 0
      },
      "itc_blck_bal": {
        "cess_blck_bal": 0,
        "cgst_blck_bal": 0,
        "igst_blck_bal": 0,
        "sgst_blck_bal": 0
      }
    },
    "status_cd": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "401d25c5-c6bf-47c3-a7f2-7e396c7ca331"
}

Headers

Authorization

string

required

Taxpayer access token

x-api-version

string

default:1.0.0

API version

x-api-key

string

required

API key for identification

Path Parameters

year

string

required

Year e.g. 2020

Example:

"{{year}}"

month

string

required

Month e.g. 01

Example:

"{{month}}"

Response

200 - application/json

200 Success

code

number

Example:

200

data

object

Show child attributes

data.data

object

Show child attributes

data.data.cash_bal

object

Show child attributes

data.data.cash_bal.cess

object

Show child attributes

data.data.cash_bal.cess.fee

number

Example:

0

data.data.cash_bal.cess.intr

number

Example:

0

data.data.cash_bal.cess.oth

number

Example:

0

data.data.cash_bal.cess.pen

number

Example:

0

data.data.cash_bal.cess.tx

number

Example:

0

data.data.cash_bal.cess_tot_bal

number

Example:

0

data.data.cash_bal.cgst

object

Show child attributes

data.data.cash_bal.cgst.fee

number

Example:

0

data.data.cash_bal.cgst.intr

number

Example:

0

data.data.cash_bal.cgst.oth

number

Example:

0

data.data.cash_bal.cgst.pen

number

Example:

0

data.data.cash_bal.cgst.tx

number

Example:

0

data.data.cash_bal.cgst_tot_bal

number

Example:

0

data.data.cash_bal.igst

object

Show child attributes

data.data.cash_bal.igst.fee

number

Example:

0

data.data.cash_bal.igst.intr

number

Example:

0

data.data.cash_bal.igst.oth

number

Example:

0

data.data.cash_bal.igst.pen

number

Example:

0

data.data.cash_bal.igst.tx

number

Example:

0

data.data.cash_bal.igst_tot_bal

number

Example:

0

data.data.cash_bal.sgst

object

Show child attributes

data.data.cash_bal.sgst.fee

number

Example:

0

data.data.cash_bal.sgst.intr

number

Example:

0

data.data.cash_bal.sgst.oth

number

Example:

0

data.data.cash_bal.sgst.pen

number

Example:

0

data.data.cash_bal.sgst.tx

number

Example:

0

data.data.cash_bal.sgst_tot_bal

number

Example:

0

data.data.gstin

string

Example:

"29AAACQ3770E000"

data.data.itc_bal

object

Show child attributes

data.data.itc_bal.cess_bal

number

Example:

0

data.data.itc_bal.cgst_bal

number

Example:

0

data.data.itc_bal.igst_bal

number

Example:

0

data.data.itc_bal.sgst_bal

number

Example:

0

data.data.itc_blck_bal

object

Show child attributes

data.data.itc_blck_bal.cess_blck_bal

number

Example:

0

data.data.itc_blck_bal.cgst_blck_bal

number

Example:

0

data.data.itc_blck_bal.igst_blck_bal

number

Example:

0

data.data.itc_blck_bal.sgst_blck_bal

number

Example:

0

data.status_cd

string

Example:

"1"

timestamp

number

Example:

1763446641000

transaction_id

string

Example:

"401d25c5-c6bf-47c3-a7f2-7e396c7ca331"

Save Filing Preference

Cash Ledger

⌘I

Analytics

Compliance

Headers

Path Parameters

Response