Get e-Invoice Details#

Given an invoice reference number (IRN), you can get e-invoice details using this API.

Route

/basic/einv/{flynn-version}/{irp}/eicore/{e-invoice-api-version}/Invoice/irn/{irn_no}

active ‘flynn-version’: v1.0
method: GET

URL Parameters#

Name	Description	Type
flynn-version	version of the API for example, v1.0	string
irp	IRP Provider as per GST registration for e-invoicing	enum (ni1, ni2)
e-invoice-api-version	E-invoice API version	string
irn_no	E-invoice number	string

Headers#

All headers as mentioned in the Basic E-Invoice API introduction.

Apart from the common headers need to pass below headers

header	Description
irp	This request header is mandatory if Taxpayer wants to perform interoperability / criss-cross operations on IRN. Accepted values are NIC1 or NIC2

Tip

The only valid value for the header key accept is application/json.

Also, since no request body is sent, header key Content-type is optional.

Response#

`200`:#

Successful response will be the same payload as per the ‘E-Invoice API Documentation’ published by NIC.

Sample Response Body

{
  "data": "{\"AckNo\":\"62100691702\",\"AckDt\":\"2020-06-22 19:28:00\",\"Irn\":\"00b3b4da65c879887b0166684dfcdbb0661bcabc0411f84c66e26c251eecfea5\",\"SignedInvoice\":\"eyJhbGciOiJSUzI1NiIsImtpZCI6IjExNUY0NDI2NjE3QTc5MzhCRTFCQTA2REJFRTkxQTQyNzU4NEVEQUIiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJFVjlFSm1GNmVUaS1HNkJ0dnVrYVFuV0U3YXMifQ.eyJkYXRhIjoie1wiQWNrTm9cIjo2MjEwMDY5MTcwMixcIkFja0R0XCI6XCIyMDIwLTA2LTIyIDE5OjI4OjAwXCIsXCJJcm5cIjpcIjAwYjNiNGRhNjVjODc5ODg3YjAxNjY2ODRkZmNkYmIwNjYxYmNhYmMwNDExZjg0YzY2ZTI2YzI1MWVlY2ZlYTVcIixcIlZlcnNpb25cIjpcIjEuMDFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiREVYUFwiLFwiUmVnUmV2XCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiVjFENTI5RTgxQTE4NzQ1MVwiLFwiRHRcIjpcIjIyLzA2LzIwMjBcIn0sXCJTZWxsZXJEdGxzXCI6e1wiR3N0aW5cIjpcIjI0QUFBUEkzMTgyTTAwMlwiLFwiTGdsTm1cIjpcIkFjbWUgV2lkZ2V0cyBQcml2YXRlIExpbWl0ZWRcIixcIkFkZHIxXCI6XCIyMzQ1XCIsXCJMb2NcIjpcIkJ1aWxkaW5nXCIsXCJQaW5cIjpcIjM4MDAwNlwiLFwiU3RhdGVcIjpcIkd1amFyYXRcIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjdBQUFQSTMxODJNMDAyXCIsXCJMZ2xObVwiOlwiTG9uZyBUZXJtIEVudGVycHJpc2VzIExMUFwiLFwiUG9zXCI6XCIyN1wiLFwiQWRkcjFcIjpcIjEyMzRcIixcIkxvY1wiOlwiUHVuZVwiLFwiUGluXCI6XCI0MDAwNDlcIixcIlN0YXRlXCI6XCJNYWhhcmFzdHJhXCJ9LFwiRGlzcER0bHNcIjp7XCJObVwiOlwiQWNtZSBXaWRnZXRzIFByaXZhdGUgTGltaXRlZFwiLFwiQWRkcjFcIjpcIjExMlwiLFwiQWRkcjJcIjpcIkFjbWUgQnVpbGRpbmdcIixcIkxvY1wiOlwiQUJDXCIsXCJQaW5cIjpcIjQwMDA0OVwiLFwiU3RjZFwiOlwiMjdcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIyNEFBQVBJMzE4Mk0wMDJcIixcIkxnbE5tXCI6XCJBY21lIFdpZGdldHMgUHJpdmF0ZSBMaW1pdGVkXCIsXCJUcmRObVwiOlwiQWNtZSBXaWRnZXRzIFByaXZhdGUgTGltaXRlZFwiLFwiQWRkcjFcIjpcIjExMlwiLFwiQWRkcjJcIjpcIkFjbWUgQnVpbGRpbmdcIixcIkxvY1wiOlwiQUJDXCIsXCJQaW5cIjpcIjQwMDA0OVwiLFwiU3RjZFwiOlwiMjdcIn0sXCJJdGVtTGlzdFwiOlt7XCJJdGVtTm9cIjoxLFwiU2xOb1wiOlwiMVwiLFwiSXNTZXJ2Y1wiOlwiTlwiLFwiUHJkRGVzY1wiOlwiQWNtZSBwcm9kdWN0XCIsXCJIc25DZFwiOlwiMTAwMVwiLFwiUXR5XCI6XCIxXCIsXCJVbml0XCI6XCJCQUdcIixcIlVuaXRQcmljZVwiOjEwMCxcIlRvdEFtdFwiOjEwMCxcIkRpc2NvdW50XCI6MCxcIkFzc0FtdFwiOjEwMCxcIkdzdFJ0XCI6MCxcIklnc3RBbXRcIjowLFwiQ2dzdEFtdFwiOjAsXCJTZ3N0QW10XCI6MCxcIlRvdEl0ZW1WYWxcIjoxMDB9XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoxMDAsXCJJZ3N0VmFsXCI6MCxcIlRvdEludlZhbFwiOjEwMH0sXCJQYXlEdGxzXCI6e1wiTm1cIjpcIkFjbWUgV2lkZ2V0cyBQcml2YXRlIExpbWl0ZWRcIixcIk1vZGVcIjpcIkNBU0hcIixcIlBheVRlcm1cIjpcIjEwMFwiLFwiUGF5SW5zdHJcIjpcIjEwMFwiLFwiQ3JUcm5cIjpcIjEwMFwiLFwiRGlyRHJcIjpcIjEwMFwiLFwiQ3JEYXlcIjoxMDAsXCJQYWlkQW10XCI6MTAwLFwiUGF5bXREdWVcIjo5MDB9LFwiUmVmRHRsc1wiOntcIkludlN0RHRcIjpcIjIyLzA2LzIwMjBcIixcIkludkVuZER0XCI6XCIyMi8wNi8yMDIwXCJ9LFwiRXhwRHRsc1wiOntcIlNoaXBCTm9cIjpcInNocGJpbGwxMjNcIixcIlNoaXBCRHRcIjpcIjIyLzA2LzIwMjBcIixcIlBvcnRcIjpcIklOVjEyM1wiLFwiUmVmQ2xtXCI6XCJOXCIsXCJGb3JDdXJcIjpcIklOUlwiLFwiQ250Q29kZVwiOlwiSU5cIn19IiwiaXNzIjoiTklDIn0.VFa3b6PspfZhewai4cYuTDmstfn1Sjp9RbyisAamaeksqe3JYFSwDjALWGyuMqfh7LQ6Q9-cUan7swtpagr9G3LbbysVnvDmwszYulxjObLBp0t56k67aPfVt2CbhKekebyMDG7BAXwyJGdiaZyGyAKFLlGbHoetQR6eylIVDs2qhXHO6TeBweUefYdUsni3400r12vfG7xT-o_A50S5pdxwY1x-XkIv0Uz7ST52bh7imk71eXgqKsfi9HYSSlLkGXzKnLMkWSuRjhc9WzA-iH6g02XabGyJ-knO0Fj5--7uxPglRLvXFaRXFzgSjc-009fwRe5MICEhht58SNMcPw\",\"SignedQRCode\":\"eyJhbGciOiJSUzI1NiIsImtpZCI6IjExNUY0NDI2NjE3QTc5MzhCRTFCQTA2REJFRTkxQTQyNzU4NEVEQUIiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJFVjlFSm1GNmVUaS1HNkJ0dnVrYVFuV0U3YXMifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI0QUFBUEkzMTgyTTAwMlwiLFwiQnV5ZXJHc3RpblwiOlwiMjdBQUFQSTMxODJNMDAyXCIsXCJEb2NOb1wiOlwiVjFENTI5RTgxQTE4NzQ1MVwiLFwiRG9jVHlwXCI6XCJJTlZcIixcIkRvY0R0XCI6XCIyMi8wNi8yMDIwXCIsXCJUb3RJbnZWYWxcIjoxMDAsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCIxMDAxXCIsXCJJcm5cIjpcIjAwYjNiNGRhNjVjODc5ODg3YjAxNjY2ODRkZmNkYmIwNjYxYmNhYmMwNDExZjg0YzY2ZTI2YzI1MWVlY2ZlYTVcIn0iLCJpc3MiOiJOSUMifQ.abdJ4n3bH7g4ZIK1wvZ5L60JVqzA010XyOColQ1njn6BCiDX4MaC-ijoJmTfIjEN7Ifo_rPilpToElZRxkwXOnHfFCp1VZlvd0ctk5ybhV2YyGzEoBHFnXVm3XdcF8ZeqJ09JObWQgWkBxgGVPTudt039ejOgVvgtZDa-XvmBqvGmIiTHxDfHBOjs6b87SMOAaKQqXH5RXWBDuFjlfBCEeebPXvNKXQ6lgNkD9K8TUrSGdOWVwLslxB3cnVXjD0ej9X3LLH7Q3zIezYfA1mr_vf33Yqup3dOchSiRdWKXUQfWS6yBvGns9wr64lfa5BqFt6rsTprxXuKyDf3MS3f2Q\",\"Status\":\"ACT\",\"EwbNo\":null,\"EwbDt\":null,\"EwbValidTill\":null}"
}

`404`:#

When the E-invoice isn’t found.

Sample Response Body

{
  "error": {
    "message": "err-resource-not-found",
    "type": "ResourceNotFound",
    "args": {
      "irn-number": "00b3b4da65c879887b0166684dfcdbb0661bcabc0411f84c66e26c251eecfea5"
    }
  }
}

Other e-invoice errors are mentioned under common errors.

Notes#

IRP - nic is deprecated. Instead of it please use ni1 or ni2