Save GSTR-9 Annual Return as a Draft
PUT
https://apisandbox.whitebooks.in/gstr9/retsaveThis API is to save GSTR9 data
Parameters
query parameters
emailstringrequiredUser 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 number
Example: "06GDDPS5083K1Z0"
fpstringoptionalFp Type
Example: "032018"
table4objectoptionalb2cobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
b2bobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
expobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
sezobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
deemedobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
atobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rchrgobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
cr_ntobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
dr_ntobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
amd_posobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
amd_negobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
table5objectoptionalzero_rtdobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
sezobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
rchrgobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
exmtobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
nilobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
non_gstobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
cr_ntobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
dr_ntobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
amd_posobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
amd_negobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
table6objectoptionalsupp_non_rchrgarray<object>optionalArray items:
itc_typstringoptionalAction to be taken
Example: "ip"
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
supp_rchrg_unregarray<object>optionalArray items:
itc_typstringoptionalAction to be taken
Example: "ip"
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
supp_rchrg_regarray<object>optionalArray items:
itc_typstringoptionalAction to be taken
Example: "ip"
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
iogarray<object>optionalArray items:
itc_typstringoptionalAction to be taken
Example: "ip"
iamtnumberoptionalIGST Amount as per invoice
Example: 20
csamtnumberoptionalCess Amount as per invoice
Example: 20
iosobjectoptionaliamtnumberoptionalIntegrated tax
Example: 20
csamtnumberoptionalCess
Example: 20
isdobjectoptionaliamtnumberoptionalIGST 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
itc_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
tran1objectoptionalcamtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
tran2objectoptionalcamtnumberoptionalCGST Amount as per invoice
Example: 20
samtnumberoptionalSGST Amount as per invoice
Example: 20
otherobjectoptionaliamtnumberoptionalIGST 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
table7objectoptionalrule37objectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rule39objectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rule42objectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rule43objectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
sec17objectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
revsl_tran1objectoptionalcamtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
revsl_tran2objectoptionalcamtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
otherarray<object>optionalArray items:
descstringoptionalothers- reversal (Please specify)
Example: "other"
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
table8objectoptionalitc_inwd_suppobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
itc_nt_availdobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
itc_nt_elegobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
iog_taxpaidobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
table9objectoptionaliamtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
camtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
samtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
csamtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
introbjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
feeobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
penobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
otherobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
table10objectoptionalitc_availdobjectoptionalcsamtnumberoptionalCess Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
iamtnumberoptionaligst Amount
Example: 20
itc_rvslobjectoptionalcsamtnumberoptionalCess Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
iamtnumberoptionaligst Amount
Example: 20
dbn_amdobjectoptionalcsamtnumberoptionalCess Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
txvalnumberoptionalTaxable Value
Example: 1000
camtnumberoptionalcgst Amount
Example: 20
iamtnumberoptionaligst Amount
Example: 20
cdn_amdobjectoptionalcsamtnumberoptionalCess Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
txvalnumberoptionalTaxable Value
Example: 1000
camtnumberoptionalcgst Amount
Example: 20
iamtnumberoptionaligst Amount
Example: 20
table14objectoptionaliamtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
txpaidnumberoptionalTax payed
Example: 1000
camtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
txpaidnumberoptionalTax payed
Example: 1000
samtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
txpaidnumberoptionalTax payed
Example: 1000
csamtobjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
txpaidnumberoptionalTax payed
Example: 1000
introbjectoptionaltxpyblenumberoptionalTax Payable
Example: 1000
txpaidnumberoptionalTax payed
Example: 1000
table15objectoptionalrfd_clmdobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rfd_sancobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rfd_rejtobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
rfd_pendobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
tax_dmndobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
intrnumberoptionalIntra tax
Example: 20
feenumberoptionalFee amount
Example: 20
pennumberoptionalPending Amount
Example: 20
tax_paidobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
intrnumberoptionalIntra tax
Example: 20
feenumberoptionalFee amount
Example: 20
pennumberoptionalPending Amount
Example: 20
dmnd_pendobjectoptionaliamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
intrnumberoptionalIntra tax
Example: 20
feenumberoptionalFee amount
Example: 20
pennumberoptionalPending Amount
Example: 20
table16objectoptionalcomp_suppobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
deemed_suppobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
not_returnedobjectoptionaltxvalnumberoptionalTaxable Value
Example: 1000
iamtnumberoptionaligst Amount
Example: 20
camtnumberoptionalcgst Amount
Example: 20
samtnumberoptionalsgst Amount
Example: 20
csamtnumberoptionalCess Amount
Example: 20
table17objectoptionalitemsarray<object>optionalHSN Wise Summary of outward supplies
Array items:
isconcesstionalstringoptionalFlag to identify concession
Example: "N"
hsn_scstringoptionalHSN Code
Example: "3r4532"
txvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
rtnumberoptionalrate
Example: 5
iamtnumberoptionalIGST Amount as per invoice
Example: 325
camtnumberoptionalCGST Amount as per invoice
Example: 0
samtnumberoptionalSGST Amount as per invoice
Example: 0
csamtnumberoptionalCess Amount as per invoice
Example: 500
table18objectoptionalitemsarray<object>optionalHSN Wise Summary of Inward supplies
Array items:
isconcesstionalstringoptionalFlag to identify concession
Example: "N"
hsn_scstringoptionalHSN Code
Example: "24235"
uqcstringoptionalUQC
Example: "BAG"
qtynumberoptionalTotal Quantity
Example: 13
txvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
rtnumberoptionalrate
Example: 5
iamtnumberoptionalIGST Amount as per invoice
Example: 325
camtnumberoptionalCGST Amount as per invoice
Example: 0
samtnumberoptionalSGST Amount as per invoice
Example: 0
csamtnumberoptionalCess Amount as per invoice
Example: 500
Response
Not Found. If requested entity is not found or if requested API is not found.
Frequently Asked Questions
Requests are submitted via HTTP PUT to
/gstr9/retsave. 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 Save GSTR9 (PUT
/gstr9/retsave), 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 save GSTR9 data
No example available.