File GSTR-9A Annual Return with DSC
POST
https://apisandbox.whitebooks.in/gstr9a/retfileThis API is to File GSTR9A
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
gstinstringoptionalGSTIN
Example: "04AJIPA1572EAZK"
fpstringoptionalFinancial Year
Example: "032018"
cmp_frmdtstringoptionalComposition Start data
Example: "12-01-2018"
cmp_todtstringoptionalComposition Start data
Example: "12-01-2018"
isnilstringoptionalIs Nil Filing
Example: "N"
table5objectoptionalgtnumberoptionalGross TrunOver
Example: 1000.12
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
table6objectoptionaltx_trnovrarray<object>optionalArray items:
rtnumberoptionalRate of Tax
Example: 1
trnovrnumberoptionalIGST Amount
Example: 20
camtnumberoptionalCGST Amount
Example: 20
samtnumberoptionalSGST Amount
Example: 20
exmpobjectoptionaltrnovrnumberoptionalIGST Amount
Example: 20
camtnumberoptionalCGST Amount
Example: 20
samtnumberoptionalSGST Amount
Example: 20
totobjectoptionaltrnovrnumberoptionalIGST Amount
Example: 20
camtnumberoptionalCGST Amount
Example: 20
samtnumberoptionalSGST Amount
Example: 20
table7objectoptionalb2bobjectoptionaltxvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
b2burobjectoptionaltxvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
impsobjectoptionaltxvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
totobjectoptionaltxvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
table8objectoptionalb2bobjectoptionaltxvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
impgobjectoptionaltxvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
table9objectoptionaltx_payobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 20
feenumberoptionalFee Amount
Example: 20
txpdobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 20
feenumberoptionalFee Amount
Example: 20
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
table10objectoptionaltxosa_dnobjectoptionaltrnovrnumberoptionalTotal Turnover
Example: 1000
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
b2b_dnobjectoptionaltrnovrnumberoptionalTotal TurnOver
Example: 1000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
txosa_cnobjectoptionaltrnovrnumberoptionalTotal Turnover
Example: 1000
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
b2b_cnobjectoptionaltrnovrnumberoptionalTotal Turnover
Example: 1000
iamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
tot_trnovrobjectoptionaltrnovrnumberoptionalTotal Turnover
Example: 10000
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
table14objectoptionalpayobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
paidobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
table15objectoptionalrfd_clmdobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
rfd_sancobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
rfd_rejtobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
rfd_pendobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
tax_dmndobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
txpdobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
dmnd_pendobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
intrnumberoptionalInterest Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
table16objectoptionaldebitobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
creditobjectoptionaliamtnumberoptionalIGST Amount as per invoice
Example: 20
camtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
chksumstringoptionalChecksum
Example: "ahshsjslslslss"
tax_payarray<object>optionalArray items:
cgstobjectoptionalCentral Tax
intrnumberoptionalInterest Amount
Example: 0
othnumberoptionalother Amount
Example: 0
txnumberoptionalTax Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
totnumberoptionalTotal Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
sgstobjectoptionalState tax/UT Tax
intrnumberoptionalInterest Amount
Example: 0
othnumberoptionalother Amount
Example: 0
txnumberoptionalTax Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
totnumberoptionalTotal Amount
Example: 0
pennumberoptionalPenalty Amount
Example: 0
liab_idintegeroptionalLiab ID
Example: 8855
trancdintegeroptionalTransaction Code
Example: 30002
trandatestringoptionalTransaction Date
Example: "12-02-2018"
offsetarray<object>optionalArray items:
camtobjectoptionalCentral Tax
intrnumberoptionalInterest Amount
Example: 0
txnumberoptionalTax Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
totnumberoptionalTotal Amount
Example: 0
samtobjectoptionalState tax/UT Tax
intrnumberoptionalInterest Amount
Example: 0
txnumberoptionalTax Amount
Example: 0
feenumberoptionalFee Amount
Example: 0
totnumberoptionalTotal Amount
Example: 0
trancdintegeroptionalTransaction Code
Example: 30002
Response
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
/gstr9a/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 GSTR9A (POST
/gstr9a/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 File GSTR9A
No example available.