Skip to main content
POST
/
gst
/
compliance
/
tax-payer
/
gstrs
/
gstr-3b
/
{year}
/
{month}
/
file
File GSTR-3B
curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-3b/{year}/{month}/file \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "RAW_BODY": "{ \"gstin\": \"29HJKPS9689A8Z4\", \"ret_period\": \"072016\", \"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 } ] }, \"tx_pmt\": { \"tx_py\": [ { \"trans_typ\": 30002, \"trans_desc\": \"Other than reverse charge\", \"liab_ldg_id\": 11191, \"sgst\": { \"intr\": 100, \"tx\": 100, \"fee\": 100 }, \"cgst\": { \"intr\": 100, \"tx\": 100, \"fee\": 100 }, \"cess\": { \"intr\": 100, \"tx\": 100 }, \"igst\": { \"intr\": 100, \"tx\": 100 } }, { \"trans_typ\": 30003, \"trans_desc\": \"Reverse charge\", \"liab_ldg_id\": 11191, \"sgst\": { \"intr\": 100, \"tx\": 100, \"fee\": 100 }, \"cgst\": { \"intr\": 100, \"tx\": 100, \"fee\": 100 }, \"cess\": { \"intr\": 100, \"tx\": 100 }, \"igst\": { \"intr\": 100, \"tx\": 100 } } ], \"pdcash\": [ { \"liab_ldg_id\": 1233, \"trans_typ\": 30002, \"ipd\": 3517817, \"cpd\": 3517817, \"spd\": 3517817, \"cspd\": 3517817, \"i_intrpd\": 20, \"c_intrpd\": 30, \"s_intrpd\": 10, \"cs_intrpd\": 15, \"c_lfeepd\": 13, \"s_lfeepd\": 13 }, { \"liab_ldg_id\": 1233, \"trans_typ\": 30003, \"ipd\": 3517817, \"cpd\": 3517817, \"spd\": 3517817, \"cspd\": 3517817, \"i_intrpd\": 20, \"c_intrpd\": 30, \"s_intrpd\": 10, \"cs_intrpd\": 15, \"c_lfeepd\": 13, \"s_lfeepd\": 13 } ], \"pditc\": { \"liab_ldg_id\": 12321, \"trans_typ\": 30002, \"i_pdi\": 3517817, \"i_pdc\": 2290459, \"i_pds\": 2290459, \"c_pdi\": 3517817, \"c_pdc\": 2290459, \"s_pdi\": 3517817, \"s_pds\": 2290459, \"cs_pdcs\": 2290459 } }, \"intr_ltfee\": { \"intr_details\": { \"iamt\": 10, \"camt\": 20, \"samt\": 30, \"csamt\": 40 }, \"ltfee_details\": { \"camt\": 50, \"samt\": 60 } }, \"liab_breakup\": [ { \"ret_period\": \"032020\", \"liability\": { \"iamt\": 1000, \"camt\": 150, \"samt\": 200, \"csamt\": 300 } }, { \"ret_period\": \"022020\", \"liability\": { \"iamt\": 1000, \"camt\": 150, \"samt\": 200, \"csamt\": 300 } } ] }"
}'
{
  "code": 200,
  "data": {
    "data": {
      "ack_num": "AB2410242527396 19/11/2024 16:23"
    },
    "status_cd": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "72da34f0-d6d1-4056-92e1-734fc29f0249"
}

Headers

ā€‹
Authorization
string
required

Taxpayer access token

ā€‹
x-api-key
string
required

API key for identification

ā€‹
x-api-version
string
default:1.0.0

API version

Path Parameters

ā€‹
year
string
required

Year e.g. 2020

ā€‹
month
string
required

Month e.g. 01

Query Parameters

ā€‹
pan
string
required

PAN of the authorized signatory

Example:

"{{pan}}"

ā€‹
otp
string
required

Generated EVC OTP

Example:

"575757"

Body

application/json
ā€‹
RAW_BODY
string<json>
default:{ "gstin": "29HJKPS9689A8Z4", "ret_period": "072016", "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 } ] }, "tx_pmt": { "tx_py": [ { "trans_typ": 30002, "trans_desc": "Other than reverse charge", "liab_ldg_id": 11191, "sgst": { "intr": 100, "tx": 100, "fee": 100 }, "cgst": { "intr": 100, "tx": 100, "fee": 100 }, "cess": { "intr": 100, "tx": 100 }, "igst": { "intr": 100, "tx": 100 } }, { "trans_typ": 30003, "trans_desc": "Reverse charge", "liab_ldg_id": 11191, "sgst": { "intr": 100, "tx": 100, "fee": 100 }, "cgst": { "intr": 100, "tx": 100, "fee": 100 }, "cess": { "intr": 100, "tx": 100 }, "igst": { "intr": 100, "tx": 100 } } ], "pdcash": [ { "liab_ldg_id": 1233, "trans_typ": 30002, "ipd": 3517817, "cpd": 3517817, "spd": 3517817, "cspd": 3517817, "i_intrpd": 20, "c_intrpd": 30, "s_intrpd": 10, "cs_intrpd": 15, "c_lfeepd": 13, "s_lfeepd": 13 }, { "liab_ldg_id": 1233, "trans_typ": 30003, "ipd": 3517817, "cpd": 3517817, "spd": 3517817, "cspd": 3517817, "i_intrpd": 20, "c_intrpd": 30, "s_intrpd": 10, "cs_intrpd": 15, "c_lfeepd": 13, "s_lfeepd": 13 } ], "pditc": { "liab_ldg_id": 12321, "trans_typ": 30002, "i_pdi": 3517817, "i_pdc": 2290459, "i_pds": 2290459, "c_pdi": 3517817, "c_pdc": 2290459, "s_pdi": 3517817, "s_pds": 2290459, "cs_pdcs": 2290459 } }, "intr_ltfee": { "intr_details": { "iamt": 10, "camt": 20, "samt": 30, "csamt": 40 }, "ltfee_details": { "camt": 50, "samt": 60 } }, "liab_breakup": [ { "ret_period": "032020", "liability": { "iamt": 1000, "camt": 150, "samt": 200, "csamt": 300 } }, { "ret_period": "022020", "liability": { "iamt": 1000, "camt": 150, "samt": 200, "csamt": 300 } } ] }
required

Response

200 - application/json

200 Success / 200 You cannot file Nil return

ā€‹
code
number
Example:

200

ā€‹
data
object
ā€‹
timestamp
number
Example:

1763446641000

ā€‹
transaction_id
string
Example:

"72da34f0-d6d1-4056-92e1-734fc29f0249"