Get e-Invoice Details#

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

Route

/basic/einv/{flynnApiVersion}/{irp}/eicore/{e-invoice-api-version}/Invoice/irnbydocdetails?doctype={document-type}&docnum={document-number}&docdate={document-date}

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

URL Parameters#

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

QUERY Parameters#

Name	Description	Type
doctype	Document type (INV/CRN/DBN)	string
docnum	Document number number	string
docdate	Document date (format DD/MM/YYYY, like 31/12/2020)	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

{
"status": "1",
"data": {
    "AckNo": "162310048427387",
    "AckDt": "2023-07-06 16:43:00",
    "Irn": "9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91",
    "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxNjIzMTAwNDg0MjczODcsXCJBY2tEdFwiOlwiMjAyMy0wNy0wNiAxNjo0MjozOFwiLFwiSXJuXCI6XCI5YTM2Yzg3NGQ1NzRlZGE0MjM4NWZkMjc5NjQ2MzU3N2RiZDY2NjkyZTNiMjhhNTMwMWM4OGExZmU5NDI5YjkxXCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIk5cIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiUkFNSVJOSU5BMTk5XCIsXCJEdFwiOlwiMjEvMDYvMjAyMVwifSxcIlNlbGxlckR0bHNcIjp7XCJHc3RpblwiOlwiMjRBQUFQSTMxODJNMDAyXCIsXCJMZ2xObVwiOlwiSktMIFB2dC4gTHRkXCIsXCJUcmRObVwiOlwiSktMIFB2dC4gTHRkXCIsXCJBZGRyMVwiOlwiS2lsbGEgTm9cXHUwMDI3cyAyOS8xNi8yLDI1LjM3LzUsNiwxNSAsXCIsXCJBZGRyMlwiOlwiIERpc3RyaWN0IEd1cnVncmFtICxWaWxsYWdlIFRhaiBOYWdhciAsSGFyeWFuYVwiLFwiTG9jXCI6XCJCYW5nYWxvcmVcIixcIlBpblwiOjM5NTAwMyxcIlN0Y2RcIjpcIjI0XCIsXCJQaFwiOlwiOTAwMDIwNzAyOFwifSxcIkJ1eWVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBQVBJMzE4Mk0wMDBcIixcIkxnbE5tXCI6XCJUZXN0IE9yZyBQdnQgTHRkLCBLaW5nc3dheSBCdWlsZGluZ1wiLFwiVHJkTm1cIjpcIlRlc3QgT3JnIFB2dCBMdGQsIEtpbmdzd2F5IEJ1aWxkaW5nXCIsXCJQb3NcIjpcIjI5XCIsXCJBZGRyMVwiOlwiU2hlZCBOby4xMCwgVmlzaW9uIFJlYWx0ZWNoIFByaXZhdGUgTGltaXRlZCwgS2hhc3JhIDc3LzEzIFxcdTAwMjYgNzcvMTFcIixcIkFkZHIyXCI6XCJTYW1wbGEga2hhcmtob2RhIHJvYWQsT3BwIFRDSSBIVUwgV2FyZWhvdXNlLCBUZWhzaWwgU0FNUExBLFZpbGxhZ2UtSGFzc2FuZ2FyaFwiLFwiTG9jXCI6XCJSb2h0YWtcIixcIlBpblwiOjU2MDAyNSxcIlBoXCI6XCI5MDAwMjA3MDI3XCIsXCJTdGNkXCI6XCIyOVwifSxcIkl0ZW1MaXN0XCI6W3tcIkl0ZW1Ob1wiOjAsXCJTbE5vXCI6XCIxXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJQcmREZXNjXCI6XCJQQVRBTkpBTEkgU0FVTkRBUllBIEFMT0VWRVJBIEdFTCAxNTBNTCBcIixcIkhzbkNkXCI6XCIzNDAxMzA5MFwiLFwiUXR5XCI6NDIwLFwiRnJlZVF0eVwiOjAsXCJVbml0XCI6XCJQQ1NcIixcIlVuaXRQcmljZVwiOjY1LjIxLFwiVG90QW10XCI6MjczODguMixcIkRpc2NvdW50XCI6MCxcIlByZVRheFZhbFwiOjEsXCJBc3NBbXRcIjoyNzM4OC4yLFwiR3N0UnRcIjoxOCxcIklnc3RBbXRcIjo0OTI5Ljg4LFwiQ2dzdEFtdFwiOjAsXCJTZ3N0QW10XCI6MCxcIkNlc1J0XCI6MCxcIkNlc0FtdFwiOjAsXCJDZXNOb25BZHZsQW10XCI6MCxcIlN0YXRlQ2VzUnRcIjowLFwiU3RhdGVDZXNBbXRcIjowLFwiU3RhdGVDZXNOb25BZHZsQW10XCI6MCxcIk90aENocmdcIjoyNC4yNCxcIlRvdEl0ZW1WYWxcIjozMjM0Mi4zMixcIkF0dHJpYkR0bHNcIjpbe1wiTm1cIjpcIlBBVEFOSkFMSSBTQVVOREFSWUEgQUxPRVZFUkEgR0VMIDE1ME1MIFwiLFwiVmFsXCI6XCIyNzM4OC4yMFwifV19XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoyNzM4OC4yLFwiQ2dzdFZhbFwiOjAsXCJTZ3N0VmFsXCI6MCxcIklnc3RWYWxcIjo0OTI5Ljg4LFwiQ2VzVmFsXCI6MCxcIlN0Q2VzVmFsXCI6MCxcIkRpc2NvdW50XCI6MCxcIk90aENocmdcIjowLFwiUm5kT2ZmQW10XCI6MCxcIlRvdEludlZhbFwiOjMyMzQyLjMyfSxcIlJlZkR0bHNcIjp7XCJJbnZSbVwiOlwiSW52b2ljZSBSZW1hcmtzXCIsXCJEb2NQZXJkRHRsc1wiOntcIkludlN0RHRcIjpcIjIxLzA2LzIwMjFcIixcIkludkVuZER0XCI6XCIzMS8xMi8yMDIxXCJ9fSxcIkV3YkR0bHNcIjp7XCJUcmFuc05hbWVcIjpcIkFCQ0FTXCIsXCJEaXN0YW5jZVwiOjB9fSIsImlzcyI6Ik5JQyBTYW5kYm94In0.vdniSkPmIrrcsQNx7XuyAtJG4-l5-6I28CL9Vhr6mRSYkOEOrgHyPCMQDXQLCPw3dfnKuV85y501Xy3ovKvNbzEQ2nZeNViV-QYjDWlyZdTEQojgoH5HcvU6_7vQkYtRr2KgLyj1Gau6xSzOCDWgRZWec33Q84jpFczs87fAgDIppdYogTGbrBzxmZoSfqdiQIW4jMxnL-HoEkj4LcUxhzJqYpPPFvbf2LwuLK7NPib1QGik5qKAtG9QIfk73duTwLdkb1qZFd2moUX-LYuQCwmhVBa_OfExAFvNlvQJYAjrkon7z3WSRj7db7-k9z-wGG2kHhhlhx_1GWgL1OBcuQ",
    "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI0QUFBUEkzMTgyTTAwMlwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUFQSTMxODJNMDAwXCIsXCJEb2NOb1wiOlwiUkFNSVJOSU5BMTk5XCIsXCJEb2NUeXBcIjpcIklOVlwiLFwiRG9jRHRcIjpcIjIxLzA2LzIwMjFcIixcIlRvdEludlZhbFwiOjMyMzQyLjMyLFwiSXRlbUNudFwiOjEsXCJNYWluSHNuQ29kZVwiOlwiMzQwMTMwOTBcIixcIklyblwiOlwiOWEzNmM4NzRkNTc0ZWRhNDIzODVmZDI3OTY0NjM1NzdkYmQ2NjY5MmUzYjI4YTUzMDFjODhhMWZlOTQyOWI5MVwiLFwiSXJuRHRcIjpcIjIwMjMtMDctMDYgMTY6NDI6MzhcIn0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.ibQ-nD6SC6_khq8gM2EYvjLcSKgYBiBr4UYC8mG8cfA8lTX16h4j1r5HOoS2_xglcvldrTo9oCJ6YCQJxg4fcx-sxcN-nl2xaui_dF5vc8Dq9KIJmIRc94DvE5zyuDgLA-Tnf_sHkIl7OnbQ_2JmUkj4UBZoXEMROkuuJD5oopCyvKaxByWhJDDfkud03ID6GjjaEMPVKIzzUz6zC7rCN0cR6yiVxGyRTPe3B33tZWPmOLzrLUXJBZZGx95u1g3wfPH3MiYDPRqJREfdcJq2uWyrMm__sQ0deX3n-1YhYBhsUnjukoLElJyzjeQCB6i1XE34E1f8SUpaieRK3b7Elw",
    "Status": "ACT",
    "EwbNo": 661010233323,
    "EwbDt": "2023-07-06 16:44:00",
    "EwbValidTill": "2023-07-13 23:59:00",
    "Remarks": null
},
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
}

`502`:#

When the E-invoice isn’t found.

Sample Response Body

{
"status": "0",
"data": null,
"error": {
    "message": "err-irp-returned-error",
    "type": "Irp",
    "args": {
        "details": [
            {
                "ErrorCode": "2154",
                "ErrorMessage": "IRN details are not found"
            }
        ]
    }
},
"info": null,
"additionalInfo": null,
"alert": null
}

E-invoice errors are mentioned under common errors for v3.0 api.

Notes#

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