Parent API: GST API Quickstart guide Authentication guide

File GSTR-9 Annual Return with DSC

Q: What parameters and payload format are required for File GSTR9?

Requests are submitted via HTTP POST to '/gstr9/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.

Q: What response status codes and format does File GSTR9 return?

For File GSTR9 (POST '/gstr9/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).

POSThttps://apisandbox.whitebooks.in/gstr9/retfile

This API is to File GSTR9

Annual Return UI

Explore Feature

GSTR-9 Annual Reconciliation & Audit

Auto-consolidate 12 months of GSTR-1 and 3B, reconcile with audited financial statements, and file GSTR-9 error-free.

Parameters

query parameters

emailstringrequired

API Developer User Email

header parameters

gstinstringrequired

GST Number

ret_periodstringrequired

Return Period (MMYYYY)

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Request Body

application/jsonrequired

isnilstringoptional

Flag for indication of NIL Filing

Example: "N"

gstinstringoptional

GSTIN

Example: "04AJIPA1572EAZK"

fpstringoptional

Financial Year

Example: "032018"

table4objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

b2cobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

b2bobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

expobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sezobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

deemedobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

atobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

rchrgobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

cr_ntobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

dr_ntobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

amd_posobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

amd_negobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sub_totalAGobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sub_totalILobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sup_advobjectoptional

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

table5objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

zero_rtdobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

sezobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

rchrgobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

exmtobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

nilobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

non_gstobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

cr_ntobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

dr_ntobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

amd_posobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

amd_negobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

sub_totalAFobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

sub_totalHKobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

tover_tax_npobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

total_toverobjectoptional

txvalnumberoptional

Total Taxable value

Example: 10000

table6objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

itc_3bobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

supp_non_rchrgarray<object>optional

Array items:

itc_typstringoptional

Action to be taken

Example: "ip"

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

supp_rchrg_unregarray<object>optional

Array items:

itc_typstringoptional

Action to be taken

Example: "ip"

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

supp_rchrg_regarray<object>optional

Array items:

itc_typstringoptional

Action to be taken

Example: "ip"

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

iogarray<object>optional

Array items:

itc_typstringoptional

Action to be taken

Example: "ip"

iamtnumberoptional

IGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

iosobjectoptional

iamtnumberoptional

Integrated tax

Example: 20

csamtnumberoptional

Cess

Example: 20

isdobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_clmdobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

tran1objectoptional

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

tran2objectoptional

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

otherobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sub_totalBHobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

differenceobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sub_totalKMobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

total_itc_availedobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

table7objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

rule37objectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

rule39objectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

rule42objectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

rule43objectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

sec17objectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

revsl_tran1objectoptional

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

revsl_tran2objectoptional

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

otherarray<object>optional

Array items:

descstringoptional

others- reversal (Please specify)

Example: "other"

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

tot_itc_revdobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

net_itc_avalobjectoptional

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

table8objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

itc_2aobjectoptional

ITC as per GSTR-2A (Table 3 & 5 thereof)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_totobjectoptional

ITC as per sum total of 6(B) and 6(H) above

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_inwd_suppobjectoptional

ITC on inward supplies (other than imports and inward supplies liable to reverse charge but includes services received from SEZs) received during 2017-18 but availed during April to September, 2018

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_nt_availdobjectoptional

ITC available but not availed (out of D)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_nt_elegobjectoptional

ITC available but ineligible (out of D)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

iog_taxpaidobjectoptional

IGST paid on import of goods (including supplies from SEZ)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

iog_itc_availdobjectoptional

IGST credit availed on import of goods (as per 6(E) above)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

iog_itc_ntavaildobjectoptional

ITC available but not availed on import of goods (Equal to I)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

differenceABCobjectoptional

Difference [A-(B+C)]

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

differenceGHobjectoptional

Difference (G-H)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

tot_itc_lapsedobjectoptional

Total ITC to be lapsed in current financial year (E + F + J)

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

table9objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

iamtobjectoptional

Integrated Tax

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 10000

tax_paid_itc_iamtnumberoptional

Integrated tax

Example: 20

tax_paid_itc_camtnumberoptional

Central tax

Example: 20

tax_paid_itc_samtnumberoptional

State/UT tax

Example: 20

camtobjectoptional

Central Tax

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 10000

tax_paid_itc_iamtnumberoptional

Integrated tax

Example: 20

tax_paid_itc_camtnumberoptional

Central tax

Example: 20

samtobjectoptional

State/UT Tax

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 10000

tax_paid_itc_iamtnumberoptional

Integrated tax

Example: 20

tax_paid_itc_samtnumberoptional

State/UT tax

Example: 20

csamtobjectoptional

Cess

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 1000

tax_paid_itc_csamtnumberoptional

Cess

Example: 20

introbjectoptional

Interest

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 10000

feeobjectoptional

Late fee

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 10000

penobjectoptional

Penalty

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 10000

sotherobjectoptional

Other

txpyblenumberoptional

Taxpayable

Example: 10000

txpaid_cashnumberoptional

Paid through cash

Example: 1000

table10objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

dbn_amdobjectoptional

Supplies / tax declared through Amendments (+) (net of debit notes)

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

cdn_amdobjectoptional

Supplies / tax reduced through Amendments (-) (net of credit notes)

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_rvslobjectoptional

Reversal of ITC availed during previous financial year

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

itc_availdobjectoptional

ITC availed for the previous financial year

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

total_turnoverobjectoptional

Total turnover(5N + 10 - 11)

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 20

camtnumberoptional

CGST Amount as per invoice

Example: 20

samtnumberoptional

SGST Amount as per invoice

Example: 20

csamtnumberoptional

Cess Amount as per invoice

Example: 20

table14objectoptional

table15objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

rfd_clmdobjectoptional

Total Refund claimed

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

rfd_sancobjectoptional

Total Refund sanctioned

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

rfd_rejtobjectoptional

Total Refund Rejected

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

rfd_pendobjectoptional

Total Refund Pending

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

tax_dmndobjectoptional

Total demand of taxes

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

intrnumberoptional

Interest Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

pennumberoptional

Penalty Amount

Example: 0

tax_paidobjectoptional

Total taxes paid in respect of E

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

intrnumberoptional

Interest Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

pennumberoptional

Penalty Amount

Example: 0

dmnd_pendobjectoptional

Total demands pending out of E above

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

intrnumberoptional

Interest Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

pennumberoptional

Penalty Amount

Example: 0

table16objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

comp_suppobjectoptional

Supplies received from Composition taxpayers

txvalnumberoptional

Taxable Value

Example: 10000

deemed_suppobjectoptional

Deemed supply under Section 143

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

not_returnedobjectoptional

Goods sent on approval basis but not returned

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

table17objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

itemsarray<object>optional

HSN Wise Summary of outward supplies

Array items:

descstringoptional

Description

Example: "afdasfcvasd"

isconcesstionalstringoptional

Flag to identify concession

Example: "N"

hsn_scstringoptional

HSN Code

Example: "3r4532"

uqcstringoptional

UQC

Example: "BAG"

qtynumberoptional

Total Quantity

Example: 123

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

rtnumberoptional

rate

Example: 5

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

table18objectoptional

chksumstringoptional

Checksum

Example: "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui"

itemsarray<object>optional

HSN Wise Summary of Inward supplies

Array items:

descstringoptional

Description

Example: "afdasfcvasd"

isconcesstionalstringoptional

Flag to identify concession

Example: "N"

hsn_scstringoptional

HSN Code

Example: "24235"

uqcstringoptional

UQC

Example: "BAG"

qtynumberoptional

Total Quantity

Example: 13

txvalnumberoptional

Taxable value of Goods or Service as per invoice

Example: 10000

rtnumberoptional

rate

Example: 5

iamtnumberoptional

IGST Amount as per invoice

Example: 325

camtnumberoptional

CGST Amount as per invoice

Example: 0

samtnumberoptional

SGST Amount as per invoice

Example: 0

csamtnumberoptional

Cess Amount as per invoice

Example: 500

tax_payarray<object>optional

Array items:

cgstobjectoptional

Central Tax

intrnumberoptional

Interest Amount

Example: 0

othnumberoptional

other Amount

Example: 0

txnumberoptional

Tax Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

totnumberoptional

Total Amount

Example: 0

pennumberoptional

Penalty Amount

Example: 0

sgstobjectoptional

State tax/UT Tax

intrnumberoptional

Interest Amount

Example: 0

othnumberoptional

other Amount

Example: 0

txnumberoptional

Tax Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

totnumberoptional

Total Amount

Example: 0

pennumberoptional

Penalty Amount

Example: 0

liab_idintegeroptional

Liab ID

Example: 8855

trancdintegeroptional

Transaction Code

Example: 30002

trandatestringoptional

Transaction Date

Example: "12-03-2024"

offsetarray<object>optional

Array items:

cgstobjectoptional

Central Tax

intrnumberoptional

Interest Amount

Example: 0

txnumberoptional

Tax Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

totnumberoptional

Total Amount

Example: 0

sgstobjectoptional

intrnumberoptional

Interest Amount

Example: 0

txnumberoptional

Tax Amount

Example: 0

feenumberoptional

Fee Amount

Example: 0

totnumberoptional

Total Amount

Example: 0

tran_cdintegeroptional

Transaction 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 /gstr9/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 GSTR9 (POST /gstr9/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 GSTR9

Get EID

File GSTR9 data

POST/gstr9/retfile

1const response = await fetch('https://apisandbox.whitebooks.in/gstr9/retfile?email=value', {

2 method: 'POST',

3 headers: {

4 gstin: "value",

5 ret_period: "value",

6 gst_username: "value",

7 state_cd: "value",

8 ip_address: "value",

9 txn: "value",

10 client_id: "value",

11 client_secret: "value",

12 Content-Type: "application/json"

13},

14 body: JSON.stringify({

15 "isnil": "N",

16 "gstin": "04AJIPA1572EAZK",

17 "fp": "032018",

18 "table4": {

19 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

20 "b2c": {

21 "txval": 10000,

22 "iamt": 20,

23 "camt": 20,

24 "samt": 20,

25 "csamt": 20

26 },

27 "b2b": {

28 "txval": 10000,

29 "iamt": 20,

30 "camt": 20,

31 "samt": 20,

32 "csamt": 20

33 },

34 "exp": {

35 "txval": 10000,

36 "iamt": 20,

37 "csamt": 20

38 },

39 "sez": {

40 "txval": 10000,

41 "iamt": 20,

42 "csamt": 20

43 },

44 "deemed": {

45 "txval": 10000,

46 "iamt": 20,

47 "camt": 20,

48 "samt": 20,

49 "csamt": 20

50 },

51 "at": {

52 "txval": 10000,

53 "iamt": 20,

54 "camt": 20,

55 "samt": 20,

56 "csamt": 20

57 },

58 "rchrg": {

59 "txval": 10000,

60 "iamt": 20,

61 "camt": 20,

62 "samt": 20,

63 "csamt": 20

64 },

65 "cr_nt": {

66 "txval": 10000,

67 "iamt": 20,

68 "camt": 20,

69 "samt": 20,

70 "csamt": 20

71 },

72 "dr_nt": {

73 "txval": 10000,

74 "iamt": 20,

75 "camt": 20,

76 "samt": 20,

77 "csamt": 20

78 },

79 "amd_pos": {

80 "txval": 10000,

81 "iamt": 20,

82 "camt": 20,

83 "samt": 20,

84 "csamt": 20

85 },

86 "amd_neg": {

87 "txval": 10000,

88 "iamt": 20,

89 "camt": 20,

90 "samt": 20,

91 "csamt": 20

92 },

93 "sub_totalAG": {

94 "txval": 10000,

95 "iamt": 20,

96 "camt": 20,

97 "samt": 20,

98 "csamt": 20

99 },

100 "sub_totalIL": {

101 "txval": 10000,

102 "iamt": 20,

103 "camt": 20,

104 "samt": 20,

105 "csamt": 20

106 },

107 "sup_adv": {

108 "txval": 10000,

109 "iamt": 20,

110 "camt": 20,

111 "samt": 20,

112 "csamt": 20

113 }

114 },

115 "table5": {

116 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

117 "zero_rtd": {

118 "txval": 10000

119 },

120 "sez": {

121 "txval": 10000

122 },

123 "rchrg": {

124 "txval": 10000

125 },

126 "exmt": {

127 "txval": 10000

128 },

129 "nil": {

130 "txval": 10000

131 },

132 "non_gst": {

133 "txval": 10000

134 },

135 "cr_nt": {

136 "txval": 10000

137 },

138 "dr_nt": {

139 "txval": 10000

140 },

141 "amd_pos": {

142 "txval": 10000

143 },

144 "amd_neg": {

145 "txval": 10000

146 },

147 "sub_totalAF": {

148 "txval": 10000

149 },

150 "sub_totalHK": {

151 "txval": 10000

152 },

153 "tover_tax_np": {

154 "txval": 10000

155 },

156 "total_tover": {

157 "txval": 10000

158 }

159 },

160 "table6": {

161 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

162 "itc_3b": {

163 "iamt": 20,

164 "camt": 20,

165 "samt": 20,

166 "csamt": 20

167 },

168 "supp_non_rchrg": [

169 {

170 "itc_typ": "ip",

171 "iamt": 20,

172 "camt": 20,

173 "samt": 20,

174 "csamt": 20

175 }

176 ],

177 "supp_rchrg_unreg": [

178 {

179 "itc_typ": "ip",

180 "iamt": 20,

181 "camt": 20,

182 "samt": 20,

183 "csamt": 20

184 }

185 ],

186 "supp_rchrg_reg": [

187 {

188 "itc_typ": "ip",

189 "iamt": 20,

190 "camt": 20,

191 "samt": 20,

192 "csamt": 20

193 }

194 ],

195 "iog": [

196 {

197 "itc_typ": "ip",

198 "iamt": 20,

199 "csamt": 20

200 }

201 ],

202 "ios": {

203 "iamt": 20,

204 "csamt": 20

205 },

206 "isd": {

207 "iamt": 20,

208 "camt": 20,

209 "samt": 20,

210 "csamt": 20

211 },

212 "itc_clmd": {

213 "iamt": 20,

214 "camt": 20,

215 "samt": 20,

216 "csamt": 20

217 },

218 "tran1": {

219 "camt": 20,

220 "samt": 20

221 },

222 "tran2": {

223 "camt": 20,

224 "samt": 20

225 },

226 "other": {

227 "iamt": 20,

228 "camt": 20,

229 "samt": 20,

230 "csamt": 20

231 },

232 "sub_totalBH": {

233 "iamt": 20,

234 "camt": 20,

235 "samt": 20,

236 "csamt": 20

237 },

238 "difference": {

239 "iamt": 20,

240 "camt": 20,

241 "samt": 20,

242 "csamt": 20

243 },

244 "sub_totalKM": {

245 "iamt": 20,

246 "camt": 20,

247 "samt": 20,

248 "csamt": 20

249 },

250 "total_itc_availed": {

251 "iamt": 20,

252 "camt": 20,

253 "samt": 20,

254 "csamt": 20

255 }

256 },

257 "table7": {

258 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

259 "rule37": {

260 "iamt": 20,

261 "camt": 20,

262 "samt": 20,

263 "csamt": 20

264 },

265 "rule39": {

266 "iamt": 20,

267 "camt": 20,

268 "samt": 20,

269 "csamt": 20

270 },

271 "rule42": {

272 "iamt": 20,

273 "camt": 20,

274 "samt": 20,

275 "csamt": 20

276 },

277 "rule43": {

278 "iamt": 20,

279 "camt": 20,

280 "samt": 20,

281 "csamt": 20

282 },

283 "sec17": {

284 "iamt": 20,

285 "camt": 20,

286 "samt": 20,

287 "csamt": 20

288 },

289 "revsl_tran1": {

290 "camt": 20,

291 "samt": 20

292 },

293 "revsl_tran2": {

294 "camt": 20,

295 "samt": 20

296 },

297 "other": [

298 {

299 "desc": "other",

300 "iamt": 20,

301 "camt": 20,

302 "samt": 20,

303 "csamt": 20

304 }

305 ],

306 "tot_itc_revd": {

307 "iamt": 20,

308 "camt": 20,

309 "samt": 20,

310 "csamt": 20

311 },

312 "net_itc_aval": {

313 "iamt": 20,

314 "camt": 20,

315 "samt": 20,

316 "csamt": 20

317 }

318 },

319 "table8": {

320 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

321 "itc_2a": {

322 "iamt": 20,

323 "camt": 20,

324 "samt": 20,

325 "csamt": 20

326 },

327 "itc_tot": {

328 "iamt": 20,

329 "camt": 20,

330 "samt": 20,

331 "csamt": 20

332 },

333 "itc_inwd_supp": {

334 "iamt": 20,

335 "camt": 20,

336 "samt": 20,

337 "csamt": 20

338 },

339 "itc_nt_availd": {

340 "iamt": 20,

341 "camt": 20,

342 "samt": 20,

343 "csamt": 20

344 },

345 "itc_nt_eleg": {

346 "iamt": 20,

347 "camt": 20,

348 "samt": 20,

349 "csamt": 20

350 },

351 "iog_taxpaid": {

352 "iamt": 20,

353 "camt": 20,

354 "samt": 20,

355 "csamt": 20

356 },

357 "iog_itc_availd": {

358 "iamt": 20,

359 "camt": 20,

360 "samt": 20,

361 "csamt": 20

362 },

363 "iog_itc_ntavaild": {

364 "iamt": 20,

365 "camt": 20,

366 "samt": 20,

367 "csamt": 20

368 },

369 "differenceABC": {

370 "iamt": 20,

371 "camt": 20,

372 "samt": 20,

373 "csamt": 20

374 },

375 "differenceGH": {

376 "iamt": 20,

377 "camt": 20,

378 "samt": 20,

379 "csamt": 20

380 },

381 "tot_itc_lapsed": {

382 "iamt": 20,

383 "camt": 20,

384 "samt": 20,

385 "csamt": 20

386 }

387 },

388 "table9": {

389 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

390 "iamt": {

391 "txpyble": 10000,

392 "txpaid_cash": 10000,

393 "tax_paid_itc_iamt": 20,

394 "tax_paid_itc_camt": 20,

395 "tax_paid_itc_samt": 20

396 },

397 "camt": {

398 "txpyble": 10000,

399 "txpaid_cash": 10000,

400 "tax_paid_itc_iamt": 20,

401 "tax_paid_itc_camt": 20

402 },

403 "samt": {

404 "txpyble": 10000,

405 "txpaid_cash": 10000,

406 "tax_paid_itc_iamt": 20,

407 "tax_paid_itc_samt": 20

408 },

409 "csamt": {

410 "txpyble": 10000,

411 "txpaid_cash": 1000,

412 "tax_paid_itc_csamt": 20

413 },

414 "intr": {

415 "txpyble": 10000,

416 "txpaid_cash": 10000

417 },

418 "fee": {

419 "txpyble": 10000,

420 "txpaid_cash": 10000

421 },

422 "pen": {

423 "txpyble": 10000,

424 "txpaid_cash": 10000

425 },

426 "sother": {

427 "txpyble": 10000,

428 "txpaid_cash": 1000

429 }

430 },

431 "table10": {

432 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

433 "dbn_amd": {

434 "txval": 10000,

435 "iamt": 20,

436 "camt": 20,

437 "samt": 20,

438 "csamt": 20

439 },

440 "cdn_amd": {

441 "txval": 10000,

442 "iamt": 20,

443 "camt": 20,

444 "samt": 20,

445 "csamt": 20

446 },

447 "itc_rvsl": {

448 "txval": 10000,

449 "iamt": 20,

450 "camt": 20,

451 "samt": 20,

452 "csamt": 20

453 },

454 "itc_availd": {

455 "txval": 10000,

456 "iamt": 20,

457 "camt": 20,

458 "samt": 20,

459 "csamt": 20

460 },

461 "total_turnover": {

462 "txval": 10000,

463 "iamt": 20,

464 "camt": 20,

465 "samt": 20,

466 "csamt": 20

467 }

468 },

469 "table14": {},

470 "table15": {

471 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

472 "rfd_clmd": {

473 "iamt": 325,

474 "camt": 0,

475 "samt": 0,

476 "csamt": 500

477 },

478 "rfd_sanc": {

479 "iamt": 325,

480 "camt": 0,

481 "samt": 0,

482 "csamt": 500

483 },

484 "rfd_rejt": {

485 "iamt": 325,

486 "camt": 0,

487 "samt": 0,

488 "csamt": 500

489 },

490 "rfd_pend": {

491 "iamt": 325,

492 "camt": 0,

493 "samt": 0,

494 "csamt": 500

495 },

496 "tax_dmnd": {

497 "iamt": 325,

498 "camt": 0,

499 "samt": 0,

500 "csamt": 500,

501 "intr": 0,

502 "fee": 0,

503 "pen": 0

504 },

505 "tax_paid": {

506 "iamt": 325,

507 "camt": 0,

508 "samt": 0,

509 "csamt": 500,

510 "intr": 0,

511 "fee": 0,

512 "pen": 0

513 },

514 "dmnd_pend": {

515 "iamt": 325,

516 "camt": 0,

517 "samt": 0,

518 "csamt": 500,

519 "intr": 0,

520 "fee": 0,

521 "pen": 0

522 }

523 },

524 "table16": {

525 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

526 "comp_supp": {

527 "txval": 10000

528 },

529 "deemed_supp": {

530 "txval": 10000,

531 "iamt": 325,

532 "camt": 0,

533 "samt": 0,

534 "csamt": 500

535 },

536 "not_returned": {

537 "txval": 10000,

538 "iamt": 325,

539 "camt": 0,

540 "samt": 0,

541 "csamt": 500

542 }

543 },

544 "table17": {

545 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

546 "items": [

547 {

548 "desc": "afdasfcvasd",

549 "isconcesstional": "N",

550 "hsn_sc": "3r4532",

551 "uqc": "BAG",

552 "qty": 123,

553 "txval": 10000,

554 "rt": 5,

555 "iamt": 325,

556 "camt": 0,

557 "samt": 0,

558 "csamt": 500

559 }

560 ]

561 },

562 "table18": {

563 "chksum": "qwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyuiqwertyui",

564 "items": [

565 {

566 "desc": "afdasfcvasd",

567 "isconcesstional": "N",

568 "hsn_sc": "24235",

569 "uqc": "BAG",

570 "qty": 13,

571 "txval": 10000,

572 "rt": 5,

573 "iamt": 325,

574 "camt": 0,

575 "samt": 0,

576 "csamt": 500

577 }

578 ]

579 },

580 "tax_pay": [

581 {

582 "cgst": {

583 "intr": 0,

584 "oth": 0,

585 "tx": 0,

586 "fee": 0,

587 "tot": 0,

588 "pen": 0

589 },

590 "sgst": {

591 "intr": 0,

592 "oth": 0,

593 "tx": 0,

594 "fee": 0,

595 "tot": 0,

596 "pen": 0

597 },

598 "liab_id": 8855,

599 "trancd": 30002,

600 "trandate": "12-03-2024"

601 }

602 ],

603 "offset": [

604 {

605 "cgst": {

606 "intr": 0,

607 "tx": 0,

608 "fee": 0,

609 "tot": 0

610 },

611 "sgst": {

612 "intr": 0,

613 "tx": 0,

614 "fee": 0,

615 "tot": 0

616 },

617 "tran_cd": 30002

618 }

619 ]

620}),

621});

622

623const data = await response.json();

624console.log(data);

No example available.