GSTR-2A
GSTR-2A is a purchase-related document that is provided to each business registered on the GST portal. Sandbox API for getting an aggregate summary of GSTR-2A data of authenticated taxpayers.
Overview
- Get a summary in GSTR2A for a return period (
year
andmonth
) for the authenticated taxpayer (gstin
). - This is an aggregate API that combines B2B, B2BA, CDN, CDNA, and ISD API.
Endpoint
HTTP Method | Resource | Description |
---|---|---|
GET | /gsp/tax-payer/{gstin}/gstrs/gstr-2a/{year}/{month} | Takes in gstin , year and month and returns GSTR-2A sumary. |
Path Parameters
Param | Type | Description | Example |
---|---|---|---|
gstin | string | 15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime | AAAAA0000A |
year | string | Year for which Advance Tax needs to be fetched. | 2020 |
month | string | Month for which Advance Tax needs to be fetched. | 01 |
Once the values are added, Your curl will look something like this
curl --request GET \
--url https://api.sandbox.co.in/gsp/tax-payer/AAAAA0000A/gstrs/gstr-2a/2020/01 \
--header 'Accept: application/json' \
--header 'Authorization: xxxxxxxxx' \
--header 'x-api-key: xxxxxxxxx' \
--header 'x-api-version: 1.0'
Test Environment Not Available
Response
The response includes the following GSTR-2A summary details below
data
entity
Param | Type | Description | Example |
---|---|---|---|
gstin | string | 15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime | AAAAA0000A |
f[ | string | 20 | |
b2b | object | look below | look below |
cdn | object | look below | look below |
b2b
entity
Param | Type | Description | Example |
---|---|---|---|
ctin | string | 01AABCE2207R1Z5 | |
cfs | string | y | |
inv | object | Look Below | Look Below |
inv
Param | Type | Description | Example |
---|---|---|---|
inum | string | S008400 | |
idt | string | 24-11-2016 | |
val | num | 729248 | |
pos | string | 06 | |
rchrg | string | N | |
inv_typ | string | R | |
diff_percent | num | 0.65 | |
itms | object | Look Below | Look Below |
itms
entity
Param | Type | Description | Example |
---|---|---|---|
num | num | 5 | |
rt | num | 6210.99 | |
txval | num | 0 | |
iamt | num | 614.44 | |
camt | num | 4.68 | |
samt | num | 621.09 | |
csamt | num | 231 |
cdn
entity
Param | Type | Description | Example |
---|---|---|---|
ctin | string | AflJufPlFStqKBZ | |
ntty | string | C | |
nt_num | string | 533515 | |
nt_dt | string | 23-09-2016 | |
p_gst | string | N | |
inum | string | 915914 | |
idt | string | 23-09-2016 | |
val | num | 729248 | |
diff_percent | num | 0.65 | |
cflag | string | A | |
upbdy | string | R | |
d_flag | string | Y | |
inv_typ | string | R | |
pos | string | 06 | |
rchrge | string | N | |
itms | object | Look Above | Look Above |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since GSTR-2A is a Paid API, a wallet charge of INR 0.25 + GST per API call will be applicable.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 5 months ago