GSTR-2B

GSTR 2B is an auto-drafted document that will act as an Input Tax Credit (ITC) statement for taxpayers. Sandbox API to get the summary in GSTR-2B for a return period of the authenticated taxpayer.

Overview

Get a summary in GSTR2B for a return period (year and month) for the authenticated taxpayer (gstin).

Endpoint

HTTP MethodResourceDescription
GET/gsp/tax-payer/{gstin}/gstrs/gstr-2b/{year}/{month}Takes in gstin, year and month and returns GSTR-2B summary.

API Endpoint  Contact Us  Free Trial

Request

Path Parameters

ParamTypeDescriptionExample
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 Parameter

ParamTypeDescriptionExample
file_numberint32If 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 count2

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-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


Response

The response includes the following GSTR-2B summary details below

  • data entity
ParamTypeDescriptionExample
itcsummobjectITC summary
itcavlobjectITC Available SummaryUnder itcsumm entity, Refer to itcavl entity
rtnprdstringReturn Period082021
docdataobjectDocument datarefer to docdata entity
gendtstringGSTR2B generation date14-09-2021
gstinstringGSTIN of the Receiver24AAACJ3770E2ZZ
versionstringVersion no1.0
cpsummobjectSupplier wise summaryrefer to cpsumm entity
  • itcavl entity
ParamTypeDescriptionExample
nonrevsupobjectNon reverse charge suppliesrefer to nonrevsup entity
  • nonrevsup entity
ParamTypeDescriptionExample
cgstnumCGST15867.66
sgstnumSGST15867.66
igstnumIGST128921.15
cessnumCESS0
b2bobjectB2B Summaryrefer to b2b entity below
  • b2b entity (under nonrevsup entity)
ParamTypeDescriptionExample
cgstnumCGST15867.66
sgstnumSGST15867.66
igstnumIGST128921.15
cessnumCESS0
  • docdata entity
ParamTypeDescriptionExample
b2bobjectB2B Summaryrefer to b2b entity below
  • b2b entity (under docdata entity)
ParamTypeDescriptionExample
invobject
trdnmstringTrade/Legal name of the supplierPNATH CORPORATIO
supfildtstringDate of filing GSTR1/5 of supplier12-08-2021
supprdstringFiling period of GSTR1/5 of supplier072021
ctinstringGstin of the supplier24AAAPA1234G1ZR
  • inv
ParamTypeDescriptionExample
dtstringInvoice Date08-07-2021
valnumInvoice Value8100
revenumSupply attracts reverse chargeN
itcavlenumITC AvailabilityY
diff_percentnumApplicable % of tax rate1
posstringPlace of supply24
typenumInvoice TypeR
inumstringInvoice Number190
rsnenumReason for ITC Unavailability
itmsobjectItemsRefer to itms entity
  • itms entity
ParamTypeDescriptionExample
sgstnumSGST Amount as per invoice147.62
rtnumTax Rate5
numnumItem Number1
txvalnumTotal Taxable value5904.76
cgstnumCGST Amount as per invoice147.62
cessnumCESS Amount as per invoice0
  • cpsumm entity
ParamTypeDescriptionExample
b2bobjectB2B Summaryrefer to b2b entity below
  • b2b entity (under cpsumm entity)
ParamTypeDescriptionExample
ttldocsstringTotal Documents1
trdnmstringTrade/Legal name of the supplierPNATH CORPORATIO
supfildtstringDate of filing GSTR1/5 of supplier12-08-2021
supprdstringFiling period of GSTR1/5 of supplier072021
txvalnumTotal Taxable Value7389.14
ctinstringGstin of the supplier24AAAPA1234G1ZR
sgstnumTotal SGST Value355.43
cgstnumTotal CGST Value355.43
igstnumTotal IGST Value0
cessnumTotal CESS Value0

Response Caching

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

Wallet Charges

Since GSTR-2B 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