File GSTR-5 Return with DSC
POST
https://apisandbox.whitebooks.in/gstr5/retfileThis API is to submit the GSTR5 return.
Parameters
query parameters
emailstringrequiredAPI Developer User Email
header parameters
gstinstringrequiredGST Number
ret_periodstringrequiredReturn Period (MMYYYY)
gst_usernamestringrequiredGST UserName
state_cdstringrequiredState Code
ip_addressstringrequiredIP Address
txnstringrequiredTransaction
client_idstringrequiredClient ID
client_secretstringrequiredClient Secret
Request Body
application/jsonrequired
gstinstringoptionalSupplier GSTIN
Example: "27AHQPA7588L1ZJ"
ret_periodstringoptionalReturn Period
Example: "022024"
chksumstringoptionalChecksum Value
Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"
section_summaryarray<object>optionalArray items:
chksumstringoptionalInvoice Check Sum Value
Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"
cpty_sumarray<object>optionalArray items:
chksumstringoptionalInvoice Check Sum value
Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"
ctinstringoptionalReceiver TIN for B2B & CDN
Example: "27AHQPA7588L1ZJ"
rcnumberoptionalRecord Count
Example: 10
ttl_txpd_cessnumberoptionalTotal Tax Paid CESS
Example: 10
ttl_txpd_cgstnumberoptionalTotal Tax Paid CGST
Example: 124.99
ttl_txpd_igstnumberoptionalTotal Tax Paid IGST
Example: 124.99
ttl_txpd_sgstnumberoptionalTotal Tax Paid SGST
Example: 124.99
ttl_valnumberoptionalTotal Invoice Value
Example: 12345
ttl_taxnumberoptionalTotal Taxable Value
Example: 123
rcnumberoptionalRecord Count
Example: 10
sec_nmstringoptionalReturn Section
Example: "B2B"
ttl_txpd_cessnumberoptionalTotal Tax Paid CESS
Example: 10
ttl_txpd_cgstnumberoptionalTotal Tax Paid CGST
Example: 10
ttl_txpd_igstnumberoptionalTotal Tax Paid IGST
Example: 10
ttl_txpd_sgstnumberoptionalTotal Tax Paid SGST
Example: 10
ttl_valnumberoptionalTotal Invoice Value
Example: 10
ttl_taxnumberoptionalTotal Taxable Value
Example: 10
txiobjectoptionaldiffItcarray<object>optionalArray items:
cessnumberoptionalCESS Amount
Example: 10
cgstnumberoptionalCGST Amount
Example: 10
igstnumberoptionalIGST Amount
Example: 10
rtnumberoptionalTax Rate
Example: 10
sgstnumberoptionalSGST Amount
Example: 10
txvalnumberoptionalTaxable Value as per Invoice
Example: 10
liabarray<object>optionalArray items:
cessnumberoptionalCESS Amount
Example: 10
cgstnumberoptionalCGST Amount
Example: 10
igstnumberoptionalIGST Amount
Example: 10
rtnumberoptionalTax Rate
Example: 10
sgstnumberoptionalSGST Amount
Example: 10
txvalnumberoptionalTaxable Value as per Invoice
Example: 10
offsetobjectoptionalpdcasharray<object>optionalArray items:
trans_typnumberoptionalTransaction code
Example: 30002
ipdnumberoptionalIgst Tax paid through cash
Example: 3517817
cpdnumberoptionalCgst Tax paid through cash
Example: 3517817
spdnumberoptionalSgst Tax paid through cash
Example: 3517817
cspdnumberoptionalCgst Tax paid through cash
Example: 3517817
c_intrpdnumberoptionalCgst Interest paid through cash
Example: 30
c_lfeepdnumberoptionalCgst Late Fee paid through cash
Example: 13
cs_intrpdnumberoptionalCess Interest paid through cash
Example: 15
i_intrpdnumberoptionalIgst Interest paid through cash
Example: 20
s_intrpdnumberoptionalSgst Interest paid through cash
Example: 10
s_lfeepdnumberoptionalSgst Late fee paid through cash
Example: 13
pditcobjectoptionaltrans_typnumberoptionalTransaction code
Example: 30002
i_pdinumberoptionalIgst Tax paid through Igst ITC
Example: 3517817
i_pdcnumberoptionalIgst Tax paid through Cgst ITC
Example: 2290459
i_pdsnumberoptionalIgst Tax paid through Sgst ITC
Example: 2290459
c_pdcnumberoptionalCgst Tax paid through Cgst ITC
Example: 2290459
c_pdinumberoptionalCgst Tax paid through Igst ITC
Example: 3517817
s_pdinumberoptionalSgst Tax paid through Igst ITC
Example: 3517817
s_pdsnumberoptionalSgst Tax paid through Sgst ITC
Example: 2290459
cs_pdcsnumberoptionalCess Tax paid through Cess ITC
Example: 2290459
txpdobjectoptionaltax_paidcasharray<object>optionalArray items:
cessobjectoptionalcgstobjectoptionalliab_idintegeroptionalLiability Id
Example: 7865
trancdintegeroptionalTrans Code
Example: 30002
trandatestringoptionalTrans Date
Example: "11-02-2024"
igstobjectoptionalsgstobjectoptionaltax_paiditcarray<object>optionalArray items:
debit_idstringoptionalDebit Id
Example: "DC0504170000000"
liab_idintegeroptionalLiability Id
Example: 7687
trancdintegeroptionalTrans Code
Example: 30002
trandatestringoptionalTrans Date
Example: "11-02-2024"
igst_igst_amtnumberoptionalIGST as IGST
Example: 0
igst_cgst_amtnumberoptionalIGST as CGST
Example: 0
igst_sgst_amtnumberoptionalIGST as SGST
Example: 0
sgst_sgst_amtnumberoptionalSGST as SGST
Example: 0
sgst_igst_amtnumberoptionalSGST as IGST
Example: 0
cgst_cgst_amtnumberoptionalCGST as CGST
Example: 0
cgst_igst_amtnumberoptionalCGST as IGST
Example: 0
cess_cess_amtnumberoptionalCESS as CESS
Example: 0
tax_payarray<object>optionalArray items:
cessobjectoptionalliab_idintegeroptionalLiability Id
Example: 10
trancdintegeroptionalTrans Code
Example: 10
trandatestringoptionalTrans Date
Example: "24-10-2017"
cgstobjectoptionaligstobjectoptionalsgstobjectoptionalResponse
Not Found. If requested entity is not found or if requested API is not found.
Frequently Asked Questions
Requests are submitted via HTTP POST to
/gstr5/retfile. Required parameters: email (query parameter), gstin (header parameter), ret_period (header parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). A JSON request body (Content-Type: application/json) is accepted per the schema specifications shown in the request documentation.For File GSTR5 (POST
/gstr5/retfile), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).This API is to submit the GSTR5 return.
No example available.