Contact UsSupportSignup

GSTR-3B Summary

GSTR-3B return is a simplified summary that you must file every month as a registered taxpayer. Sandbox API to get a summary of GSTR-3B for a return period of the authenticated taxpayer.

Suggest Edits

API Pricing Image

Overview

  • Get a summary in GSTR-3B for a return period (year and month) for the authenticated taxpayer (gstin).

Endpoint

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

API Endpoint  Contact Us  Free Trial

Path Parameters

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

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-3b/2020/01 \
     --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-3B summary details below

Data Entity

ParamTypeDescriptionExample
gstinstringA 15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime24AAACJ3770E2ZZ
ret_periodstringReturn Period032020
tx_pmtobjectPayment of taxLook Below
sup_detailsobjectDetails of Outward Supplies and inward supplies liable to reverse chargeLook Below
sup_interobjectDetails of inter-State supplies made to unregistered persons, composition taxable persons, and UIN holdersLook Below
itc_elgobjectEligible ITCLook Below
eco_dtlsobjectSupplies notified in section 9(5) of the CGST Act,2017Look Below
inward_supobjectValues of exempt, nil-rated and non-GST inward suppliesLook Below
intr_ltfeeobjectInterest & late fee payableLook Below
liab_breakupobjectLiability breakup declared by taxpayerLook Below

tx_pmt entity

ParamTypeDescriptionExample
pdcashobjectList of Paid Through CashLook Below
pditcobjectPaid Through CreditLook Below
tx_pyobjectTax PayableLook Below

pdcash entity

ParamTypeDescriptionExample
liab_ldg_idnumList of Paid Through Cash12313
tran_typnumPaid Through Credit30002/30003
ipdnumIGST paid10002.00
cpdnumCGST paid100.00
spdnumSGST paid789.00
cspdnumCess paid524.00
cspdnumCess paid524.00
i_intrpdnumInterest Paid against IGST524.00
c_intrpdnumInterest Paid against CGST524.00
s_intrpdnumInterest Paid against SGST524.00
cs_intrpdnumInterest Paid against CESS524.00
c_lfeepdnumLate Fee Paid against CGST524.00
s_lfeepdnumLate Fee Paid against SGST524.00

pditc entity

ParamTypeDescriptionExample
i_pdinumIGST paid using IGST100.00
i_pdcnumIGST paid using CGST2003.00
i_pdsnumIGST paid using SGST789.12
c_pdinumCGST paid using IGST415.00
c_pdcnumCGST paid using CGST124.00
s_pdinumSGST paid using IGST45.00
s_pdsnumSGST paid using SGST147.00
cs_pdcsnumCess paid using cess58.00

tx_py entity

ParamTypeDescriptionExample
liab_ldg_idnumLiability ledgerid253121441
trans_typnumtransaction type30002
tran_descstringtransaction descriptionOther than Reverse Charg
sgstobjectSGST details"intr": 0,
"tx": 0,
"fee": 0
igstobjectIGST details"intr": 0,
"tx": 0
cgstobjectCGST details"intr": 0,
"tx": 0,
"fee": 0
cessobjectCESS details"intr": 0,
"tx": 0

sup_details entity

ParamTypeDescriptionExample
osup_zeroobjectOutward taxable supplies (zero rated)"samt": 0,
"csamt": 0,
"txval": 0,
"camt": 0,
"iamt": 0
osup_nil_exmpobjectOther outward supplies (Nil rated, exempted)"samt": 0,
"csamt": 0,
"txval": 0,
"camt": 0,
"iamt": 0
osup_nongstobjectNon-GST outward supplies"samt": 0,
"csamt": 0,
"txval": 0,
"camt": 0,
"iamt": 0
osup_detobjectOutward taxable supplies (other than zero rated, nil rated and exempted)"samt": 0,
"csamt": 0,
"txval": 0,
"camt": 0,
"iamt": 0
isup_revobjectInward supplies (liable to reverse charge)"samt": 0,
"csamt": 0,
"txval": 0,
"camt": 0,
"iamt": 0

sup_inter entity

ParamTypeDescriptionExample
unreg_detailsobjectSupplies made to Unregistered Persons"pos": "10"
"txval": 10998
"iamt": 1979.64
comp_detailsobjectSupplies made to Composition Taxable Persons"pos": "10"
"txval": 10998
"iamt": 1979.64
uin_detailsobjectSupplies made to UIN holders"pos": "10"
"txval": 10998
"iamt": 1979.64

itc_elg entity

ParamTypeDescriptionExample
itc_avlobjectITC Available (whether in full or part)"samt": 0,
"csamt": 0,
"ty": "IMPG",
"camt": 0,
"iamt": 0
itc_netobjectNet ITC Available"samt": 0,
"csamt": 0,
"camt": 0,
"iamt": 0
itc_revobjectITC Reversed"samt": 0,
"csamt": 0,
"ty": "RUL",
"camt": 0,
"iamt": 0
itc_inelgobjectIneligible ITC"samt": 0,
"csamt": 0,
"ty": "RUL",
"camt": 0,
"iamt": 0

eco_dtls entity

ParamTypeDescriptionExample
eco_supstringTaxable supplies on which electronic commerce operator pays tax u/s 9(5)"samt": 0,
"csamt": 0,
"txval": "0",
"camt": 0,
"iamt": 0
eco_reg_supstringTaxable supplies made by registered person trhough electronics commerce operator"txval": "0"

inward_sup entity

ParamTypeDescriptionExample
tystringtypeGST/NONGST
internumInter - State supplies200.00
intranumIntra - State supplies200.00

intr_ltfee entity

ParamTypeDescriptionExample
intr_detailsstringInterest"samt": 0,
"csamt": 0,
"camt": 0,
"iamt": 0
ltfee_detailsobjectInterest"samt": 0,
"camt": 0

liab_breakup entity

ParamTypeDescriptionExample
ret_periodstringReturn period of the breakup120202
liabilityobjectLiability declared by taxpayer"samt": 0,
"csamt": 0,
"camt": 0,
"iamt": 0

Response Caching

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

Wallet Charges

Since GSTR-3B Summary is a Paid API, a wallet charge of INR 0.25 + GST per API call will be applicable.

Versioning

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

Updated 3 months ago