GSTR-1 is a sales return that is required to be filed by every GST-registered person or entity. Sandbox API for getting amended business-to-business(B2BA) invoice details for a return period of the authenticated taxpayer.


  • Get all B2B "amended" invoices for a return period for the authenticated taxpayer (gstin) for the particular year and month.
  • You also need to provide the ctin, the counter party's GSTIN for which you need the B2B invoices.
  • The result can be further filtered by adding from date and action_required. The action_required filter is used for filter invoices where the taxpayer has some pending actions.


HTTP MethodResource

API Endpoint  Contact Us  Free Trial


Follow the below guidelines to pass GSTIN, year & month for getting amended business-to-business(B2BA) invoice details.

Path Parameters

gstinstring15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime22AAAAA0000A1Z5
yearstringYear for which amended B2B invoices need to be fetched.2020
monthstringMonth for which amended B2B invoices need to be fetched.01

Query Parameters

ctinstringCounter party GSTIN22AABAA0000A1Z
action_requiredstringStatus 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 taxpayer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.Y
fromstringFrom Date (DD/MM/YYYY)21/11/2020

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 amended business-to-business(B2BA) invoice details below

  • B2B Invoices
ctinstringGSTIN/UID of the Receiver taxpayer/UN, Govt Bodies06ADECO9084R5Z4
cfsstringGSTR2 filing status of counter partyY (Yes) or N (No)
List{inv}Invoice DetailsRefer to the Table below
  • Invoice Details
flagstringInvoice StatusN - No Action
updbystringUploaded byR - Receiver
S - Supplier
chksumstringInvoice Check sum valueAflJufPlFStqKBZ
oinumstringOriginal Supplier Invoice NumberS008400
oidtstringSupplier Invoice Date
inumstringSupplier Invoice NumberS008400
idtstringSupplier Invoice Date03-02-2016
valnumSupplier Invoice Value10000.00
posstring Place of Supply (statecode)04
rchrgstringReverse ChargeY- Yes
N - No
inv_typstringInvoice typeR - Regular B2B Invoices
DE - Deemed Exports
SEWP - SEZ Exports with payment
SEWOP - SEZ exports without payment
CBW - Custom Bonded Warehouse
cflagstringCounter Party FlagA - Accepted
R - Rejected
M - Modified
N - No action
U - Uploaded
P - Pending
DF - Deferred
FR - Forward
opdnumOriginal Period
diff_percentnumDifferential percentage.65 (65%)
list {itms}ItemRefer to the table below
  • Items
numnumSerial no2
itm_detItem DetailsRefer to the table below
  • Item Details
rtnumRate of Invoice10
txvalnumTaxable value of Goods or Service as per invoice10000.00
iamtnumIGST Amount as per invoice650.00
camtnumCGST Amount as per invoice650.00
samtnumSGST Amount as per invoice650.00
csamtnumCess Amount as per invoice650.00

Response Caching

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

Wallet Charges

Since GSTR-1 B2BA 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