This API is used for registering the invoice and getting the Invoice Registration Number (IRN). The request payload has to be as per the schema specified below.The details of the requests and responses are explained.
The format and details of Generate IRN API request is depicted in following table.
URL | |
---|---|
Content-Type |
application/json |
Method |
POST |
Attributes | Description |
---|---|
client_id | client id to be provided by E-Invoice System |
client_secret |
client secret to be provided by E-Invoice System |
Gstin |
GSTIN of the authenticated user |
user_name |
User name of the authenticated user |
AuthToken |
Authentication token returned by the E-Invoice system |
Attributes | Description |
---|---|
Data |
Base 64 encoded string of encrypted invoice JSON using Sek. |
Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | Status of the generate IRN request(values 1-Success and 0- Failure) | ||||||||||||||||||||||||
Data | If Status is "1" | ||||||||||||||||||||||||
ErrorDetails | If Status is "0" | ||||||||||||||||||||||||
InfoDtls | Any additional message to be conveyed would be passed. | ||||||||||||||||||||||||
If Status is "1"
|
|||||||||||||||||||||||||
If Status is "0"
|
JSON corresponds to the "Data" element of Generate E-Invoice Request above
{ "Version": "1.1", "TranDtls": { "TaxSch": "GST", "SupTyp": "B2B", "RegRev": "Y", "EcmGstin": null, "IgstOnIntra": "N" }, "DocDtls": { "Typ": "INV", "No": "DOC/001", "Dt": "18/08/2020" }, "SellerDtls": { "Gstin": "37ARZPT4384Q1MT", "LglNm": "NIC company pvt ltd", "TrdNm": "NIC Industries", "Addr1": "5th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 518001, "Stcd": "37", "Ph": "9000000000", "Em": "abc@gmail.com" }, "BuyerDtls": { "Gstin": "29AWGPV7107B1Z1", "LglNm": "XYZ company pvt ltd", "TrdNm": "XYZ Industries", "Pos": "12", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 562160, "Stcd": "29", "Ph": "91111111111", "Em": "xyz@yahoo.com" }, "DispDtls": { "Nm": "ABC company pvt ltd", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "Banagalore", "Pin": 562160, "Stcd": "29" }, "ShipDtls": { "Gstin": "29AWGPV7107B1Z1", "LglNm": "CBE company pvt ltd", "TrdNm": "kuvempu layout", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "Banagalore", "Pin": 562160, "Stcd": "29" }, "ItemList": [ { "SlNo": "1", "PrdDesc": "Rice", "IsServc": "N", "HsnCd": "1001", "Barcde": "123456", "Qty": 100.345, "FreeQty": 10, "Unit": "BAG", "UnitPrice": 99.545, "TotAmt": 9988.84, "Discount": 10, "PreTaxVal": 1, "AssAmt": 9978.84, "GstRt": 12.0, "IgstAmt": 1197.46, "CgstAmt": 0, "SgstAmt": 0, "CesRt": 5, "CesAmt": 498.94, "CesNonAdvlAmt": 10, "StateCesRt": 12, "StateCesAmt": 1197.46, "StateCesNonAdvlAmt": 5, "OthChrg": 10, "TotItemVal": 12897.7, "OrdLineRef": "3256", "OrgCntry": "AG", "PrdSlNo": "12345", "BchDtls": { "Nm": "123456", "ExpDt": "01/08/2020", "WrDt": "01/09/2020" }, "AttribDtls": [ { "Nm": "Rice", "Val": "10000" } ] } ], "ValDtls": { "AssVal": 9978.84, "CgstVal": 0, "SgstVal": 0, "IgstVal": 1197.46, "CesVal": 508.94, "StCesVal": 1202.46, "Discount": 10, "OthChrg": 20, "RndOffAmt": 0.3, "TotInvVal": 12908, "TotInvValFc": 12897.7 }, "PayDtls": { "Nm": "ABCDE", "AccDet": "5697389713210", "Mode": "Cash", "FinInsBr": "SBIN11000", "PayTerm": "100", "PayInstr": "Gift", "CrTrn": "test", "DirDr": "test", "CrDay": 100, "PaidAmt": 10000, "PaymtDue": 5000 }, "RefDtls": { "InvRm": "TEST", "DocPerdDtls": { "InvStDt": "01/08/2020", "InvEndDt": "01/09/2020" }, "PrecDocDtls": [ { "InvNo": "DOC/002", "InvDt": "01/08/2020", "OthRefNo": "123456" } ], "ContrDtls": [ { "RecAdvRefr": "Doc/003", "RecAdvDt": "01/08/2020", "TendRefr": "Abc001", "ContrRefr": "Co123", "ExtRefr": "Yo456", "ProjRefr": "Doc-456", "PORefr": "Doc-789", "PORefDt": "01/08/2020" } ] }, "AddlDocDtls": [ { "Url": "https://einv-apisandbox.nic.in", "Docs": "Test Doc", "Info": "Document Test" } ], "ExpDtls": { "ShipBNo": "A-248", "ShipBDt": "01/08/2020", "Port": "INABG1", "RefClm": "N", "ForCur": "AED", "CntCode": "AE", "ExpDuty": null }, "EwbDtls": { "TransId": "12AWGPV7107B1Z1", "TransName": "XYZ EXPORTS", "Distance": 100, "TransDocNo": "DOC01", "TransDocDt": "18/08/2020", "VehNo": "ka123456", "VehType": "R", "TransMode": "1" } }
{ "AckNo":112010000002315, "AckDt":"2020-08-05 15:18:00", "Irn":"11f8ef701fe294d4a14aad0b12457e62775d0fdc41a0acf05b74fbb2ddc47acb", "SignedInvoice":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjExNUY0NDI2NjE3QTc5MzhCRTFCQTA2REJFRTkxQTQyNzU4NEVEQUIiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJFVjlFSm1GNmVUaS1HNkJ0dnVrYVFuV0U3YXMifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMTIwMTAwMDAwMDIzMTUsXCJBY2tEdFwiOlwiMjAyMC0wOC0wNSAxNToxODowMFwiLFwiSXJuXCI6XCIxMWY4ZWY3MDFmZTI5NGQ0YTE0YWFkMGIxMjQ1N2U2Mjc3NWQwZmRjNDFhMGFjZjA1Yjc0ZmJiMmRkYzQ3YWNiXCIsXCJWZXJzaW9uXCI6XCIxLjAxXCIsXCJUcmFuRHRsc1wiOntcIlRheFNjaFwiOlwiR1NUXCIsXCJTdXBUeXBcIjpcIkIyQlwiLFwiUmVnUmV2XCI6XCJOXCIsXCJJZ3N0T25JbnRyYVwiOlwiWVwifSxcIkRvY0R0bHNcIjp7XCJUeXBcIjpcIklOVlwiLFwiTm9cIjpcIkRELTIwMjAwODA0LTlcIixcIkR0XCI6XCIwNC8wOC8yMDIwXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIzN0FSWlBUNDM4NFExTVRcIixcIkxnbE5tXCI6XCIgQUJDIGNvbXBhbnkgcHZ0IGx0ZFwiLFwiVHJkTm1cIjpcInZpa2FzXCIsXCJBZGRyMVwiOlwiVEUgaFwiLFwiQWRkcjJcIjpcImFiY1wiLFwiTG9jXCI6XCJCYW5nYWxvcmVcIixcIlBpblwiOjUxNTMxMSxcIlN0Y2RcIjpcIjM3XCIsXCJQaFwiOlwiOTczODk3MTk3MFwiLFwiRW1cIjpcInZpa2FzQGdtYWlsLmNvbVwifSxcIkJ1eWVyRHRsc1wiOntcIkdzdGluXCI6XCIxMUFBQUNUMzkwNEYxWlpcIixcIkxnbE5tXCI6XCJYWVogY29tcGFueSBwdnQgbHRkXCIsXCJQb3NcIjpcIjM3XCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJHQU5ESElOQUdBUlwiLFwiUGluXCI6NzM3MTAxLFwiU3RjZFwiOlwiMTFcIn0sXCJEaXNwRHRsc1wiOntcIk5tXCI6XCJuYW1lIG9mIHRoZSBjb21wYW55IGZyb20gd2hpY2ggZ29vZHMgZGlzcGF0Y2hlZFwiLFwiQWRkcjFcIjpcImFkZHJlc3NcIixcIkFkZHIyXCI6XCJCYW5nYWxvcmVcIixcIkxvY1wiOlwia3prXCIsXCJQaW5cIjo2OTA1MTMsXCJTdGNkXCI6XCIzMlwifSxcIlNoaXBEdGxzXCI6e1wiR3N0aW5cIjpcIjMyRElVUFAxMTc1RzFaMVwiLFwiTGdsTm1cIjpcInNoaXAgdHJhZGVcIixcIlRyZE5tXCI6XCJ2aWthc1wiLFwiQWRkcjFcIjpcInNoaXAgYiBub1wiLFwiQWRkcjJcIjpcIkJhbmdhbG9yZVwiLFwiTG9jXCI6XCJCYW5nYWxvcmVcIixcIlBpblwiOjY5MDUxMyxcIlN0Y2RcIjpcIjMyXCJ9LFwiSXRlbUxpc3RcIjpbe1wiSXRlbU5vXCI6MSxcIlNsTm9cIjpcIjFcIixcIklzU2VydmNcIjpcIk5cIixcIlByZERlc2NcIjpcIlN0ZWVsXCIsXCJIc25DZFwiOlwiMTAwMVwiLFwiUXR5XCI6MTAsXCJVbml0XCI6XCJCQUdcIixcIlVuaXRQcmljZVwiOjIwMC4wMCxcIlRvdEFtdFwiOjIwMDAuMDAsXCJEaXNjb3VudFwiOjEwLFwiQXNzQW10XCI6MTk5MC4wMCxcIkdzdFJ0XCI6MTIuMDAsXCJJZ3N0QW10XCI6MjM4LjgsXCJDZ3N0QW10XCI6MCxcIlNnc3RBbXRcIjowLFwiQ2VzUnRcIjo1LFwiQ2VzQW10XCI6OTkuNSxcIkNlc05vbkFkdmxBbXRcIjoxMCxcIlN0YXRlQ2VzUnRcIjoxMixcIlN0YXRlQ2VzQW10XCI6MjM4LjgwLFwiU3RhdGVDZXNOb25BZHZsQW10XCI6NSxcIk90aENocmdcIjoxMCxcIlRvdEl0ZW1WYWxcIjoyNTkyLjF9LHtcIkl0ZW1Ob1wiOjIsXCJTbE5vXCI6XCIyXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJQcmREZXNjXCI6XCJTdGVlbFwiLFwiSHNuQ2RcIjpcIjEwMDFcIixcIlF0eVwiOjEwLFwiVW5pdFwiOlwiQkFHXCIsXCJVbml0UHJpY2VcIjoyMDAuMDAsXCJUb3RBbXRcIjoyMDAwLjAwLFwiRGlzY291bnRcIjoxMCxcIkFzc0FtdFwiOjE5OTAuMDAsXCJHc3RSdFwiOjEyLjAwLFwiSWdzdEFtdFwiOjIzOC44LFwiQ2dzdEFtdFwiOjAsXCJTZ3N0QW10XCI6MCxcIkNlc1J0XCI6NSxcIkNlc0FtdFwiOjk5LjUsXCJDZXNOb25BZHZsQW10XCI6MTAsXCJTdGF0ZUNlc1J0XCI6MTIsXCJTdGF0ZUNlc0FtdFwiOjIzOC44MCxcIlN0YXRlQ2VzTm9uQWR2bEFtdFwiOjUsXCJPdGhDaHJnXCI6MTAsXCJUb3RJdGVtVmFsXCI6MjU5Mi4xfSx7XCJJdGVtTm9cIjozLFwiU2xOb1wiOlwiM1wiLFwiSXNTZXJ2Y1wiOlwiTlwiLFwiUHJkRGVzY1wiOlwiU3RlZWxcIixcIkhzbkNkXCI6XCIxMDAxXCIsXCJRdHlcIjoxMCxcIlVuaXRcIjpcIkJBR1wiLFwiVW5pdFByaWNlXCI6MjAwLjAwLFwiVG90QW10XCI6MjAwMC4wMCxcIkRpc2NvdW50XCI6MTAsXCJBc3NBbXRcIjoxOTkwLjAwLFwiR3N0UnRcIjoxMi4wMCxcIklnc3RBbXRcIjoyMzguOCxcIkNnc3RBbXRcIjowLFwiU2dzdEFtdFwiOjAsXCJDZXNSdFwiOjUsXCJDZXNBbXRcIjo5OS41LFwiQ2VzTm9uQWR2bEFtdFwiOjEwLFwiU3RhdGVDZXNSdFwiOjEyLFwiU3RhdGVDZXNBbXRcIjoyMzguODAsXCJTdGF0ZUNlc05vbkFkdmxBbXRcIjo1LFwiT3RoQ2hyZ1wiOjEwLFwiVG90SXRlbVZhbFwiOjI1OTIuMX1dLFwiVmFsRHRsc1wiOntcIkFzc1ZhbFwiOjU5NzAuMCxcIkNnc3RWYWxcIjowLFwiU2dzdFZhbFwiOjAsXCJJZ3N0VmFsXCI6NzE2LjQsXCJDZXNWYWxcIjozMjguNSxcIlN0Q2VzVmFsXCI6NzMxLjQsXCJSbmRPZmZBbXRcIjowLFwiVG90SW52VmFsXCI6Nzc3Ni4zfSxcIlJlZkR0bHNcIjp7XCJJbnZSbVwiOlwiMTIzXCIsXCJQcmVjRG9jRHRsc1wiOlt7XCJJbnZOb1wiOlwiQUJDXCIsXCJJbnZEdFwiOlwiMDIvMDIvMjAyMFwiLFwiT3RoUmVmTm9cIjpcIjEyQVwifV0sXCJDb250ckR0bHNcIjpbe1wiUmVjQWR2UmVmclwiOlwiMTIzXCIsXCJSZWNBZHZEdFwiOlwiMTIvMDIvMjAyMFwiLFwiVGVuZFJlZnJcIjpcImFiY1wiLFwiQ29udHJSZWZyXCI6XCJhYmNcIixcIkV4dFJlZnJcIjpcImFiY1wiLFwiUHJvalJlZnJcIjpcImFiY1wiLFwiUE9SZWZyXCI6XCJhYmNcIixcIlBPUmVmRHRcIjpcIjEyLzAyLzIwMjBcIn1dfSxcIkFkZGxEb2NEdGxzXCI6W3tcIlVybFwiOlwiaHR0cHM6Ly9laW52LWFwaXNhbmRib3gubmljLmluL2dzdGNvcmVfdGVzdC92MS4wMS9pbnZvaWNlXCIsXCJEb2NzXCI6XCJ2aWthc1wiLFwiSW5mb1wiOlwidmlrYXNcIn1dLFwiRXdiRHRsc1wiOntcIlRyYW5zSWRcIjpcIjEyQVdHUFY3MTA3QjFaMVwiLFwiVHJhbnNOYW1lXCI6XCJYWVogRVhQT1JUU1wiLFwiVHJhbnNNb2RlXCI6XCIxXCIsXCJEaXN0YW5jZVwiOjEwMCxcIlRyYW5zRG9jTm9cIjpcIkRPQzAxXCIsXCJUcmFuc0RvY0R0XCI6XCIwNC8wOC8yMDIwXCIsXCJWZWhOb1wiOlwia2ExMjM0NTZcIixcIlZlaFR5cGVcIjpcIlJcIn19IiwiaXNzIjoiTklDIn0.oesnTXdXgOEeRjYr6bRQ-_Ks-bnIpwtj7Zx8phzfjL6vsfuGqBokILz6ai0NHFKRxiX_bTLrgrWmwXyBdEFmt88myf4n-NP5JvwqFx4OIf0gYMFTKGLx4AQsxwXER836FDxyS33K_7Erkm7_yHsITR5sBkYrZYOWimYl5cgh4EFN2mEq0B8oIp9pSXAU2RGvuirV6Rnl902sWj1Zv_2UK8e9C7cS7maeuFvEgAHrwBjxqLVvRGDz93oRVgQcavhdNTmBr8LQo2yRQkwtZKCMY_NGDsIoJx3orAKEUE7D1RbAM6xh-uxGOlqxur50826y0sk6OuG2WB9K5g5gumxIpg", "SignedQRCode":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjExNUY0NDI2NjE3QTc5MzhCRTFCQTA2REJFRTkxQTQyNzU4NEVEQUIiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJFVjlFSm1GNmVUaS1HNkJ0dnVrYVFuV0U3YXMifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjM3QVJaUFQ0Mzg0UTFNVFwiLFwiQnV5ZXJHc3RpblwiOlwiMTFBQUFDVDM5MDRGMVpaXCIsXCJEb2NOb1wiOlwiREQtMjAyMDA4MDQtOVwiLFwiRG9jVHlwXCI6XCJJTlZcIixcIkRvY0R0XCI6XCIwNC8wOC8yMDIwXCIsXCJUb3RJbnZWYWxcIjo3Nzc2LjMsXCJJdGVtQ250XCI6MyxcIk1haW5Ic25Db2RlXCI6XCIxMDAxXCIsXCJJcm5cIjpcIjExZjhlZjcwMWZlMjk0ZDRhMTRhYWQwYjEyNDU3ZTYyNzc1ZDBmZGM0MWEwYWNmMDViNzRmYmIyZGRjNDdhY2JcIn0iLCJpc3MiOiJOSUMifQ.fya8oD85f2_K8pDWSf8N94_T24O1lA9OPpIuUwk14el_r1lhL13OFxGkklhiewSMUom8DvO9JKu4jjz2l5farRTJhiBWJ43EtEky2SLzRhJf23JYW_6PyLErYL2RTzv2PlZ75eXIBZzPkxc2erCx61T50oHmExLgl1Q6HclvgiQUAVxysq1VFv96zEZVH8I0xDNqjdvqdtsW74ZHqzpV28kDIvuyV4Z5j3bR39GE6YKMetext_x3bJ4Wt4F1z3DOzfUjuKGdEjP0fTSwNg1RpiDoH4wcaMP7RJgtbQYXn4j3YoppCEw916AmbihiT2gSODPn04vhCbBecI7oOZvxpw", "Status":"ACT", "EwbNo":191008688443, "EwbDt":"2020-08-05 15:18:00", "EwbValidTill":"2020-08-06 23:59:00", "Remarks":null }
JSON(in case of error)
{ "$schema": "http://json-schema.org/draft-07/schema#", "Title": "GST-India Invoice Document ", "Description": "GST Invoice format for IRN Generation in INDIA", "Version": { "type": "string", "minLength": 1, "maxLength": 6, "description": "Version of the schema" }, "Irn": { "type": "string", "minLength": 64, "maxLength": 64, "description": "Invoice Reference Number" }, "TranDtls": { "type": "object", "properties": { "TaxSch": { "type": "string", "minLength": 3, "maxLength": 10, "enum": [ "GST" ], "pattern": "^(GST)$", "description": "GST- Goods and Services Tax Scheme" }, "SupTyp": { "type": "string", "minLength": 3, "maxLength": 10, "enum": [ "B2B", "SEZWP", "SEZWOP", "EXPWP", "EXPWOP", "DEXP" ], "pattern": "(?i)^((B2B)|(SEZWP)|(SEZWOP)|(EXPWP)|(EXPWOP)|(DEXP))$", "description": "Type of Supply: B2B-Business to Business, SEZWP - SEZ with payment, SEZWOP - SEZ without payment, EXPWP - Export with Payment, EXPWOP - Export without payment,DEXP - Deemed Export" }, "RegRev": { "type": "string", "minLength": 1, "maxLength": 1, "enum": [ "Y", "N" ], "pattern": "^([Y|N]{1})$", "description": "Y- whether the tax liability is payable under reverse charge" }, "EcmGstin": { "type": "string", "minLength": 15, "maxLength": 15, "pattern": "^([0-9]{2}[0-9A-Z]{13})$", "description": "GSTIN of e-Commerce operator" }, "IgstOnIntra": { "type": "string", "minLength": 1, "maxLength": 1, "enum": [ "Y", "N" ], "pattern": "^([Y|N]{1})$", "description": "Y- indicates the supply is intra state but chargeable to IGST" } }, "required": [ "TaxSch", "SupTyp" ] }, "DocDtls": { "type": "object", "properties": { "Typ": { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "INV", "CRN", "DBN" ], "pattern": "(?i)^((INV)|(CRN)|(DBN))$", "description": "Document Type: INVOICE, CREDIT NOTE, DEBIT NOTE" }, "No": { "type": "string", "minLength": 1, "maxLength": 16, "pattern": "^([a-zA-Z1-9]{1}[a-zA-Z0-9\/-]{0,15})$", "description": "Document Number" }, "Dt": { "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Document Date" } }, "required": [ "Typ", "No", "Dt" ] }, "SellerDtls": { "type": "object", "properties": { "Gstin": { "type": "string", "minLength": 15, "maxLength": 15, "pattern": "([0-9]{2}[0-9A-Z]{13})", "description": "GSTIN of supplier" }, "LglNm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Legal Name" }, "TrdNm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Tradename" }, "Addr1": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Building/Flat no, Road/Street" }, "Addr2": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address 2 of the supplier (Floor no., Name of the premises/building)" }, "Loc": { "type": "string", "minLength": 3, "maxLength": 50, "pattern": "^([^\\\"])*$", "description": "Location" }, "Pin": { "type": "number", "minimum": 100000, "maximum": 999999, "description": "Pincode" }, "Stcd": { "type": "string", "minLength": 1, "maxLength": 2, "pattern": "^(?!0+$)([0-9]{1,2})$", "description": "State Code of the supplier. Refer the master" }, "Ph": { "type": "String", "minLength": 6, "maxLength": 12, "pattern": "^([0-9]{6,12})$", "description": "Phone or Mobile No." }, "Em": { "type": "string", "minLength": 6, "maxLength": 100, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "description": "Email-Id" } }, "required": [ "Gstin", "LglNm", "Addr1", "Loc", "Pin", "Stcd" ] }, "BuyerDtls": { "type": "object", "properties": { "Gstin": { "type": "string", "minLength": 3, "maxLength": 15, "pattern": "^(([0-9]{2}[0-9A-Z]{13})|URP)$", "description": "GSTIN of buyer , URP if exporting" }, "LglNm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Legal Name" }, "TrdNm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Trade Name" }, "Pos": { "type": "string", "minLength": 1, "maxLength": 2, "pattern": "^(?!0+$)([0-9]{1,2})$", "description": "State code of Place of supply. If POS lies outside the country, the code shall be 96." }, "Addr1": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address 1 of the buyer. (Building/Flat no., Road/Street etc.)" }, "Addr2": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address 2 of the buyer. (Floor no., Name of the premises/ building)" }, "Loc": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Location" }, "Pin": { "type": " number", "minimum": 100000, "maximum": 999999, "description": "Pincode" }, "Stcd": { "type": "string", "minLength": 1, "maxLength": 2, "pattern": "^(?!0+$)([0-9]{1,2})$", "description": "State Code of the buyer. Refer the master" }, "Ph": { "type": "String", "minLength": 6, "maxLength": 12, "pattern": "^([0-9]{6,12})$", "description": "Phone or Mobile No." }, "Em": { "type": "string", "minLength": 6, "maxLength": 100, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "description": "Email-Id" } }, "required": [ "Gstin", "LglNm", "Pos", "Addr1", "Loc", "Stcd" ] }, "DispDtls": { "type": "object", "properties": { "Nm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Name of the company from which the goods are dispatched" }, "Addr1": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address 1 of the entity from which goods are dispatched. (Building/Flat no.Road/Street etc.)" }, "Addr2": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address 2 of the entity from which goods are dispatched. (Floor no., Name of the premises/building)" }, "Loc": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Location" }, "Pin": { "type": "number", "minimum": 100000, "maximum": 999999, "description": "Pincode" }, "Stcd": { "type": "string", "minLength": 1, "maxLength": 2, "pattern": "^(?!0+$)([0-9]{1,2})$", "description": "State Code. Refer the master" } }, "required": [ "Nm", "Addr1", "Loc", "Pin", "Stcd" ] }, "ShipDtls": { "type": "object", "properties": { "Gstin": { "type": "string", "maxLength": 15, "minLength": 3, "pattern": "^(([0-9]{2}[0-9A-Z]{13})|URP)$", "description": "GSTIN of entity to whom goods are shipped" }, "LglNm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Legal Name" }, "TrdNm": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Trade Name" }, "Addr1": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address1 of the entity to whom the supplies are shipped to. (Building/Flat no., Road/Street etc.)" }, "Addr2": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Address 2 of the entity to whom the supplies are shipped to. (Floor no., Name of the premises/building)." }, "Loc": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Place (City,Town,Village) entity to whom the supplies are shipped to." }, "Pin": { "type": "number", "minimum": 100000, "maximum": 999999, "description": "Pincode" }, "Stcd": { "type": "string", "minLength": 1, "maxLength": 2, "pattern": "^(?!0+$)([0-9]{1,2})$", "description": "State Code to which supplies are shipped to. Refer the master" } }, "required": [ "LglNm", "Addr1", "Loc", "Pin", "Stcd" ] }, "ItemList": [{ "type": "object", "properties": { "SlNo": { "type": "string", "minLength": 1, "maxLength": 6, "pattern": "^([0-9]{1,6})$", "description": "Serial No. of Item" }, "PrdDesc": { "type": "string", "minLength": 3, "maxLength": 300, "pattern": "^([^\\\"])*$", "description": "Product Description" }, "IsServc": { "type": "string", "minLength": 1, "maxLength": 1, "enum": [ "Y", "N" ], "pattern": "^([Y|N]{1})$", "description": "Specify whether the supply is service or not. Specify Y-for Service" }, "HsnCd": { "type": "string", "minLength": 4, "maxLength": 8, "pattern": "^(?!0+$)([0-9]{4}|[0-9]{6}|[0-9]{8})$", "description": "HSN Code. Refer Master" }, "Barcde": { "type": "string", "minLength": 3, "maxLength": 30, "pattern": "^([^\\\"])*$", "description": "Bar Code" }, "Qty": { "type": "number", "minimum": 0, "maximum": 9999999999.999, "description": "Quantity" }, "FreeQty": { "type": "number", "minimum": 0, "maximum": 9999999999.999, "description": "Free Quantity" }, "Unit": { "type": "string", "minLength": 3, "maxLength": 8, "pattern": "^([A-Z|a-z]{3,8})$", "description": "Unit. Refer the master" }, "UnitPrice": { "type": "number", "minimum": 0, "maximum": 999999999999.999, "description": "Unit Price - Rate" }, "TotAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Gross Amount (Unit Price * Quantity)" }, "Discount": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Discount" }, "PreTaxVal": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Pre tax value" }, "AssAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Taxable Value (Total Amount -Discount)" }, "GstRt": { "type": "number", "minimum": 0, "maximum": 999.999, "description": "The GST rate, represented as percentage that applies to the invoiced item. It will IGST rate only." }, "IgstAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": " Amount of IGST payable." }, "CgstAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": " Amount of CGST payable." }, "SgstAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": " Amount of SGST payable." }, "CesRt": { "type": "number", "minimum": 0, "maximum": 999.999, "description": "Cess Rate" }, "CesAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Cess Amount(Advalorem) on basis of rate and quantity of item" }, "CesNonAdvlAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Cess Non-Advol Amount" }, "StateCesRt": { "type": "number", "minimum": 0, "maximum": 999.999, "description": "State CESS Rate" }, "StateCesAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "State CESS Amount" }, "StateCesNonAdvlAmt": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "State CESS Non Adval Amount" }, "OthChrg": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Other Charges" }, "TotItemVal": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Total Item Value = Assessable Amount + CGST Amt + SGST Amt + Cess Amt + CesNonAdvlAmt + StateCesAmt + StateCesNonAdvlAmt+Otherchrg" }, "OrdLineRef": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^([^\\\"])*$", "description": "Order line reference" }, "OrgCntry": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^([A-Z|a-z]{2})$", "description": "Origin Country. Refer Master" }, "PrdSlNo": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Serial number in case of each item having a unique number." }, "BchDtls": { "type": "object", "properties": { "Nm": { "type": "string", "minLength": 3, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Batch number" }, "ExpDt": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Batch Expiry Date" }, "WrDt": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Warranty Date" } }, "required": [ "Nm" ] }, "AttribDtls": [{ "type": "object", "properties": { "Nm": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Attribute name of the item" }, "Val": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Attribute value of the item" } } }] }, "required": [ "SlNo", "IsServc", "HsnCd", "UnitPrice", "TotAmt", "AssAmt", "GstRt", "TotItemVal" ] }], "ValDtls": { "type": "object", "properties": { "AssVal": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Total Assessable value of all items" }, "CgstVal": { "type": "number", "maximum": 99999999999999.99, "minimum": 0, "description": "Total CGST value of all items" }, "SgstVal": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Total SGST value of all items" }, "IgstVal": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Total IGST value of all items" }, "CesVal": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Total CESS value of all items" }, "StCesVal": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Total State CESS value of all items" }, "Discount": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Discount" }, "OthChrg": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Other Charges" }, "RndOffAmt": { "type": "number", "minimum": -99.99, "maximum": 99.99, "description": "Rounded off amount" }, "TotInvVal": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Final Invoice value " }, "TotInvValFc": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Final Invoice value in Additional Currency" } }, "required": [ "AssVal", "TotInvVal" ] }, "PayDtls": { "type": "object", "properties": { "Nm": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Payee Name" }, "AccDet": { "type": "string", "minLength": 1, "maxLength": 18, "pattern": "^([^\\\"])*$", "description": "Bank account number of payee" }, "Mode": { "type": "string", "minLength": 1, "maxLength": 18, "pattern": "^([^\\\"])*$", "description": "Mode of Payment: Cash, Credit, Direct Transfer" }, "FinInsBr": { "type": "string", "minLength": 1, "maxLength": 11, "pattern": "^([^\\\"])*$", "description": "Branch or IFSC code" }, "PayTerm": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Terms of Payment" }, "PayInstr": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Payment Instruction" }, "CrTrn": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Credit Transfer" }, "DirDr": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Direct Debit" }, "CrDay": { "type": "number", "minimum": 0, "maximum": 9999, "description": "Credit Days" }, "PaidAmt": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "The sum of amount which have been paid in advance." }, "PaymtDue": { "type": "number", "minimum": 0, "maximum": 99999999999999.99, "description": "Outstanding amount that is required to be paid." } } }, "RefDtls": { "type": "object", "properties": { "InvRm": { "type": "string", "maxLength": 100, "minLength": 3, "pattern": "^([^\\\"])*$", "description": "Remarks/Note" }, "DocPerdDtls": { "type": "object", "properties": { "InvStDt": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Invoice Period Start Date" }, "InvEndDt": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Invoice Period End Date" } }, "required": [ " InvStDt ", " InvEndDt " ] }, "PrecDocDtls": [{ "type": "object", "properties": { "InvNo": { "type": "string", "minLength": 1, "maxLength": 16, "pattern": "^[1-9a-zA-Z]{1}[0-9a-zA-Z\/-]{1,15}$", "description": "Reference of original invoice, if any." }, "InvDt": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Date of preceding invoice" }, "OthRefNo": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Other Reference" } } }], "required": [ "InvNo", "InvDt" ], "ContrDtls": [{ "type": "object", "properties": { "RecAdvRefr": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Receipt Advice No." }, "RecAdvDt": { "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Date of receipt advice" }, "TendRefr": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Lot/Batch Reference No." }, "ContrRefr": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Contract Reference Number" }, "ExtRefr": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Any other reference" }, "ProjRefr": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Project Reference Number" }, "PORefr": { "type": "string", "minLength": 1, "maxLength": 16, "pattern": "^([^\\\"])*$", "description": " PO Reference Number" }, "PORefDt": { "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description ": "POReferencedate " } } }] } }, "AddlDocDtls ": [{ "type ": "object ", "properties ": { "Url ": { "type ": "string ", "minLength ": 3, "maxLength ": 100, "pattern ": "^([^\\\"])*$", "description ": "SupportingdocumentURL " }, "Docs ": { "type ": "string ", "minLength ": 3, "maxLength ": 1000, "pattern ": "^([^\\\"])*$", "description": "Supporting document in Base64 Format" }, "Info": { "type": "string", "minLength": 3, "maxLength": 1000, "pattern": "^([^\\\"])*$", "description": "Any additional information" } } }], "ExpDtls": { "type": "object", "properties": { "ShipBNo": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^([^\\\"])*$", "description": "Shipping Bill No." }, "ShipBDt": { "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$", "description": "Shipping Bill Date" }, "Port": { "type": "string", "minLength": 2, "maxLength": 10, "pattern": "^[0-9|A-Z|a-z]{2,10}$", "description": "Port Code. Refer the master" }, "RefClm": { "type": "string", "minLength": 1, "maxLength": 1, "pattern": "^([Y|N]{1})$", "description": "Claiming Refund. Y/N" }, "ForCur": { "type": "string", "minLength": 3, "maxLength": 16, "pattern": "^[A-Z|a-z]{3,16}$", "description": "Additional Currency Code. Refer the master" }, "CntCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^([A-Z]{2})$", "description": "Country Code. Refer the master" }, "ExpDuty": { "type": "number", "minimum": 0, "maximum": 999999999999.99, "description": "Export Duty" } } }, "EwbDtls": { "type": "object", "properties": { "TransId": { "type": "string", "minLength": 15, "maxLength": 15, "pattern": "^([0-9]{2}[0-9A-Z]{13})$", "description": "Transin/GSTIN" }, "TransName": { "type": "string", "minLength": 3, "maxLength": 100, "pattern": "^([^\\\"])*$", "description": "Name of the transporter" }, "TransMode": { "type": "string", "maxLength": 1, "minLength": 1, "enum": [ "1", "2", "3", "4" ], "pattern": "^([1-4]{1})?$", "description": "Mode of transport (Road-1, Rail-2, Air-3, Ship-4)" }, "Distance": { "type": "number", "minimum": 0, "maximum": 4000, "description": " Distance between source and destination PIN codes" }, "TransDocNo": { "type": "string", "minLength": 1, "maxLength": 15, "pattern": "^([a-zA-Z0-9\/-]{1,15})$", "description": "Tranport Document Number" }, "TransDocDt": { "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-/]*$", "description": "Transport Document Date" }, "VehNo": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^([A-Z|a-z|0-9]{4,20})$", "description": "Vehicle Number" }, "VehType": { "type": "string", "minLength": 1, "maxLength": 1, "enum": [ "O", "R" ], "pattern": "^([O|R]{1})$", "description": "Whether O-ODC or R-Regular " } }, "required": [ "Distance" ] }, "required": [ "Version", "TranDtls", "DocDtls", "SellerDtls", "BuyerDtls", "ItemList", "ValDtls" ] }
Content will be updated shortly.