Skip to main content
GET
Get GSTR-1 TXPA

Response schema

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

View JSON schema

View Excel field reference

Headers

authorization
string
required
x-api-key
string
required

Public key required to authorize API access.

x-api-version
string
required

Path Parameters

year
string
required

Year e.g. 2020

month
string
required

Month e.g. 01

Query Parameters

counterparty_gstin
string

optional Counter party GSTIN

action_required
string

optional Status filter for filtering the invoices. Possible values: Y or N. Status filter for filtering the invoices. Use filter value Y to fetches the invoices where tax payer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.

from
string

optional From Date (DD/MM/YYYY)

Response

200 - application/json

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.