---
title: "Cash Ledger"
method: GET
path: "/v1/gst/tax-payer/ledgers/cash"
tags: ["GST Taxpayer APIs"]
---

# Cash Ledger

`GET /v1/gst/tax-payer/ledgers/cash`

## Request

- Base URL: `https://api.deepvue.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.deepvue.ai/v1/gst/tax-payer/ledgers/cash`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `authorize`
- TypeScript: <https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/docs/v1/gst/tax-payer/ledgers/cash/get.ts> (a function with typed inputs; its response is checked against the schema)

- The E-Cash or Electronic Cash Ledger under GST displays all the amounts deposited for payment of tax, interest, fee, or penalty. It also reflects TDS (Tax Deducted at Source) and TCS (Tax Collected at Source) since they are tax deposits of the taxpayer.    
- The API takes in the gstin and the time period(from and to) for which you want to retrieve the Cash Ledger.

## Query parameters

- `gstin_number` string, required
- `from_date` string, required
- `to_date` string, required

## Response `200`

Successful Response

- union
  - RESPONSECASHLEDGERSUCCESSFUL
    - `data` CashLedgerData, required
      - `fr_dt` string, required
      - `to_dt` string, required
      - `cl_bal` ClBalObject, required
        - `igstbal` IgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `sgstbal` SgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `cessbal` CessBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `tot_rng_bal` integer, required
        - `cgstbal` CgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `desc` string, required
      - `gstin` string, required
      - `tr` ClTrObject[], required
        - `sgst` SgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `refNo` string, required
        - `dpt_dt` string, required
        - `sgstbal` SgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `cessbal` CessBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `cgst` CgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `cess` CessBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `tot_rng_bal` integer, required
        - `igst` IgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `tr_typ` string, required
        - `ret_period` string, required
        - `rpt_dt` string, required
        - `igstbal` IgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `dpt_time` string, required
        - `tot_tr_amt` integer, required
        - `cgstbal` CgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `desc` string, required
      - `op_bal` OpBalObject, required
        - `igstbal` IgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `sgstbal` SgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `cessbal` CessBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `cgstbal` CgstBalObject, required
          - `intr` integer, required
          - `oth` integer, required
          - `tx` integer, required
          - `fee` integer, required
          - `pen` integer, required
          - `tot` integer, required
        - `tot_rng_bal` integer, required
        - `desc` string, required
    - `code` integer, required
    - `timestamp` integer, required
    - `transaction_id` string, required
  - RESPONSEGSTAUTHENTICATIONFAILED
    - `data` object
    - `code` integer, required
    - `timestamp` integer, required
    - `transaction_id` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide.md) - [All operations](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/llms.txt) - [OpenAPI document](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/revisions/c1b0558e7d77?raw)