Generate IRN

You can generate an IRN by sending a PUT request to E-Invoicing API with the following request headers.

Taxpayers with AATO greater than or equal to 100 crores have to report the invoices to the IRP portal within 30 days of it's issuance from 1st November 2023.

Request URL

PUT: {{HOST}}/einv/v2/eInvoice/generate

Request Headers

ParameterData TypeField ValidationsDescription

X-Cleartax-Auth-Token

String

NA

Mandatory. The auth token generated from ClearTax user id and password.

Content-Type

String

NA

Mandatory. This will always be "application/json" for JSON and "application/xml" for XML

Accept

String

NA

Optional. This will be "application/xml" if you want the response in XML.

gstin

String

NA

Mandatory. GSTIN number for the user

Request Path Params

There are no path parameters for this API.

Request Query Params

ParameterData TypeField ValidationsDescription

dryRun

Boolean

NA

Optional. If the flag is set to true, only ClearTax validations will run, however the EInvoice won’t be generated. Default - false

Request Body

This API accepts an array of E-Invoice Custom Objects as the request body. Maximum up to 10 Invoices can be sent in one request.

E-Invoice Custom Object

ParameterParameter TypeValidations

transaction

Object

Mandatory. E-Invoice Object.

custom_fields

Object

Max: 10

Optional. Key value pair of custom fields. You can send a maximum of 10 custom fields only.

Sample Request

[
  {
    "transaction": {
      "Version": "1.1",
      "TranDtls": {
        "TaxSch": "GST",
        "SupTyp": "B2B",
        "RegRev": "N",
        "EcmGstin": null,
        "IgstOnIntra": "N"
      },
      "DocDtls": {
        "Typ": "INV",
        "No": "IRNTEST/002",
        "Dt": "10/04/2023"
      },
      "SellerDtls": {
        "Gstin": "29AAFCD5862R000",
        "LglNm": "NIC Company Pvt Ltd",
        "TrdNm": "NIC Industries",
        "Addr1": "5th block, kuvempu layout",
        "Addr2": "kuvempu layout",
        "Loc": "GANDHINAGAR",
        "Pin": 560037,
        "Stcd": "29",
        "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": "10019920",
          "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"
      },
      "EwbDtls": {
        "TransId": "12AWGPV7107B1Z1",
        "TransName": "XYZ EXPORTS",
        "Distance": 100,
        "TransDocNo": "Doc01",
        "TransDocDt": "10/04/2023",
        "VehNo": "ka123456",
        "VehType": "R",
        "TransMode": "1"
      }
    },
    "custom_fields": {
      "customfieldLable1": "CustomFieldValue1",
      "customfieldLable2": "CustomFieldValue2",
      "customfieldLable3": "CustomFieldValue3"
    }
  }
]

Sample Response

Success - (Dryrun = False)

[
    {
        "custom_fields": null,
        "deleted": false,
        "document_status": "IRN_GENERATED",
        "error_response": null,
        "errors": null,
        "govt_response": {
            "Success": "Y",
            "AckNo": 112310153714784,
            "AckDt": "2023-04-11 13:38:00",
            "Irn": "94b6c41efd740424c469908d0927db66d8f24d9dad78b02dab04ad1659813dc9",
            "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMTIzMTAxNTM3MTQ3ODQsXCJBY2tEdFwiOlwiMjAyMy0wNC0xMSAxMzozODowMFwiLFwiSXJuXCI6XCI5NGI2YzQxZWZkNzQwNDI0YzQ2OTkwOGQwOTI3ZGI2NmQ4ZjI0ZDlkYWQ3OGIwMmRhYjA0YWQxNjU5ODEzZGM5XCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIk5cIn0sXCJEb2NEdGxzXCI6e1wiVHlwXCI6XCJJTlZcIixcIk5vXCI6XCJJUk5URVNULzAwMlwiLFwiRHRcIjpcIjEwLzA0LzIwMjNcIn0sXCJTZWxsZXJEdGxzXCI6e1wiR3N0aW5cIjpcIjI5QUFGQ0Q1ODYyUjAwMFwiLFwiTGdsTm1cIjpcIk5JQyBjb21wYW55IHB2dCBsdGRcIixcIlRyZE5tXCI6XCJOSUMgSW5kdXN0cmllc1wiLFwiQWRkcjFcIjpcIjV0aCBibG9jaywga3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIyXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJCRU5HQUxVUlVcIixcIlBpblwiOjU2MDEwMyxcIlN0Y2RcIjpcIjI5XCJ9LFwiQnV5ZXJEdGxzXCI6e1wiR3N0aW5cIjpcIjI5QVdHUFY3MTA3QjFaMVwiLFwiTGdsTm1cIjpcIlhZWiBjb21wYW55IHB2dCBsdGRcIixcIlRyZE5tXCI6XCJYWVogSW5kdXN0cmllc1wiLFwiUG9zXCI6XCIyOVwiLFwiQWRkcjFcIjpcIjd0aCBibG9jaywga3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIyXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJCRU5HQUxVUlVcIixcIlBpblwiOjU2MDEwNSxcIlN0Y2RcIjpcIjI5XCJ9LFwiRGlzcER0bHNcIjp7XCJObVwiOlwiQUJDIGNvbXBhbnkgcHZ0IGx0ZFwiLFwiQWRkcjFcIjpcIjd0aCBibG9jaywga3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIyXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJCYW5hZ2Fsb3JlXCIsXCJQaW5cIjo1NjIxNjAsXCJTdGNkXCI6XCIyOVwifSxcIlNoaXBEdGxzXCI6e1wiR3N0aW5cIjpcIjI5QVdHUFY3MTA3QjFaMVwiLFwiTGdsTm1cIjpcIkNCRSBjb21wYW55IHB2dCBsdGRcIixcIlRyZE5tXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiQWRkcjFcIjpcIjd0aCBibG9jaywga3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIyXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJCYW5hZ2Fsb3JlXCIsXCJQaW5cIjo1NjIxNjAsXCJTdGNkXCI6XCIyOVwifSxcIkl0ZW1MaXN0XCI6W3tcIkl0ZW1Ob1wiOjAsXCJTbE5vXCI6XCIxXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJQcmREZXNjXCI6XCJTRVJWSUNFIENIQVJHRVMoU01BUlQgU1VJVEVTKSBcIixcIkhzbkNkXCI6XCIxMDAxOTkyMFwiLFwiUXR5XCI6MS4wLFwiRnJlZVF0eVwiOjEuMCxcIlVuaXRcIjpcIk9USFwiLFwiVW5pdFByaWNlXCI6MTAwLjAsXCJUb3RBbXRcIjoxMDAuMDAsXCJEaXNjb3VudFwiOjAuMDAsXCJBc3NBbXRcIjoxMDAuMDAsXCJHc3RSdFwiOjE4LjAwMCxcIklnc3RBbXRcIjowLjAwLFwiQ2dzdEFtdFwiOjkuMDAsXCJTZ3N0QW10XCI6OS4wMCxcIkNlc1J0XCI6MC4wMDAsXCJDZXNBbXRcIjowLjAwLFwiQ2VzTm9uQWR2bEFtdFwiOjAuMDAsXCJTdGF0ZUNlc1J0XCI6MC4wMDAsXCJTdGF0ZUNlc0FtdFwiOjAuMDAsXCJTdGF0ZUNlc05vbkFkdmxBbXRcIjowLjAwLFwiT3RoQ2hyZ1wiOjAuMDAsXCJUb3RJdGVtVmFsXCI6MTE4LjAwfV0sXCJWYWxEdGxzXCI6e1wiQXNzVmFsXCI6MTAwLjAwLFwiQ2dzdFZhbFwiOjkuMDAsXCJTZ3N0VmFsXCI6OS4wMCxcIklnc3RWYWxcIjowLjAwLFwiQ2VzVmFsXCI6MC4wMCxcIlN0Q2VzVmFsXCI6MC4wMCxcIkRpc2NvdW50XCI6MC4wMCxcIk90aENocmdcIjowLjAwLFwiUm5kT2ZmQW10XCI6MC4wMCxcIlRvdEludlZhbFwiOjExOC4wMCxcIlRvdEludlZhbEZjXCI6MTE4LjAwfSxcIkV3YkR0bHNcIjp7XCJUcmFuc0lkXCI6XCIxMkFXR1BWNzEwN0IxWjFcIixcIlRyYW5zTmFtZVwiOlwiWFlaIEVYUE9SVFNcIixcIlRyYW5zTW9kZVwiOlwiMVwiLFwiRGlzdGFuY2VcIjoxMDAsXCJUcmFuc0RvY05vXCI6XCJEb2MwMVwiLFwiVHJhbnNEb2NEdFwiOlwiMTAvMDQvMjAyM1wiLFwiVmVoTm9cIjpcImthMTIzNDU2XCIsXCJWZWhUeXBlXCI6XCJSXCJ9fSIsImlzcyI6Ik5JQyBTYW5kYm94In0.gRfSVrHTCy-esoiCEnxGqRBFmVZxySyglU1vTQoef1Ip1HqV8ypeeZEfJuyCwkNADQ-Fh_q4aCrWVvF3WbH0Rqbab5bt-EZ_-TegdWgIPC_AgPWzmo8xq689si6BUf0w_u0O7NhTLROUOoj3soUEvEozAy5nYqCwVTIzYcBhCRCtGXW3241EfnCGTkzip6MhUw8sJXFApIeLO9jZPbaImYSsy1L7jeyOZAFtftjSefkpkEsO-xYL53bHe9yFu6w-QP0GAagxGyII373Q3P6LXdkaHAJwyXl_m-ydt4Vg0o1s65UK0PSGe02VfAkax64MdG7-SYgaFENEnZrzV9jACg",
            "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFGQ0Q1ODYyUjAwMFwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJEb2NOb1wiOlwiSVJOVEVTVC8wMDJcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTAvMDQvMjAyM1wiLFwiVG90SW52VmFsXCI6MTE4LjAwLFwiSXRlbUNudFwiOjEsXCJNYWluSHNuQ29kZVwiOlwiMTAwMTk5MjBcIixcIklyblwiOlwiOTRiNmM0MWVmZDc0MDQyNGM0Njk5MDhkMDkyN2RiNjZkOGYyNGQ5ZGFkNzhiMDJkYWIwNGFkMTY1OTgxM2RjOVwiLFwiSXJuRHRcIjpcIjIwMjMtMDQtMTEgMTM6Mzg6MDBcIn0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.qry9RhVPOvD_ZpOdrbjXYTObUhMsEexWCdNqxTGwx7E1ewiEOSJIez7IX0znwyyP7zXExAkUQIfI5MLU7ClfjM7zCrt7cTIwoRygivGuiL3MCkbuAPzCEIqAMe5nLVaUhA4ASA0UbZhjFI2EyxklRRuIy7xSfWRQVNC_Hzu4S3bIiV-X9quM0QoD0xLd89f7rzM4-lIogIaxRjcx9aClpTg3nfWh20nmXqpTi2HAQ_LhEngXkaEj6RvvKM7LPdHYw4AMjtSjusqNWrvzH4w6-0liQKRETgmDGPeho9MLC6nOyBMoNXCuj5c3YYQcqq_AxtO-1DvPiwwO9XygZySLVw",
            "Status": "ACT",
            "EwbNo": 171010133427,
            "EwbDt": "2023-04-11 13:38:00",
            "EwbValidTill": "2023-04-12 23:59:00"
        },
        "group_id": null,
        "gstin": "29AAFCD5862R000",
        "is_deleted": false,
        "owner_id": null,
        "tag_identifier": null,
        "transaction": {
            "Version": "1.1",
            "TranDtls": {
                "TaxSch": "GST",
                "RegRev": "N",
                "SupTyp": "B2B"
            },
            "DocDtls": {
                "Typ": "INV",
                "No": "IRNTEST/002",
                "Dt": "10/04/2023"
            },
            "SellerDtls": {
                "Gstin": "29AAFCD5862R000",
                "LglNm": "NIC company pvt ltd",
                "TrdNm": "NIC Industries",
                "Addr1": "5th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "BENGALURU",
                "Pin": 560103,
                "Stcd": "29"
            },
            "BuyerDtls": {
                "Gstin": "29AWGPV7107B1Z1",
                "LglNm": "XYZ company pvt ltd",
                "TrdNm": "XYZ Industries",
                "Pos": "29",
                "Addr1": "7th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "BENGALURU",
                "Pin": 560105,
                "Stcd": "29"
            },
            "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": "SERVICE CHARGES(SMART SUITES) ",
                    "IsServc": "N",
                    "HsnCd": "10019920",
                    "Qty": 1.000,
                    "FreeQty": 1.000,
                    "Unit": "OTH",
                    "UnitPrice": 100.000,
                    "TotAmt": 100.00,
                    "Discount": 0.00,
                    "AssAmt": 100.00,
                    "GstRt": 18.00,
                    "IgstAmt": 0.00,
                    "CgstAmt": 9.00,
                    "SgstAmt": 9.00,
                    "CesRt": 0.00,
                    "CesAmt": 0.00,
                    "CesNonAdvlAmt": 0.00,
                    "StateCesRt": 0.00,
                    "StateCesAmt": 0.00,
                    "StateCesNonAdvlAmt": 0.00,
                    "OthChrg": 0.00,
                    "TotItemVal": 118.00
                }
            ],
            "ValDtls": {
                "AssVal": 100.00,
                "CgstVal": 9.00,
                "SgstVal": 9.00,
                "IgstVal": 0.00,
                "CesVal": 0.00,
                "StCesVal": 0.00,
                "Discount": 0.00,
                "OthChrg": 0.00,
                "RndOffAmt": 0.00,
                "TotInvVal": 118.00,
                "TotInvValFc": 118.00
            },
            "EwbDtls": {
                "TransId": "12AWGPV7107B1Z1",
                "TransName": "XYZ EXPORTS",
                "TransMode": "1",
                "Distance": 100,
                "TransDocNo": "Doc01",
                "TransDocDt": "10/04/2023",
                "VehNo": "ka123456",
                "VehType": "R"
            }
        },
        "transaction_id": "29AAFCD5862R000_IRNTEST/002_INV_2023",
        "transaction_metadata": null
    }
]

Success - (Dryrun = True)

The parameter "Success" : "Y" denotes that the document has been successfully validated by ClearTax.

[
    {
        "custom_fields": null,
        "deleted": false,
        "document_status": "DOCUMENT_VALIDATION",
        "error_response": null,
        "errors": null,
        "govt_response": {
            "Success": "Y"
        },
        "group_id": null,
        "gstin": "24AAFCD5862R005",
        "is_deleted": false,
        "owner_id": null,
        "tag_identifier": null,
        "transaction": {
            "Version": "1.1",
            "TranDtls": {
                "TaxSch": "GST",
                "SupTyp": "B2B",
                "IgstOnIntra": "N"
            },
            "DocDtls": {
                "Typ": "INV",
                "No": "sumit1234",
                "Dt": "18/01/2024"
            },
            "SellerDtls": {
                "Gstin": "29AAFCD5862R000",
                "LglNm": "NIC company pvt ltd",
                "TrdNm": "NIC Industries",
                "Addr1": "5th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "BENGALURU",
                "Pin": 560103,
                "Stcd": "29"
            },
             "BuyerDtls": {
                "Gstin": "29AWGPV7107B1Z1",
                "LglNm": "XYZ company pvt ltd",
                "TrdNm": "XYZ Industries",
                "Pos": "29",
                "Addr1": "7th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "BENGALURU",
                "Pin": 560105,
                "Stcd": "29"
            },
              "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": "SERVICE CHARGES(SMART SUITES) ",
                    "IsServc": "N",
                    "HsnCd": "10019920",
                    "Qty": 1.000,
                    "FreeQty": 1.000,
                    "Unit": "OTH",
                    "UnitPrice": 100.000,
                    "TotAmt": 100.00,
                    "Discount"