GSTR-1 is a sales return that is required to be filed by every GST-registered person or entity. Sandbox API for getting all Credit/Debit notes for a return period of the registered taxpayer.


  • Get all credit/debit notes for the authenticated taxpayer (gstin) for the particular year and month.
  • 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 all amended Credit/Debit notes for a return period.

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

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 Credit/Debit notes details below

  • B2B Invoices
ctinstringCounter party GSTIN20GRRHF2562D3A3
List{inv}Invoice DetailsRefer to the Table below
  • Credit Debit Note details
flagstringInvoice StatusN - No Action
updbystringUploaded byR - Receiver
S - Supplier
chksumstringInvoice Check sum valueAflJufPlFStqKBZ
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 type"R- 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,N-No action ,U-Uploaded, P-Pending, DF-Deferred, FR-Forward
opdnumOriginal Period
nttystringCredit/debit note typeC/D
nt_numstringCredit note/debit noteNT100001
nt_dtstringCredit Note/Debit Note
p_gststringPre GST Regime Dr./ Cr. NotesY/N
d_flagstringdelink flagY
srctypstringSource Type of IRNEinvoice
irnstringIRN number897ADG56RTY78956HYUG90BNHHIJK453GFTD99845672FDHHHSHGFH4567FG56TR
irngendatestringIRN generation Date
diff_percentnumDifferential percentage.65 (65%)
list {itms}ItemsRefer to the table below
  • Items
numnumSerial no2
itm_detItem DetailsRefer to the table below
  • Item Details
rtnumRate of Invoice5
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 CDNR 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