GST APIGSTR5Save GSTR5 data
Save GSTR5 data
PUT
https://apisandbox.whitebooks.in/gstr5/retsaveUsed to save entire GSTR5 invoices.
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: "0817GBR00014NRX"
fpstringoptionalFp Type
Example: "082016"
b2barray<object>optionalArray items:
ctinstringoptionalGSTIN/UID of the Receiver taxpayer/UN,Govt Bodies
Example: "01AABCE2207R1Z5"
invarray<object>optionalArray items:
flagstringoptionalGross TrunOver
Example: "D"
inumstringoptionalSupplier Invoice Number
Example: "S008400"
idtstringoptionalSupplier Invoice Date
Example: "24-01-2024"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service.
Example: "06"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
itmsarray<object>optionalb2baarray<object>optionalArray items:
ctinstringoptionalGSTIN/UID of the Receiver taxpayer/UN,Govt Bodies
Example: "01AABCE2207R1Z5"
invarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
oinumstringoptionalSupplier Invoice Number
Example: "S008400"
oidtstringoptionalSupplier Invoice Date
Example: "24-01-2024"
inumstringoptionalSupplier Invoice Number
Example: "S008400"
idtstringoptionalSupplier Invoice Date
Example: "24-01-2024"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service.
Example: "06"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
itmsarray<object>optionalb2clarray<object>optionalArray items:
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service
Example: "05"
invarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
inumstringoptionalSupplier Invoice Number
Example: "S008400"
idtstringoptionalSupplier Invoice Date
Example: "24-01-2024"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
diff_percentnumberoptionalDifferential percentage
Example: 0.65
itmsarray<object>optionalb2claarray<object>optionalArray items:
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service
Example: "06"
invarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
inumstringoptionalSupplier Invoice Number
Example: "92661"
idtstringoptionalSupplier Invoice Date
Example: "24-01-2024"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
oinumstringoptionalSupplier Invoice Number
Example: "S008400"
oidtstringoptionalSupplier Invoice Date
Example: "24-01-2024"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
itmsarray<object>optionalb2csarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
suptystringoptionalSupply Type of B2cs
Example: "INTER"
rtnumberoptionalrate
Example: 5
posstringoptionalRecipient state code
Example: "05"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
txvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 100
iamtnumberoptionalIGST Amount as per invoice
Example: 10
csamtnumberoptionalCess Amount as per invoice
Example: 10
b2csaarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
suptystringoptionalSupply Type of B2cs
Example: "INTER"
posstringoptionalRecipient state code
Example: "05"
diff_percentnumberoptionalDifferential percentage
omonstringoptionalOriginal Month
Example: "122016"
itmsarray<object>optionalArray items:
txvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
rtnumberoptionalrate
Example: 5
iamtnumberoptionalIGST Amount as per invoice
Example: 10
camtnumberoptionalCGST Amount as per invoice
Example: 0
samtnumberoptionalSGST Amount as per invoice
Example: 0
csamtnumberoptionalCess Amount as per invoice
Example: 10
cdnarray<object>optionalArray items:
ctinstringoptionalGSTIN/UID of the Receiver taxpayer/UN,Govt Bodies
Example: "01AABCE2207R1Z5"
ntarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
nttystringoptionalCredit/debit note type
Example: "C"
nt_numstringoptionalCredit/debit note number
Example: "533515"
nt_dtstringoptionalCredit/debit note date
Example: "23-03-2024"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service.
Example: "06"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
itmsarray<object>optionalcdnaarray<object>optionalArray items:
ctinstringoptionalGSTIN/UID of the Receiver taxpayer/UN,Govt Bodies
Example: "01AABCE2207R1Z5"
ntarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
nttystringoptionalCredit/debit note type
Example: "C"
nt_numstringoptionalCredit/debit note number
Example: "533515"
nt_dtstringoptionalCredit/debit note date
Example: "23-03-2024"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service.
Example: "06"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
ont_numstringoptional Original Credit/debit note number
Example: "533515"
ont_dtstringoptionalOriginal Credit/debit note date
Example: "23-04-2024"
itmsarray<object>optionalcdnurarray<object>optionalitems: any
cdnuraarray<object>optionalArray items:
flagstringoptionalTaxpayer action
Example: "E"
valnumberoptionalSupplier Invoice Value
Example: 729248.16
posstringoptionalMaintained in GST System common database POS as provided in law / actual provision of service.
Example: "06"
nttystringoptionalCredit/debit note type
Example: "C"
nt_numstringoptionalCredit/debit note number
Example: "533515"
nt_dtstringoptionalCredit/debit note date
Example: "23-03-2024"
ont_numstringoptional Original Credit/debit note number
Example: "533515"
ont_dtstringoptionalOriginal Credit/debit note date
Example: "23-04-2024"
diff_percentnumberoptionalDifferential percentage
Example: 0.65
itmsarray<object>optionalArray items:
numintegeroptionalSerial no
Example: 1
itm_detobjectoptionalimp_garray<object>optionalArray items:
flagstringoptionalFlag for identifying New/Modified
Example: "E"
boe_numstringoptionalBill of Entry Number
Example: "2566212"
boe_dtstringoptionalBill Of Entry Date
Example: "23-09-2016"
boe_valnumberoptionalBill Of Entry Value
Example: 10000
port_codestringoptionalPort Code
Example: "24242A"
diff_percentnumberoptionalDifferential Percentage of Tax
Example: 0.65
itmsarray<object>optionalArray items:
numintegeroptionalSerial no
Example: 1
txvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
rtnumberoptionalrate
Example: 5
iamtnumberoptionalIGST Amount as per invoice
Example: 325
csamtnumberoptionalCess Amount as per invoice
Example: 500
elgstringoptionalEligibility for ITC
Example: "ip"
tx_inumberoptionalTotal IGST available as ITC
Example: 123.93
tx_csnumberoptionalTotal CESS available as ITC
Example: 0
imp_gaarray<object>optionalArray items:
flagstringoptionalFlag for identifying New/Modified
Example: "E"
boe_numstringoptionalBill of Entry Number
Example: "2566212"
boe_dtstringoptionalBill Of Entry Date
Example: "23-09-2016"
boe_valnumberoptionalBill Of Entry Value
Example: 10000
port_codestringoptionalPort Code
Example: "24242A"
oboe_numstringoptionalOriginal Bill of Entry Number
Example: "2566212"
oboe_dtstringoptionalOriginal Bill Of Entry Date
Example: "23-09-2016"
oport_codestringoptionalOriginal Port Code
Example: "24242A"
diff_percentnumberoptionalDifferential Percentage of Tax
Example: 0.65
itmsarray<object>optionalArray items:
numintegeroptionalSerial no
Example: 1
txvalnumberoptionalTaxable value of Goods or Service as per invoice
Example: 10000
rtnumberoptionalrate
Example: 5
iamtnumberoptionalIGST Amount as per invoice
Example: 325
csamtnumberoptionalCess Amount as per invoice
Example: 500
elgstringoptionalEligibility for ITC
Example: "ip"
tx_inumberoptionalTotal IGST available as ITC
Example: 123.93
tx_csnumberoptionalTotal CESS available as ITC
Example: 0
Response
Not Found. If requested entity is not found or if requested API is not found.
No example available.