Upload GSTR-3B

GSTR-3B return is a simplified summary that you must file every month as a registered taxpayer. Sandbox API to upload GSTR-3B to GST Network.

Overview

  • Upload GSTR-3B RAW_BODY to GSTN System for the authenticated taxpayer for a particular year and month.

Endpoint

HTTP MethodResourceDescription
POST/gsp/tax-payer/{gstin}/gstrs/gstr-3b/{year}/{month}Takes in gstin, year and month and JSON RAW_BODY to upload it on to GSTN.

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

Sample cURL Request

curl --request POST \
		 --url https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/gstrs/gstr-3b/2020/01 \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0' \
     --data '
{
    "gstin": "05AVHPB7348G1ZP",
    "ret_period": "042017",
    "sup_details": {
        "osup_det": {
            "txval": 250,
            "iamt": 100,
            "camt": 200,
            "samt": 300,
            "csamt": 400
        },
        "osup_zero": {
            "txval": 250,
            "iamt": 100,
            "csamt": 400
        },
        "osup_nil_exmp": {
            "txval": 250
        },
        "isup_rev": {
            "txval": 250,
            "iamt": 100,
            "camt": 200,
            "samt": 300,
            "csamt": 400
        },
        "osup_nongst": {
            "txval": 250
        }
    },
    "inter_sup": {
        "unreg_details": [
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            },
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            },
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            }
        ],
        "comp_details": [
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            },
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            },
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            }
        ],
        "uin_details": [
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            },
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            },
            {
                "pos": "07",
                "txval": 250,
                "iamt": 200
            }
        ]
    },
    "eco_dtls": {
        "eco_sup": {
            "txval": 250,
            "iamt": 100,
            "camt": 200,
            "samt": 300,
            "csamt": 400
        },
        "eco_reg_sup": {
            "txval": 250
        }
    },
    "itc_elg": {
        "itc_avl": [
            {
                "ty": "IMPG",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            },
            {
                "ty": "IMPS",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            },
            {
                "ty": "ISRC",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            },
            {
                "ty": "ISD",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            },
            {
                "ty": "OTH",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            }
        ],
        "itc_rev": [
            {
                "ty": "RUL",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            },
            {
                "ty": "OTH",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            }
        ],
        "itc_net": {
            "iamt": 136.53,
            "camt": 274,
            "samt": 162.99,
            "csamt": 103
        },
        " itc_inelg": [
            {
                "ty": "RUL",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            },
            {
                "ty": "OTH",
                "iamt": 136.53,
                "camt": 274,
                "samt": 162.99,
                "csamt": 103
            }
        ]
    },
    "inward_sup": {
        "isup_details": [
            {
                "ty": "GST",
                "inter": 100,
                "intra": 200
            },
            {
                "ty": "NONGST",
                "inter": 300,
                "intra": 400
            }
        ]
    },
    "intr_ltfee": {
        "intr_details": {
            "iamt": 10,
            "camt": 20,
            "samt": 30,
            "csamt": 40
        }
    }
}
'

❗️

Test Environment Not Available

Request Body

RAW_BODY

ParamTypeDescriptionExample
gstinstringSupplier GSTIN24AAACJ3770E2ZZ
ret_periodnumReturn period022020
sup_detailsobjectDetails of Outward Supplies and inward supplies liable to reverse chargeLook Below
inter_supobjectDetails of inter-State supplies made to unregistered persons, composition taxable persons and UIN holdersLook Below
eco_dtlsobjectSupplies notified under section 9(5) of the CGST Act, 2017Look Below
itc_elgobjectEligible ITCLook Below
inward_supobjectValues of exempt, nil-rated and non-GST inward suppliesLook Below
intr_ltfeeobjectInterest & late fee payableLook Below

sup_details object

ParamTypeDescriptionParentExample
osup_nil_exmpobjectOther outward supplies (Nil rated, exempted)sup_details"txval": 250
osup_nongstobjectNon-GST outward suppliessup_details"txval": 250
osup_zeroobjectOutward taxable supplies (zero rated )sup_details"txval": 250,
"iamt": 100,
"csamt": 400
osup_detobjectOutward taxable supplies (other than zero rated, nil rated and exempted)sup_details"txval": 250,
"iamt": 100,
"camt": 200,
"samt": 300,
"csamt": 400
isup_revobjectInward supplies (liable to reverse charge)sup_details"txval": 250,
"iamt": 100,
"camt": 200,
"samt": 300,
"csamt": 400
txvalnumTotal Taxable valueosup_det200
iamtnumIntegrated Tax amount available in the current monthosup_det200
camtnumCentral Tax amount available in the current monthosup_det200
samtnumState/UT Tax amount available in the current monthosup_det200
csamtnumCess Tax amount available in the current monthosup_det200

inter_sup object

ParamTypeDescriptionParentExample
comp_detailsarraySupplies made to Composition Taxable Personsinter_sup{
"pos": "07",
"txval": 250,
"iamt": 200
}
uin_detailsarraySupplies made to UIN holdersinter_sup{
"pos": "07",
"txval": 250,
"iamt": 200
}
unreg_detailsarraySupplies made to Unregistered Personsinter_sup{
"pos": "07",
"txval": 250,
"iamt": 200
}
posstringPlace of Supply (State/UT)comp_details"07"
iamtnumIGST Amount as per invoicecomp_details200
txvalnumTaxable Valuecomp_details250

eco_dtls object

ParamTypeDescriptionParentExample
eco_supobjectTaxable supplies on which electronic commerce operator pays tax u/s 9(5)eco_dtls"txval": 250,
"iamt": 100,
"camt": 200,
"samt": 300,
"csamt": 400
eco_reg_supobjectTaxable supplies made by registered person through electronics commerce operatoreco_dtls"txval": 250
txvalnumTaxable Valueeco_sup250
iamtnumIntegrated Tax amount available in the current montheco_sup100
camtnumCentral Tax amount available in the current montheco_sup200
samtnumState/UT Tax amount available in the current montheco_sup300
csamtnumCess Tax amount available in the current montheco_sup400

itc_elg object

ParamTypeDescriptionParentExample
itc_avlarrayITC Available (whether in full or part)itc_elg{
"ty": "IMPG",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
}
itc_revarrayITC Reverseditc_elg{
"ty": "RUL",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
}
itc_netobjectNet ITC Availableitc_elg"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
itc_inelgarrayIneligible ITCitc_elg{
"ty": "OTH",
"iamt": 136.53,
"camt": 274,
"samt": 162.99,
"csamt": 103
}
tystringIdentifier if Goods or Services. Possible values: IMPG, IMPS, ISRC, ISD, RUL, OTHitc_avl"RUL"
iamtnumIntegrated Tax amount available in the current monthitc_avl136.53
camtnumCGST Amount as per invoiceitc_avl274
samtnumSGST Amount as per invoiceitc_avl162.99
csamtnumCess Tax amount available in the current monthitc_avl103

inward_sup object

ParamTypeDescriptionParentExample
isup_detailsarrayInward Supply Detailsinward_sup{
"ty": "GST",
"inter": 100,
"intra": 200
}
intranumIntra - State suppliesisup_details400
tystringIdentifer if Goods or Services. Possible values: GST", NONGSTisup_details"GST"
internumInter - State suppliesisup_details100

intr_ltfee object

ParamTypeDescriptionExample
intr_detailsobjectInterest Paid"iamt": 10,
"camt": 20,
"samt": 30,
"csamt": 40

Response

The response includes the following GSTR-3B details below

ParamTypeDescriptionExample
reference_idstring243255

Response Caching

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

Wallet Charges

Since Upload GSTR-3B 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