Get Invoice by IRN

You can get an Invoice by IRN by sending a GET request to E-Invoicing API with the following request headers.

Request URL

GET: {{HOST}}/einv/v1/govt/api/Invoice/irn/{{IRN}}

Request Headers

Parameter	Type	Description
x-cleartax-auth-token	String	Mandatory. The access token generated for the workspace.
x-cleartax-product	String	Should always be "EInvoice" without the double quotes.
gstin	String	Users GSTIN

Request Parameters:

Parameters	Parameter Type	Type	Description
IRN	Path	String	Mandatory. IRN generated for the invoice.

Sample Request:

https://api.clear.in/einv/v1/govt/api/Invoice/irn/2d5b90edf2819c91f660a6d6843346fab0d57a27badf92ac8f7fbc8762f50ab1

Response Parameters

• For Successful request

Parameter	Type	Description
Success	String	"Y" if the request is successful, "N" otherwise
AckNo	Long	Acknowledgement Number
AckDt	String	Format YYYY-MM-DD HH:MM:SS, Acknowledgement date
Irn	String	Invoice Reference Number
SignedInvoice	String	Signed Invoice Data
SignedQRCode	String	QR Code for Invoice
Status	String	"ACT" for an active invoice, "CNL" for a cancelled invoice
EwbNo	Number	E-waybill number
EwbDt	String	E-Waybill date
EwbValidTill	String	E-waybill valid till
Remarks	String	Remarks if any

• For Failed requests

Parameter	Type	Description
Success	String	"N" if the request failed.
ErrorDetails	Array	Details of all errors

Error Detail

Parameter	Type	Description
error_code	String	Error Code
error_message	String	Error Message
error_source	String	Error Source can either be GOVT or CLEARTAX

Sample Response

Valid Response

{
  "Success": "Y",
  "AckNo": 162010000001700,
  "AckDt": "2020-08-08 11:23:00",
  "Irn": "58f1669d31c5725ddcc39eeecd465e69543c639daeb1d582546aa3d28d66c3f8",
  "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjExNUY0NDI2NjE3QTc5MzhCRTFCQTA2REJFRTkxQTQyNzU4NEVEQUIiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJFVjlFSm1GNmVUaS1HNkJ0dnVrYVFuV0U3YXMifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxNjIwMTAwMDAwMDE3MDAsXCJBY2tEdFwiOlwiMjAyMC0wOC0wOCAxMToyMzowMFwiLFwiSXJuXCI6XCI1OGYxNjY5ZDMxYzU3MjVkZGNjMzllZWVjZDQ2NWU2OTU0M2M2MzlkYWViMWQ1ODI1NDZhYTNkMjhkNjZjM2Y4XCIsXCJWZXJzaW9uXCI6XCIxLjAxXCIsXCJUcmFuRHRsc1wiOntcIlRheFNjaFwiOlwiR1NUXCIsXCJTdXBUeXBcIjpcIkIyQlwiLFwiUmVnUmV2XCI6XCJZXCIsXCJJZ3N0T25JbnRyYVwiOlwiTlwifSxcIkRvY0R0bHNcIjp7XCJUeXBcIjpcIklOVlwiLFwiTm9cIjpcIkRPQy8wMDdcIixcIkR0XCI6XCIwOC8wOC8yMDIwXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyNEFBRkNENTg2MlIwMDVcIixcIkxnbE5tXCI6XCJOSUMgY29tcGFueSBwdnQgbHRkXCIsXCJUcmRObVwiOlwiTklDIEluZHVzdHJpZXNcIixcIkFkZHIxXCI6XCI1dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiR0FOREhJTkFHQVJcIixcIlBpblwiOjM4MjAxMCxcIlN0Y2RcIjpcIjI0XCIsXCJQaFwiOlwiOTAwMDAwMDAwMFwiLFwiRW1cIjpcImFiY0BnbWFpbC5jb21cIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJMZ2xObVwiOlwiWFlaIGNvbXBhbnkgcHZ0IGx0ZFwiLFwiVHJkTm1cIjpcIlhZWiBJbmR1c3RyaWVzXCIsXCJQb3NcIjpcIjEyXCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkdBTkRISU5BR0FSXCIsXCJQaW5cIjo1NjIxNjAsXCJQaFwiOlwiOTExMTExMTExMTFcIixcIkVtXCI6XCJ4eXpAeWFob28uY29tXCIsXCJTdGNkXCI6XCIyOVwifSxcIkRpc3BEdGxzXCI6e1wiTm1cIjpcIkFCQyBjb21wYW55IHB2dCBsdGRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIyOUFXR1BWNzEwN0IxWjFcIixcIkxnbE5tXCI6XCJDQkUgY29tcGFueSBwdnQgbHRkXCIsXCJUcmRObVwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJJdGVtTGlzdFwiOlt7XCJJdGVtTm9cIjoxLFwiU2xOb1wiOlwiMVwiLFwiSXNTZXJ2Y1wiOlwiTlwiLFwiUHJkRGVzY1wiOlwiUmljZVwiLFwiSHNuQ2RcIjpcIjEwMDFcIixcIkJhcmNkZVwiOlwiMTIzNDU2XCIsXCJRdHlcIjoxMDAuMzQ1LFwiRnJlZVF0eVwiOjEwLjAsXCJVbml0XCI6XCJCQUdcIixcIlVuaXRQcmljZVwiOjk5LjU0NSxcIlRvdEFtdFwiOjk5ODguODQsXCJEaXNjb3VudFwiOjEwLFwiUHJlVGF4VmFsXCI6MSxcIkFzc0FtdFwiOjk5NzguODQsXCJHc3RSdFwiOjEyLjAwMCxcIklnc3RBbXRcIjoxMTk3LjQ2LFwiQ2dzdEFtdFwiOjAsXCJTZ3N0QW10XCI6MCxcIkNlc1J0XCI6NS4wMDAsXCJDZXNBbXRcIjo0OTguOTQsXCJDZXNOb25BZHZsQW10XCI6MTAsXCJTdGF0ZUNlc1J0XCI6MTIuMDAwLFwiU3RhdGVDZXNBbXRcIjoxMTk3LjQ2LFwiU3RhdGVDZXNOb25BZHZsQW10XCI6NSxcIk90aENocmdcIjoxMCxcIlRvdEl0ZW1WYWxcIjoxMjg5Ny43LFwiT3JkTGluZVJlZlwiOlwiMzI1NlwiLFwiT3JnQ250cnlcIjpcIkFHXCIsXCJQcmRTbE5vXCI6XCIxMjM0NVwiLFwiQmNoRHRsc1wiOntcIk5tXCI6XCIxMjM0NTZcIn0sXCJBdHRyaWJEdGxzXCI6W3tcIk5tXCI6XCJSaWNlXCIsXCJWYWxcIjpcIjEwMDAwXCJ9XX1dLFwiVmFsRHRsc1wiOntcIkFzc1ZhbFwiOjk5NzguODQsXCJDZ3N0VmFsXCI6MCxcIlNnc3RWYWxcIjowLFwiSWdzdFZhbFwiOjExOTcuNDYsXCJDZXNWYWxcIjo1MDguOTQsXCJTdENlc1ZhbFwiOjEyMDIuNDYsXCJEaXNjb3VudFwiOjEwLFwiT3RoQ2hyZ1wiOjIwLFwiUm5kT2ZmQW10XCI6MC4zLFwiVG90SW52VmFsXCI6MTI5MDgsXCJUb3RJbnZWYWxGY1wiOjEyODk3Ljd9LFwiUGF5RHRsc1wiOntcIk5tXCI6XCJBQkNERVwiLFwiTW9kZVwiOlwiQ2FzaFwifSxcIlJlZkR0bHNcIjp7XCJJbnZSbVwiOlwiVEVTVFwiLFwiRG9jUGVyZER0bHNcIjp7XCJJbnZTdER0XCI6XCIwMS8wOC8yMDIwXCIsXCJJbnZFbmREdFwiOlwiMDEvMDkvMjAyMFwifSxcIlByZWNEb2NEdGxzXCI6W3tcIkludk5vXCI6XCJET0MvMDAyXCIsXCJJbnZEdFwiOlwiMDEvMDgvMjAyMFwiLFwiT3RoUmVmTm9cIjpcIjEyMzQ1NlwifV0sXCJDb250ckR0bHNcIjpbe1wiUmVjQWR2RHRcIjpcIjAxLzA4LzIwMjBcIn1dfSxcIkFkZGxEb2NEdGxzXCI6W3tcIlVybFwiOlwiaHR0cHM6Ly9laW52LWFwaXNhbmRib3gubmljLmluXCIsXCJEb2NzXCI6XCJUZXN0IERvY1wiLFwiSW5mb1wiOlwiRG9jdW1lbnQgVGVzdFwifV0sXCJFeHBEdGxzXCI6e1wiU2hpcEJOb1wiOlwiQS0yNDhcIixcIlNoaXBCRHRcIjpcIjAxLzA4LzIwMjBcIixcIlBvcnRcIjpcIklOQUJHMVwiLFwiUmVmQ2xtXCI6XCJOXCIsXCJGb3JDdXJcIjpcIkFFRFwiLFwiQ250Q29kZVwiOlwiQUVcIn0sXCJFd2JEdGxzXCI6e1wiVHJhbnNJZFwiOlwiMTJBV0dQVjcxMDdCMVoxXCIsXCJUcmFuc05hbWVcIjpcIlhZWiBFWFBPUlRTXCIsXCJUcmFuc01vZGVcIjpcIjFcIixcIkRpc3RhbmNlXCI6MTAwLFwiVHJhbnNEb2NOb1wiOlwiRE9DMDFcIixcIlRyYW5zRG9jRHRcIjpcIjA4LzA4LzIwMjBcIixcIlZlaE5vXCI6XCJrYTEyMzQ1NlwiLFwiVmVoVHlwZVwiOlwiUlwifX0iLCJpc3MiOiJOSUMifQ.qLdolsRy-W00xbHzME5U65jRf9c6R3tYTnEYzMG2hEZdBmFQzPCnw-T273OW_EmRUrYlp-7XjHRbInoW-kTfIieJpWfH20sSnf_siQO19YgbtoRuXQNE7uig7TqpJMGAIHH5QsAI1QLzJj1m98NucKGUcXhk2906MLtqHKMb5Ug0InaP4JweX2Dfmiqj5RiN5dLBFfIpgWhGT_2fSJBWdRg8w9CoQZwhdqN-2sP_SHdgNDzdH6eHtTp5eMyyLJNKA7estyqNoNvl8EpZHHeDZiISE4JXCf6yBq_8BaNKE9bsN_VCua_WCcBcNxYH3373F275PQhxybRMrGAntdUiNQ",
  "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjExNUY0NDI2NjE3QTc5MzhCRTFCQTA2REJFRTkxQTQyNzU4NEVEQUIiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJFVjlFSm1GNmVUaS1HNkJ0dnVrYVFuV0U3YXMifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI0QUFGQ0Q1ODYyUjAwNVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJEb2NOb1wiOlwiRE9DLzAwN1wiLFwiRG9jVHlwXCI6XCJJTlZcIixcIkRvY0R0XCI6XCIwOC8wOC8yMDIwXCIsXCJUb3RJbnZWYWxcIjoxMjkwOCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjEwMDFcIixcIklyblwiOlwiNThmMTY2OWQzMWM1NzI1ZGRjYzM5ZWVlY2Q0NjVlNjk1NDNjNjM5ZGFlYjFkNTgyNTQ2YWEzZDI4ZDY2YzNmOFwifSIsImlzcyI6Ik5JQyJ9.aQYuyV9pQzBaaFQUPJloj76GxEOVZ7xJCy09yxQIaL2gjPu16QcRNGksIlH3LBPFkA1b0wSNbi7e-nek65Pv5JHbyPjt4ihw9Z-YPqyzOdOU26lDP4ci0Ea_B1pSmOIv8itroLf2zVx5w6eUUqNYffI9h_JMF-E_BD0DoLE-axLvl-NM1Xb7kBFMQyzK-Y8AlXQEf_oAOxZcxqR8amJfIrN4mSTbcjcfUxT_16DECTW0Bbm83BFi1jtf_CQX4qZio-4WPCKbo1iZNzD9LXzAd8nt9ErzAqud8pKFWTHo3fVcX7TdfSc19G6PIk7GWy3FeQCvC_sZSkWfOR9eOJowNQ",
  "Status": "ACT",
  "EwbNo": 681008686014,
  "EwbDt": "2020-08-08 11:23:00",
  "EwbValidTill": "2020-08-09 23:59:00",
  "Remarks":"Pin-Pin calc distance: 997KM"
}

Invalid Response

{
  "Success": "N",
  "ErrorDetails": [
    {
      "error_code": "2148",
      "error_message": "Requested IRN data is not available",
      "error_source": "GOVT"
    }
  ]