GSTR-2A is a purchase-related document that is provided to each business registered on the GST portal. Sandbox API for getting all business-to-business(B2B) invoices in GSTR 2A for a return period of the authenticated taxpayer.


  • Get all B2B invoices in GSTR 2A for the authenticated taxpayer (gstin) for a return period (year and month).
  • You also need to provide the ctin, the counter party's GSTIN for which you need the B2B invoices.


HTTP MethodResourceDescription
Get{gstin}/gstrs/gstr-1/at/{year}/{month}Takes in gstin, year and month, ctin and returns B2B invoices.

API Endpoint  Contact Us  Free Trial


Follow the below guidelines to pass GSTIN, year & month for getting B2B invoice details.

Path Parameters

gstinstring15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime22AAAAA0000A1Z5
yearstringYear for which Advance Tax needs to be fetched.2020
monthstringMonth for which Advance Tax needs to be fetched.01

Query Parameters

ctinstringCounter party GSTIN22AABAA0000A1Z

Once the values are added, Your curl will look something like this

curl --request GET \
     --url '' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'


Test Environment Not Available


The response includes the following business-to-business(B2B) invoice details below

  • b2b entity
ctinstringGSTIN/UID of the Supplier taxpayer/UN, Govt Bodies01AABCE2207R1Z5
cfsstringcounter party Filing Status of GSTR1/5y
cfs3bstringGSTR3B filing status"Y/N"
dtcancelstringDate of cancellation of supplier27-Aug-19
fldtr1stringDate of filing GSTR1/5 of supplier27-Aug-19
flprdr1stringFiling period of GSTR1/5 of supplierAug-19
invobjectlook belowlook below
  • inv entity
inumstringSupplier Invoice NumberS008400
idtstringSupplier Invoice Date24-11-2016
oinumstringOriginal Invoice NumberS008400
oidtstringOriginal Invoice Date03-02-2016
valstringSupplier Invoice Value729248
posstringPlace of supply06
rchrgstringReverse ChargeN
inv_typstringflag to determine invoice typeR
diff_percentstringDifferential Percentage0.65
aspdstringReturn period in which original invoice is visibleDec-19
atypstringflag to determine type of amendment"R- Receiver GSTIN Amended
N- Invoice Number Amended
D- Details Amended"
itmsobjectLook Below
  • itms entity
rtnumTax Rate5
txvalnumTaxable value of Goods or Service as per invoice6210.99
iamtnumIGST Amount as per invoice9
camtnumCGST Amount as per invoice614.44
samtnumSGST Amount as per invoice5.68
csamtnumCESS Amount as per invoice621.09

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since GSTR-2A B2B is not a Paid API, no wallet charge will take place.


This API is currently in major version 1.0. Refer to our versioning policies here