GSTR-2A is a purchase-related document that is provided to each business registered on the GST portal. Sandbox API for getting credit/debit notes in GSTR 2A for a return period of the authenticated taxpayer.
Overview
- Get all credit/debit notes in GSTR-2A for a return period (
year
andmonth
) for the authenticated taxpayer (gstin
). - You also need to provide the
ctin
, the counter party's GSTIN for which you need notes.
Endpoint
HTTP Method | Resource | Description |
---|---|---|
Get | gsp/tax-payer/{gstin}/gstrs/gstr-2a/cdn/{year}/{month}?ctin={ctin} | Takes in gstin , year and month and ctin returns amended advance tax details. |
Path Parameters
Param | Type | Description | Example |
---|---|---|---|
gstin | string | 15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime | 22AAAAA0000A1Z5 |
year | string | Year for which Advance Tax needs to be fetched. | 2020 |
month | string | Month for which Advance Tax needs to be fetched. | 01 |
Query Parameters
Param | Type | Description | Example |
---|---|---|---|
ctin | string | Counter party GSTIN | 22AABAA0000A1Z |
Once the values are added, Your curl will look something like this
curl --request GET \
--url 'https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/gstrs/gstr-2a/cdn/2020/01?ctin=22AABAA0000A1Z' \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0'
Test Environment Not Available
Response
The response includes the following credit/debit note in GSTR-2A details below
cdn
entity
Param | Type | Description | Example |
---|---|---|---|
ctin | string | GSTIN/UID of the Supplier taxpayer/UN, Govt Bodies | 01AABCE2207R1Z5 |
cfs | string | counter party Filing Status of GSTR1/5 | y |
cfs3b | string | GSTR3B filing status | "Y/N" |
dtcancel | string | Date of cancellation of supplier | 27-Aug-19 |
fldtr1 | string | Date of filing GSTR1/5 of supplier | 27-Aug-19 |
flprdr1 | string | Filing period of GSTR1/5 of supplier | Aug-19 |
inv | object | look below | look below |
inv
entity
Param | Type | Description | Example |
---|---|---|---|
chksum | string | Invoice Check sum value | AflJufPlFStqKBZ |
ntty | string | Note type | c |
nt_num | string | Debit/Credit Note number | 533515 |
nt_dt | string | Credit date | 23-09-2016 |
p_gst | string | Pre GST Regime Dr./ Cr. Notes | N |
inum | string | Invoice Number | 915914 |
idt | string | Invoice Date | 24-11-2016 |
val | string | Note Value | 729248 |
diff_percent | string | Differential Percentage | 0.65 |
cflag | string | counter party flag | A |
upbdy | string | Invoice Uploader | R |
d_flag | string | delink flag | Y |
inv_typ | string | Invoice type | R |
pos | string | Place of supply | 06 |
rchrg | string | Reverse Charge | N |
itms | object | Look Below | |
aspd | string | Return period in which invoice is amended | Dec-19 |
atyp | string | flag to determine type of amendment | "R- Receiver GSTIN Amended N- Note Number Amended D- Details Amended" |
srctyp | string | Source Type of IRN | Einvoice |
irn | string | IRN number | 897ADG56RTY78956HYUG90BNHHIJK453GFTD99845672FDHHHSHGFH4567FG56TR |
irngendate | string | IRN generation Date | 03-02-2016 |
itms
entity
Param | Type | Description | Example |
---|---|---|---|
rt | num | tax rate | 5 |
txval | num | Taxable value of Goods or Service as per invoice | 6210.99 |
iamt | num | IGST Amount as per invoice | 9 |
camt | num | CGST Amount as per invoice | 614.44 |
samt | num | SGST Amount as per invoice | 5.68 |
csamt | num | CESS Amount as per invoice | 621.09 |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since GSTR-2A CDN is not a Paid API, no wallet charge will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here