Skip to main content
GET
Get Cash Ledger

Response schema

For successful responses, these resources describe the GSTN payload at data.data.

View JSON schema

View Excel field reference

Authorizations

authorization
string
header
required

GST taxpayer access token returned by Verify OTP.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-api-version
string
default:1.0.0

API version

Query Parameters

to
string
required

End date of the ledger period in DD/MM/YYYY format.

Example:

"01/01/2024"

from
string
required

Start date of the ledger period in DD/MM/YYYY format.

Example:

"01/01/2023"

Response

200 - application/json

GSTN response. data.status_cd is "1" for success and "0" for a business error.

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code
enum<integer>
required

The HTTP status code reported in the response body.

Available options:
200
Example:

200

timestamp
integer<int64>
required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id
string
required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data
object
required

The GSTN success wrapper.