Get a summary in GSTR2B for a return period (year and month) for the authenticated taxpayer (gstin).
HTTP Method Resource Description GET/gsp/tax-payer/{gstin}/gstrs/gstr-2b/{year}/{month} Takes in gstin, year and month and returns GSTR-2B summary.
Param Type Description Example gstin string15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime 22AAAAA0000A1Z5 year stringYear for which Advance Tax needs to be fetched. 2020 month stringMonth for which Advance Tax needs to be fetched. 01
Param Type Description Example file_number int32If total number of documents across sections of GSTR2B cross the specified limit then data will be maintained as chunks and summary data will be returned along with file count 2
Once the values are added, Your curl will look something like this
cURL
curl --request GET \
--url 'https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/gstrs/gstr-2b/2020/01?file_number=2' \
--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 GSTR-2B summary details below
Param Type Description Example itcsumm objectITC summary itcavl objectITC Available Summary Under itcsumm entity, Refer to itcavl entity rtnprd stringReturn Period 082021 docdata objectDocument data refer to docdata entity gendt stringGSTR2B generation date 14-09-2021 gstin stringGSTIN of the Receiver 24AAACJ3770E2ZZ version stringVersion no 1.0 cpsumm objectSupplier wise summary refer to cpsumm entity
Param Type Description Example nonrevsup objectNon reverse charge supplies refer to nonrevsup entity
Param Type Description Example cgst numCGST 15867.66 sgst numSGST 15867.66 igst numIGST 128921.15 cess numCESS 0 b2b objectB2B Summary refer to b2b entity below
b2b entity (under nonrevsup entity)
Param Type Description Example cgst numCGST 15867.66 sgst numSGST 15867.66 igst numIGST 128921.15 cess numCESS 0
Param Type Description Example b2b objectB2B Summary refer to b2b entity below
b2b entity (under docdata entity)
Param Type Description Example inv objecttrdnm stringTrade/Legal name of the supplier PNATH CORPORATIO supfildt stringDate of filing GSTR1/5 of supplier 12-08-2021 supprd stringFiling period of GSTR1/5 of supplier 072021 ctin stringGstin of the supplier 24AAAPA1234G1ZR
Param Type Description Example dt stringInvoice Date 08-07-2021 val numInvoice Value 8100 rev enumSupply attracts reverse charge N itcavl enumITC Availability Y diff_percent numApplicable % of tax rate 1 pos stringPlace of supply 24 typ enumInvoice Type R inum stringInvoice Number 190 rsn enumReason for ITC Unavailability itms objectItems Refer to itms entity
Param Type Description Example sgst numSGST Amount as per invoice 147.62 rt numTax Rate 5 num numItem Number 1 txval numTotal Taxable value 5904.76 cgst numCGST Amount as per invoice 147.62 cess numCESS Amount as per invoice 0
Param Type Description Example b2b objectB2B Summary refer to b2b entity below
b2b entity (under cpsumm entity)
Param Type Description Example ttldocs stringTotal Documents 1 trdnm stringTrade/Legal name of the supplier PNATH CORPORATIO supfildt stringDate of filing GSTR1/5 of supplier 12-08-2021 supprd stringFiling period of GSTR1/5 of supplier 072021 txval numTotal Taxable Value 7389.14 ctin stringGstin of the supplier 24AAAPA1234G1ZR sgst numTotal SGST Value 355.43 cgst numTotal CGST Value 355.43 igst numTotal IGST Value 0 cess numTotal CESS Value 0
Response caching is not available for this API. Learn more about our response caching mechanism here
Since GSTR-2B is a Paid API , a wallet charge of INR 0.25 + GST per API call will be applicable.
This API is currently in major version 1.0. Refer to our versioning policies here
