Create Document#
Create Invoice API is used to create an Invoice using the given request payload. It is an Invoice creation reported to GSTN.
Route
/invx/apis/{iridessa-version}/orgs/{org-id}/invoice/bulk
- active 'iridessa-version': v1
- method: POST
URL Parameters#
| Name | Description | Type |
|---|---|---|
| iridessa-version | version of the API for example, v1 |
string |
| org-id | theodore organisation id | string |
Headers#
All headers are mentioned in common headers
Request#
Please refer the following request body for reference-
Sample request body
[
{
"payload": {
"Version": "1.1",
"Irn": "",
"TranDtls": {
"TaxSch": "GST",
"SupTyp": "DEXP",
"RegRev": false,
"EcmGstin": null,
"IgstOnIntra": false
},
"DocDtls": {
"Typ": "INV",
"No": "Q040938D983A84FB",
"Dt": "22/11/2022"
},
"SellerDtls": {
"Gstin": "27AAAPI3182M002",
"LglNm": "Acme Widgets Private Limited",
"TrdNm": null,
"Addr1": "2345",
"Addr2": null,
"Loc": "Uttar Pradesh",
"Pin": 400049,
"Stcd": "27",
"Ph": null,
"Em": null
},
"BuyerDtls": {
"Gstin": "27ACBPN2353E1ZX",
"LglNm": "Long Term Enterprises LLP",
"TrdNm": null,
"Pos": "27",
"Addr1": "1234",
"Addr2": null,
"Loc": "Pune",
"Pin": 400049,
"Stcd": "27",
"Ph": null,
"Em": null
},
"ValDtls": {
"AssVal": 100,
"CgstVal": 0,
"SgstVal": 0,
"IgstVal": 0,
"CesVal": null,
"StCesVal": null,
"Discount": null,
"OthChrg": null,
"RndOffAmt": null,
"TotInvVal": 100,
"TotInvValFc": null
},
"DispDtls": {
"Nm": "Acme Widgets Private Limited",
"Addr1": "112",
"Addr2": "Acme Building",
"Loc": "ABC",
"Pin": 400049,
"Stcd": "27"
},
"ShipDtls": {
"Gstin": "27ACBPN2353E1ZX",
"LglNm": "Acme Widgets Private Limited",
"TrdNm": "Acme Widgets Private Limited",
"Addr1": "112",
"Addr2": "Acme Building",
"Loc": "ABC",
"Pin": 400049,
"Stcd": "27"
},
"PayDtls": {
"Nm": "Acme Widgets Private Limited",
"AccDet": null,
"Mode": "Cash",
"FinInsBr": null,
"PayTerm": "100",
"PayInstr": "100",
"CrTrn": "100",
"DirDr": "100",
"CrDay": 100,
"PaymtDue": 900,
"PaidAmt": 100
},
"RefDtls": {
"InvRm": "Remarks",
"DocPerdDtls": {
"InvStDt": "01/10/2022",
"InvEndDt": "01/10/2022"
},
"PrecDocDtls": null,
"ContrDtls": null
},
"ExpDtls": {
"ShipBNo": "shpbill123",
"ShipBDt": "01/10/2022",
"Port": "INYNL6",
"RefClm": false,
"ForCur": "INR",
"CntCode": "IN",
"ExpDuty": 0
},
"EwbDtls": {
"TransId": "27AAAPI3182M002",
"TransName": "Driver",
"TransMode": "1",
"Distance": 5,
"TransDocNo": "20/22",
"TransDocDt": null,
"VehNo": "KA51ES1122",
"VehType": "O"
},
"AddlDocDtls": null,
"ItemList": [
{
"ItemNo": null,
"SlNo": "1",
"PrdDesc": "Acme product",
"IsServc": false,
"HsnCd": "33052000",
"UnitPrice": 100,
"TotAmt": 100,
"AssAmt": 100,
"GstRt": 0,
"TotItemVal": 100,
"Barcde": null,
"Qty": 1,
"FreeQty": null,
"Unit": "BAG",
"Discount": 0,
"PreTaxVal": null,
"SgstAmt": 0,
"CgstAmt": 0,
"IgstAmt": null,
"CesRt": null,
"CesAmt": null,
"StateCesRt": null,
"StateCesAmt": null,
"StateCesNonAdvlAmt": null,
"CesNonAdvlAmt": null,
"OthChrg": null,
"OrdLineRef": null,
"OrgCntry": null,
"PrdSlNo": null,
"AttribDtls": null,
"BchDtls": null
}
]
},
"meta": {
"generateEinvoice": true
}
}
]
Response#
Successful response will have the response in “data” attribute as a json.
Sample response body can be either of two depending upon meta field
{
"status": "1",
"data": [
{
"itemStatus": "1",
"itemData": {
"id": "3dcf56f1-3699-41a0-8087-7dba3a6f2215",
"irn": "08c27d85081bc1a5abd4f17a64bc16963a2d55dcba4f904375278a1b6a09a976",
"docNumber": "PBEAC9E7463154B9",
"docType": "100",
"docDate": "23/01/2023",
"sellerGstin": "27AAAPI3182M002",
"buyerGstin": "27ACBPN2353E1ZX",
"irdDocType":"POST",
"registeredOn": 1674449635000,
"ewbNo": 231009845697,
"ewbDate": 1674449640000,
"ewbValidTill": 1674584940000,
"amount": 100,
"acceptanceComments": null,
"denialComments": null,
"disputeComments": null,
"cancellationComments": null,
"cancellationReason": null,
"status": "200",
"createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
"createdOn": 1674449575274,
"lastUpdatedByUserId": null,
"lastUpdated": null,
"annotations": [],
"irnResponse": {
"ackDt": "09/12/2022",
"ewbDt": "09/12/2022",
"signedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEQzU3REUxMzU4QjMwMEJBOUY3OTM0MEE2Njk2ODMxRjNDODUwNDciLCJ0eXAiOiJKV1QiLCJ4NXQiOiI3Y1Y5NFRXTE1BdXA5NU5BcG1sb01mUElVRWMifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMjIyMTAwNzMzMDQ5NTksXCJBY2tEdFwiOlwiMjAyMi0xMi0wOSAxNDozNToxMlwiLFwiSXJuXCI6XCJlODJkN2VkYjg5MjY0YjVmZGQxOGFmZDJhZGMzYzYzNzZhMmIzZTg3MmZmMWFkZWRlYjQ4YWRjMDQwMDMzMzdjXCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiREVYUFwiLFwiUmVnUmV2XCI6XCJOXCIsXCJJZ3N0T25JbnRyYVwiOlwiTlwifSxcIkRvY0R0bHNcIjp7XCJUeXBcIjpcIklOVlwiLFwiTm9cIjpcIlVENjEyMjQyRDcyQjM0RjZcIixcIkR0XCI6XCIwOS8xMi8yMDIyXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyN0FBQVBJMzE4Mk0wMDJcIixcIkxnbE5tXCI6XCJBY21lIFdpZGdldHMgUHJpdmF0ZSBMaW1pdGVkXCIsXCJBZGRyMVwiOlwiMjM0NVwiLFwiTG9jXCI6XCJVdHRhciBQcmFkZXNoXCIsXCJQaW5cIjo0MDAwNDksXCJTdGNkXCI6XCIyN1wifSxcIkJ1eWVyRHRsc1wiOntcIkdzdGluXCI6XCIyN0FDQlBOMjM1M0UxWlhcIixcIkxnbE5tXCI6XCJMb25nIFRlcm0gRW50ZXJwcmlzZXMgTExQXCIsXCJQb3NcIjpcIjI3XCIsXCJBZGRyMVwiOlwiMTIzNFwiLFwiTG9jXCI6XCJQdW5lXCIsXCJQaW5cIjo0MDAwNDksXCJTdGNkXCI6XCIyN1wifSxcIkRpc3BEdGxzXCI6e1wiTm1cIjpcIkFjbWUgV2lkZ2V0cyBQcml2YXRlIExpbWl0ZWRcIixcIkFkZHIxXCI6XCIxMTJcIixcIkFkZHIyXCI6XCJBY21lIEJ1aWxkaW5nXCIsXCJMb2NcIjpcIkFCQ1wiLFwiUGluXCI6NDAwMDQ5LFwiU3RjZFwiOlwiMjdcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIyN0FDQlBOMjM1M0UxWlhcIixcIkxnbE5tXCI6XCJBY21lIFdpZGdldHMgUHJpdmF0ZSBMaW1pdGVkXCIsXCJUcmRObVwiOlwiQWNtZSBXaWRnZXRzIFByaXZhdGUgTGltaXRlZFwiLFwiQWRkcjFcIjpcIjExMlwiLFwiQWRkcjJcIjpcIkFjbWUgQnVpbGRpbmdcIixcIkxvY1wiOlwiQUJDXCIsXCJQaW5cIjo0MDAwNDksXCJTdGNkXCI6XCIyN1wifSxcIkl0ZW1MaXN0XCI6W3tcIkl0ZW1Ob1wiOjAsXCJTbE5vXCI6XCIxXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJQcmREZXNjXCI6XCJBY21lIHByb2R1Y3RcIixcIkhzbkNkXCI6XCIzMzA1MjAwMFwiLFwiUXR5XCI6MSxcIlVuaXRcIjpcIkJBR1wiLFwiVW5pdFByaWNlXCI6MTAwLFwiVG90QW10XCI6MTAwLFwiRGlzY291bnRcIjowLFwiQXNzQW10XCI6MTAwLFwiR3N0UnRcIjowLFwiQ2dzdEFtdFwiOjAsXCJTZ3N0QW10XCI6MCxcIlRvdEl0ZW1WYWxcIjoxMDB9XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoxMDAsXCJDZ3N0VmFsXCI6MCxcIlNnc3RWYWxcIjowLFwiSWdzdFZhbFwiOjAsXCJUb3RJbnZWYWxcIjoxMDB9LFwiUGF5RHRsc1wiOntcIk5tXCI6XCJBY21lIFdpZGdldHMgUHJpdmF0ZSBMaW1pdGVkXCIsXCJNb2RlXCI6XCJDYXNoXCIsXCJQYXlUZXJtXCI6XCIxMDBcIixcIlBheUluc3RyXCI6XCIxMDBcIixcIkNyVHJuXCI6XCIxMDBcIixcIkRpckRyXCI6XCIxMDBcIixcIkNyRGF5XCI6MTAwLFwiUGFpZEFtdFwiOjEwMCxcIlBheW10RHVlXCI6OTAwfSxcIlJlZkR0bHNcIjp7XCJJbnZSbVwiOlwiUmVtYXJrc1wiLFwiRG9jUGVyZER0bHNcIjp7XCJJbnZTdER0XCI6XCIwMS8xMS8yMDIyXCIsXCJJbnZFbmREdFwiOlwiMDEvMTEvMjAyMlwifX0sXCJFeHBEdGxzXCI6e1wiU2hpcEJOb1wiOlwic2hwYmlsbDEyM1wiLFwiU2hpcEJEdFwiOlwiMDEvMTEvMjAyMlwiLFwiUG9ydFwiOlwiSU5ZTkw2XCIsXCJSZWZDbG1cIjpcIk5cIixcIkZvckN1clwiOlwiSU5SXCIsXCJDbnRDb2RlXCI6XCJJTlwiLFwiRXhwRHV0eVwiOjB9LFwiRXdiRHRsc1wiOntcIlRyYW5zSWRcIjpcIjI3QUFBUEkzMTgyTTAwMlwiLFwiVHJhbnNOYW1lXCI6XCJEcml2ZXJcIixcIlRyYW5zTW9kZVwiOlwiMVwiLFwiRGlzdGFuY2VcIjo1LFwiVHJhbnNEb2NOb1wiOlwiMjAvMjJcIixcIlZlaE5vXCI6XCJLQTUxRVMxMTIyXCIsXCJWZWhUeXBlXCI6XCJPXCJ9fSIsImlzcyI6Ik5JQyJ9.tirLbmWwCQZlihQmlz57yblyCIRPg-lguQwFN5VcWWC1wdgKzopGDXZq4WKamRsnblel8K31k7tHU66UTIot71eQvwDds5Zv5QecopUdkaLNXxhFWmeOiSfYWkPDlZJPSutpl4wI2ue4o9d8a8-PTNxCslGditrg8PQ8aX3i9pfCIBKsINiRsPp1KVfCg1_3XnWA-iLz-M3iaK9A61pS0-ILQucv8t_XqZqhNqn0S9BAwTOdfXabw8x8vQgoVPVF65UmRxH-yXcrfoegNQQ-KZnQwKJHjpXo3XA2R6cjmKOSMUcmORL5olsA_Di5NiEZ3WQBCxbibSnRrI-qUglq0A",
"ackNo": 122210073304959,
"signedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEQzU3REUxMzU4QjMwMEJBOUY3OTM0MEE2Njk2ODMxRjNDODUwNDciLCJ0eXAiOiJKV1QiLCJ4NXQiOiI3Y1Y5NFRXTE1BdXA5NU5BcG1sb01mUElVRWMifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI3QUFBUEkzMTgyTTAwMlwiLFwiQnV5ZXJHc3RpblwiOlwiMjdBQ0JQTjIzNTNFMVpYXCIsXCJEb2NOb1wiOlwiVUQ2MTIyNDJENzJCMzRGNlwiLFwiRG9jVHlwXCI6XCJJTlZcIixcIkRvY0R0XCI6XCIwOS8xMi8yMDIyXCIsXCJUb3RJbnZWYWxcIjoxMDAsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCIzMzA1MjAwMFwiLFwiSXJuXCI6XCJlODJkN2VkYjg5MjY0YjVmZGQxOGFmZDJhZGMzYzYzNzZhMmIzZTg3MmZmMWFkZWRlYjQ4YWRjMDQwMDMzMzdjXCIsXCJJcm5EdFwiOlwiMjAyMi0xMi0wOSAxNDozNToxMlwifSIsImlzcyI6Ik5JQyJ9.HqbLxzB4OsPSyJk0iwydm5vlSrny1drkLEPxBS2j1fRGWilPicT9LNPKXEO2Bpl0NHeFtAqLgPJ8lge1WbclM7sSAQQ-Caj8K1JPPg4I1m3GB9G5MMUk7IfEpM680doI_dz-k72qHAAX2oMbwGxh3e1j_pnxDHjeULIzKGTqBf8gHKapyc00GvHyT3wYteF6VSc5K5BwFS6dz2LnX0yBGcIgGqwy1TJKae8wQzAGAoPmsNL8dk6IlXLlR3sXQo__dBrPnetEnMPE7brzF7ox2BL3xe3XyVI01bNR03VFidH9-O0DTX_WxcyMotm-KuLn5OBK-4NXSnbMqSwJes7TaA",
"remarks": null,
"status": "ACT",
"irn": "e82d7edb89264b5fdd18afd2adc3c6376a2b3e872ff1adedeb48adc04003337c",
"ewbNo": 221009839051,
"ewbValidTill": "10/12/2022"
}
},
"itemErrors": null,
"itemInfoDetails": null,
"itemKey": null
}
],
"errorDetails": null,
"infoDetails": null
}
Sample Response Body
[
{
"status": "1",
"data": {
"id": "d8fabae2-e809-4d2e-90f5-5c551832a437",
"irn": null,
"docNumber": "M14FE6164463F8ZA",
"docType": "100",
"docDate": "01/02/2022",
"sellerGstin": "27AAAPI3182M002",
"buyerGstin": "27ACBPN2353E1ZX",
"registeredOn": null,
"ewbNo": null,
"ewbDate" : null,
"ewbValidTill" : null,
"amount": 100,
"acceptanceComments": null,
"denialComments": null,
"disputeComments": null,
"cancellationComments": null,
"cancellationReason": null,
"status": "120",
"createdByUserId": "76c747b5-79d4-4417-891b-f385a690250b",
"createdOn": 1652961333694,
"lastUpdatedByUserId": null,
"lastUpdated": null,
"annotations": [],
"irnResponse" : null
},
"errorDetails": null,
"infoDetails": null
}]
Document
{
"status": "1",
"data": [
{
"itemStatus": "1",
"itemData": {
"id": "b31ee399-4906-4c48-b6e0-e4a11e6d3d32",
"docNumber": "R88AF6B42BC2C4EC",
"docType": "100",
"docDate": "23/01/2023",
"sellerGstin": "27AAAPI3182M002",
"buyerGstin": "27ACBPN2353E1ZX",
"irdDocType": "PRE",
"amount": 100,
"acceptanceComments": null,
"denialComments": null,
"disputeComments": null,
"status": "100",
"createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
"createdOn": 1674449605080,
"lastUpdatedByUserId": null,
"lastUpdated": null,
"annotations": []
},
"itemErrors": null,
"itemInfo": null,
"itemKey": "27AAAPI3182M002"
}
],
"error": null,
"info": null
}
Note#
status field in document is the state of the Document generated. Different Document states are as bellow -
100->DRAFT120->REGISTRATIONFAILED200->CREATED210->ACCEPTED220->DENIED230->DISPUTED240->CANCELLED250->FROZEN260->DELETE
Last update: January 25, 2023