| APIs now available in IVL's API Hub:- |
APIs for testing in Sandbox*:-
|
Note: More APIs are in the pipeline, and will be added to IVL's API Hub in the coming weeks
In case you face any difficulty in using the API's, contact us as team@optieinvoice.com
URL: https://api.optieinvoice.com/dev/optiapi/b2cqrcode
Method :- POST
{
"SupUpi":"abc.9878",
"SupAccNo":01830110000012,
"SupIFSC":"HDFC0000183",
"PayeeName":"GCMMF",
"CustName":"Pickakart Digital Marketing Pvt. Ltd",
"DocNo":1114113967,
"DocDt":"02/04/2021",
"TotInvVal":2664.67,
"Cgst":60.56,
"Sgst":60.56,
"Igst":121.12,
"Cess":0.00,
"Paid":0
}
{
"Data": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIEAAAAADYoy0BAAAIv0lEQVR4nOyd4Y4cwQmEc9G9/ys7csZS+kKq/NFzVspSfT+s02wPzQ4C0YB3Pn/8+EcJ4p//bwXKVz5//vPxQZef/vTcNT3MS5sS5nUl51njr/M1fhfO3NfLVzx31UPCqEHC+PzPn95VeQBRn075SoIKhlPOlK925Luo0KeunBJU4OLPth4SRg0Sxud/XyBZh3Lk8291Zd418RkLCXRbyeq7b/W5C/sn9ZAwapAwRsh6Dz/6qYCm1nuZJNvxBzevIckbSeDy1EPCqEHCeBGyfD5D8q4p7byX1IhIpYiHEbXSZ5JK/7vAVQ8JowYJY4Qs7mgqBHmHVYHIh775t9KWh1Au4axZkTBFqnCKekgYNUgYR8jiva0HFXZ8CZr0E4lMHyTveoh334UcD/mzrYeEUYOE8e+QdXeE4cMMd0FMBSVe9fI9u20Q43uR64p6SBg1SBgfP12KHNAevnfOkU9JbfMWXjF7s9d2zEOtOamHhFGDhHFkWdtiMjnskI4br335XfjupMA+d7/ThBxLzyv1kDBqkDDsKCkvlW9npbYZiA81ZMfvClbzW2yHMSbnp/WQMGqQMET5ffbIeN3plMDrRdzB/e7b+tVcuS3+T/kklKlP6yFh1CBhiCxL5UvnSu/C22K72t1f9zkV38WHGnI85Pmkl1MPCaMGCQOU3/0BjdepvOPzgYHzutLTwytUPEv0mnBt6yFh1CBh2IOhHzMgeREfFSDSpibz+pRJDnFKDu8bKsnbXmc9JIwaJIwjy3rgmcMvAcsBCV7WPuUr3fy9Xtsp32vLpZHsUVEPCaMGCePjfzvTnSO/7wn6HdW9pwQvk+dURDLPnRTzedZDwqhBwhA/PsNrO+quba/thHQb+ZQUD2XbsYQ3uWhrWX8JNUgYovy+dXDPm4MekbbNrCa8reA1mZ9uj7H1kDBqkDBG+V05OJ+zOlEFfM92JmqOKGybBXMleQ7bSteUM6mHhFGDhDHmsnwZXHX9+L13ORsfovAy5/qtTK7V3FftclIPCaMGCUNkWXc9ON4XOyUr51WZjx+oOLV6r4nKqUhIVLtMWn4PpgYJ4+gY8jEDKWxZz/neYYZtF+9u1IFnZUqO0v+hHhJGDRIGfinYXcmd5CEkayKSSb9yasK19YdKJYc8t2ZZwdQgYYhR0l8fvui+TXxedDeX9b5jSDI3L4dL8Jo/1EPCqEHCsAdDfnzjB8BTzvZgOFdyTebunjcZGq/+zbvqIWHUIGGIjuGbYHWu946vVp67zN2nDlOaukIOnlzOfFZqqIPrUA8JowYJQ7wUzGdNvMc3IRmOn5uaa3x4JJnS/Ba867fVzWtbDwmjBglD/B/DL0uW+RWpWZGi9LacPrVVOk+ZXsKUQ65sv+NDPSSMGiQM8IL7BzK5RErlW7j7b+tjao1f7zXxz2fuMqmHhFGDhIF/fEbBa1C8M7jNVYhWfK9TcyLnhBf25y4P9ZAwapAwRsh64P2yede5hhzl/Hryt9LtrnOn7uVHQi5hUg8JowYJA7/g3pfc79b4PqPSh99FQoTPD1WoJFfIN2qWFU8NEoZ4jyHJOn5fuN/nWvPeuSPRjcj04UUFGRK4uG7zydRDwqhBwhCjpG8gHUN117aHyPW56xhua2JEt2ZZfxU1SBjH/zH0ocZf99kUydB4zep9vcjnezyf9P1HJdk/vXpIGDVIGPb/GH5ZKDKlu2klL3NC+pI8uyMBkHzfu6Cq5DdkRVKDhGEPhn7YgHTuth3DU7KSptb/icBLdJtrlMz56aQeEkYNEsb48RlVTPZZkPpUSfCVHx/iyHACr1zxepTPr4g+fseHekgYNUgYomM44VUjXr7mgcXjQysJMvwASHRQeyl9zrvqIWHUIGHYF9y/6a9t61d+Lz88cHeg+9MdQ35cPamHhFGDhGH/W/T73txvNn9R4+LlfX/vhIdKv4aPYZx31UPCqEHCED+kPEcU1OjCrHrNT9V1Uq1Su2zDAs8G+fFwHvqm/kqHU8JJPSSMGiSMkWWRQ9B5RQoGRfK5UkkgMrlWXpM7OUqT7aGyHhJGDRLGGHIgTXyeVygJp5zt4Yv3+JQ0JdNr6yWToY5mWX8hNUgY9g07vonPD3ceFbhUx22uOeXM6349z4JUjuefCQmk5131kDBqkDBGx/DXZex6nG3WwY+BPD9Ud92VyhVv2gr1kDBqkDDG26Inbw6Mc40q4/sdyWHwTXF+Wx/jYwwqYKpnVQ8JowYJ45t+yYEMBmwnvuandwX5uaOH5Jx3d5F6Vz0kjBokDPC2aB5MzvV3bq52fzNc6rkL1KRWxndpLSuYGiQM0DHkJW4+MMAzmbu60HcdZrc9zfchuh4SRg0ShniPoerW8cml7cHK6+CzLB9I1e78sDk/JbuTTui8Ug8JowYJQ7yu4oSPg6pP1Rq1y5sD4LaatNV5G3gnXmY9JIwaJAzxgvt55U2lSGVrPBPjR0v1t+/TER3myjecz7ZZVjA1SBjHj8947o5CvpdHAtddqPSTV2TEgsicOt9NiJ3UQ8KoQcIYv/2+nTUi6+fKN9mOP9ap2pFfQ/ZVEuaVNzlYPSSMGiQM8RN/JEvheRfJavi45lxD8N/o7ptus0qvSQ+GkdQgYdjfy5I3LY9O8967MMgzQK8JCXQ8e1Qyt+MiDVmR1CBhgFHSE394fHM42k5/qRzJS57y1e534XRKU9U51RSoh4RRg4QxOoaK98eoKY1Un4hu/LBJdvc7btsB2zywHhJGDRLGGCXl4UK5Hg9E27kppYP/9Hu7e3e5lpdzUg8JowYJQ0y/E/wBjQcKH8rm5BL52+s895rfyPclp55EGqEeEkYNEsaLkKUg/TJ1nYQgPuTgg4mXpsKmknxXnJ/X6yFh1CBhjJBF8gGSL5GMaK5U8GyK6E9GHdQVtaMKSvyQ+1APCaMGCQP8H8OTu3ktnmPMNV+UXfb+vOZzPalrkSfAJU/qIWHUIGFczWWVP0c9JIwaJIx/BQAA///Mvxfyy05KuQAAAABJRU5ErkJggg=="
}
URL: https://api.optieinvoice.com/dev/optiapi/extractor
Method :- POST
{
"vendorCode":"", // Leave blank for untrained documents
"type":"Invoice", // For now, let this remain as Invoice
"subType":"Material", // For now, let this remain as Material
"document":"JVBERi..." // Here, copy/paste the base64 encoding of the PDF file to be extracted
}
{
"vendorcode": "AAACC2937K",
"vendorname": "",
"vendorgstn": "27AAACC2937K1ZL",
"vendorpin": "202100",
"pannumber": "AAACC2937K",
"buyergstn": "27AAACT2727Q1ZW",
"invoicenumber": "",
"invoicedate": "30-Nov-2020",
"ponumber": "2021003489",
"podate": "1-Oct-2019",
"irn": "",
"cgstvalue": "78,934.10",
"sgstvalue": "1.24",
"igstvalue": "1.00",
"cgstrate": "9",
"sgstrate": "9",
"igstrate": "5",
"ugstvalue": "1.00",
"ugstrate": "9",
"materialcode": "222970000356",
"hsncode": "411057",
"saccode": "NEAR",
"tcspercentage": "",
"cess": "",
"discpercent": "",
"discamount": "1.00",
"poitemnumber": ".",
"invoicequantity": "2021003489",
"uom": "FOR",
"invoicevaluelesstax": "1.00",
"totalinvoicevalue": "30.11"
}
{
"Data": {
"message": "Vendor Code Not Found! "
}
}
URL: https://api.optieinvoice.com/dev/optiapi/gstindetails?gstin=<gstin number>
Method :- GET
https://api.optieinvoice.com/dev/optiapi/gstindetails?gstin=32AAACT8102H1ZR
{
"Data": {
"Gstin": "32AAACT8102H1ZR",
"TradeName": "INNOVAL DIGITAL SOLUTIONS PRIVATE LIMITED",
"LegalName": "INNOVAL DIGITAL SOLUTIONS PRIVATE LIMITED",
"AddrBnm": "THEJASWINI",
"AddrBno": "5TH Floor",
"AddrFlno": "",
"AddrSt": "TECHNOPARK",
"AddrLoc": "TRIVANDRUM",
"StateCode": 32,
"AddrPncd": 695581,
"TxpType": "REG",
"Status": "ACT",
"BlkStatus": "U"
}
}
{
"Data": {
"Status": 0,
"ErrorDetails": [
{
"ErrorCode": "3001",
"ErrorMessage": "Requested data is not available"
}
],
"Data": "Si/iAHBJ8lMkShOgIu4+mA==",
"InfoDtls": null
}
}
URL: https://api.optieinvoice.com/dev/optiapi/hsndetails/?hsncode=< hsn code >
Method :- GET
https://api.optieinvoice.com/dev/optiapi/hsndetails?hsncode=19012000
{
"Data": {
"hsnCode": "19012000",
"hsnDesc": " MALT EXTRACT; FOOD PREPARATIONS OF FLOUR, GROATS, MEAL, STARCH OR MALT EXTRACT, NOT CONTAINING COCOA OR CONTAINING LESS THAN 40% BY WEIGHT OF COCOA CALCULATED ON A TOTALLY DEFATTED BASIS, NOT ELSEWHERE SPECIFIED OR INCLUDED; FOOD PREPARATIONS OF GOODS OF",
"status": "1"
}
}
{
"Data": {
"status": "0",
"error": "Invalid HSN Code,",
"info": null
}
}
URL: https://api.optieinvoice.com/dev/optiapi/pincodedetails?<pin code>
Method :- GET
https://api.optieinvoice.com/dev/optiapi/pincodedetails?695001
{
"Data": [
{
"Message": "Number of pincode(s) found:3",
"Status": "Success",
"PostOffice": [
{
"Name": "Thiruvananthapuram ",
"District": "Thiruvananthapuram",
"State": "Kerala",
"Country": "India",
"Pincode": "695001"
},
{
"Name": "Thiruvananthapuram AG's",
"District": "Thiruvananthapuram",
"State": "Kerala",
"Country": "India",
"Pincode": "695001"
},
{
"Name": "Thiruvananthapuram Govt Press",
"District": "Thiruvananthapuram",
"State": "Kerala",
"Country": "India",
"Pincode": "695001"
}
]
}
]
}
{
"Data": [
{
"Message": "No records found",
"Status": "Error",
"PostOffice": null
}
]
}
URL: https://api.optieinvoice.com/dev/optiapi/placedetails?<district name>
Method :- GET
https://api.optieinvoice.com/dev/optiapi/placedetails?Thiruvananthapuram
{
"status": true,
"Data": [
{
"officename": "Vanchiyoor Junction S.O",
"pincode": "695035",
"circlename": "Kerala",
"taluk": "Thiruvananthapuram",
"districtname": "Thiruvananthapuram",
"statename": "KERALA"
},
{
"officename": "Santhigiri S.O",
"pincode": "695589",
"circlename": "Kerala",
"taluk": "Thiruvananthapuram",
"districtname": "Thiruvananthapuram",
"statename": "KERALA"
},
{
"officename": "Technopark S.O",
"pincode": "695581",
"circlename": "Kerala",
"taluk": "Thiruvananthapuram",
"districtname": "Thiruvananthapuram",
"statename": "KERALA"
},
{
"officename": "Mannanathala S.O",
"pincode": "695015",
"circlename": "Kerala",
"taluk": "Trivendrum",
"districtname": "Thiruvananthapuram",
"statename": "KERALA"
},
{
"officename": "Thycaud S.O",
"pincode": "695014",
"circlename": "Kerala",
"taluk": "Thiruvananthapuram",
"districtname": "Thiruvananthapuram",
"statename": "KERALA"
} .....
]
}
{
"status": false,
"Data": [],
"error": "Invalid district name"
}
URL: https://api.optieinvoice.com/dev/optiapi/getstatecode?<state name>
Method :- GET
https://api.optieinvoice.com/dev/optiapi/getstatecode?Tamil nadu
{
"status": true,
"Data": "33"
}
{
"status": false,
"Data": null,
"error": "Invalid state name"
}
URL: https://api.optieinvoice.com/dev/optiapi/getdistance?from=<from pin>&to=<to pin>
Method :- GET
https://api.optieinvoice.com/dev/optiapi/getdistance?from=695524&to=695001
{
"Data": {
"success": true,
"value": "23.1",
"unit": "Km"
}
}
{
"Data": {
"success": false,
"value": "Destination pincode is not valid "
}
}
URL: https://api.optieinvoice.com/dev/filing/
Method :- POST
{
"Version": "1.1",
"TranDtls": {
"TaxSch": "GST",
"SupTyp": "B2B",
"RegRev": "N"
},
"DocDtls": {
"Typ": "INV",
"No": "M10AB01",
"Dt": "21/07/2021"
},
"SellerDtls": {
"Gstin": "29AAYPT1804B000",
"LglNm": "ABC Ltd",
"Addr1": "Bangalore",
"Loc": "Bangalore",
"Pin": 562160,
"Stcd": "29"
},
"BuyerDtls": {
"Gstin": "29AAYPT1804B022",
"LglNm": "K & K Industries",
"TrdNm": "K & K Industries",
"Pos": "29",
"Addr1": "Plot No. 74, Genesis Industrial Township, Palghar Phase - I, Kolgaon",
"Loc": "Bangalore",
"Pin": 562160,
"Stcd": "29"
},
"ValDtls": {
"AssVal": 9090,
"CgstVal": 818.1,
"SgstVal": 818.1,
"IgstVal": 0,
"CesVal": 0,
"StCesVal": 0,
"TotInvVal": 10726.2,
"TotInvValFc": 10726.2
},
"ItemList": [
{
"SlNo": "1",
"PrdDesc": "PERFUMES",
"IsServc": "N",
"HsnCd": "33030010",
"Barcde": "000",
"Qty": 0,
"FreeQty": 0,
"Unit": "OTH",
"UnitPrice": 0,
"TotAmt": 9090,
"Discount": 0,
"AssAmt": 9090,
"GstRt": 18,
"IgstAmt": 0,
"CgstAmt": 818.1,
"SgstAmt": 818.1,
"CesRt": 0,
"CesNonAdvlAmt": 0,
"StateCesAmt": 0,
"OthChrg": 0,
"TotItemVal": 10726.2
}
]
}
{
"success": true,
"url": "https://api.efiling.ivldsp.in/app/filing/6b71410ef07855d224be3d54b62a7fee7039fdc912ebdb17c65fbd8cd6284c07"
}
{
"errorType": "Error",
"errorMessage": "Invoice already saved! check for Duplicate (Invoice Number, GSTIN, Fiscal)",
"trace": [
"Error: Invoice already saved! check for Duplicate (Invoice Number, GSTIN, Fiscal)",
" at /var/task/lib/aws-db.js:341:20",
" at processTicksAndRejections (internal/process/task_queues.js:97:5)"
]
}
URL: https://api.optieinvoice.com/dev/filing/<irn>
Method :- GET
https://api.optieinvoice.com/dev/filing/387a0087f36e59e7bf819190105ba530e5e3b0e8dec5162899e523f65586f859
{
"success": true,
"invoice": {
"AckNo": 112110087585757,
"AckDt": "2021-07-09 16:20:00",
"Irn": "387a0087f36e59e7bf819190105ba530e5e3b0e8dec5162899e523f65586f859",
"SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEQzU3REUxMzU4QjMwMEJBOUY3OTM0MEE2Njk2ODMxRjND...",
"SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEQzU3REUxMzU4QjMwMEJBOUY3OTM0MEE2Njk2ODMxRjNDO...",
"Status": 1,
"EwbNo": null,
"EwbDt": null,
"EwbValidTill": null,
"Remarks": null
}
}
URL: https://api.optieinvoice.com/dev/filing/<irn>
Method :- DELETE
https://api.optieinvoice.com/dev/filing/387a0087f36e59e7bf819190105ba530e5e3b0e8dec5162899e523f65586f859
Method :- GET
{
"success": true,
"invoice": {
"AckNo": 112110090138443,
"AckDt": "2021-07-23 14:29:00",
"Irn": "3829524c7ce7127477ce7f78d0c49328191d28cce0c5efdccb057d8b3f50092e",
"SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkV...",
"SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVE...",
"Status": "CNL",
"EwbNo": null,
"EwbDt": null,
"EwbValidTill": null,
"Remarks": null
}
}
URL: https://api.optieinvoice.com/dev/ewaybill/
Method :- POST
{
"Irn": "28925a5175116438d49304f63f319e232a66edcc10c0e6060c57af5e9f41c7c4",
"Distance": 60,
"TransMode": "1",
"TrnDocDt": "03/17/2021",
"TrnDocNo": "AA10AB26",
"VehNo": "AP29V5650",
"VehType": "R"
}
{
"success": true,
"Data": {
"EwbNo": 141009274585,
"EwbDt": "2021-07-22 13:38:00",
"EwbValidTill": "2021-07-23 23:59:00",
"irn": "28925a5175116438d49304f63f319e232a66edcc10c0e6060c57af5e9f41c7c4",
"Status": "1"
}
}
{
"success": true,
"Data": {
"Status": 0,
"ErrorDetails": [
{
"ErrorCode": "4002",
"ErrorMessage": "EwayBill is already generated for this IRN"
}
],
"Data": "0N22JwQGc7YwsN9CapeQ8Q==",
"InfoDtls": null,
"irn": "55487710894268e1c58af87b178a9eadb231d4c9f1b4d26a180f419467d3b4e9"
}
}
URL: https://api.optieinvoice.com/dev/ewaybill/<<e-way numbner>
Method :- DELETE
https://api.optieinvoice.com/dev/ewaybill/131009275639
Method :- GET
{
"success": true,
"Data": {
"ewayBillNo": "131009275639",
"cancelDate": "23/07/2021 11:41:00 AM",
"status": "1"
}
}
{
"success": true,
"Data": {
"status": "0",
"error": "Validity period lapsed, you cannot cancel this eway bill,",
"info": null
}
}