Subscribe for Updates

Get E-Invoice by IRN

You can get details of an invoice by sending a GET request to E-Invoicing API with the following request headers.

Request Method

GET

Request URL

{{HOST}}/einv/v2/eInvoice/get?irn={{IRN_number}}

Request Headers

PARAMETER
PARAM TYPE
TYPE
DESCRIPTION

X-Cleartax-Auth-Token

Header

String

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

gstin

Header

String

Mandatory. GSTIN number for the user

Request Path Params

There are no path parameters for this API.

Request Query Params

KEY
PARAM TYPE
TYPE
DESCRIPTION

irn

Query

String

Mandatory. IRN number. Multiple allowed

Request Body

There is no request body for this API.

Response Status Codes

HTTP Status Code
Description

200

For a successfully processed request (may be a success or validation error).

401

If the user is not authenticated for the operation.

403

If the user is not authorized for the operation.

500

If there are any unhandled exceptions on the Clear side.

Response Schema

Parameter
Data Type
Field Validations
Description

document_status

Status

Enum: IRN_GENERATED, NOT_CREATED,

IRN_CANCELLED

Status of the IRN

govt_response

Object

NA

Response containing EInvoice details.

Govt. Response Object

Parameter
Data Type
Field Validations
Description

Success

Boolean

‘Y’, ‘N’

If Success or Failure.

AckNo

Number

NA

Acknowledgement Number

AckDt

String

NA

Acknowledgement Date

IRN

String

64 Digits

Invoice Reference Number

SignedInvoice

String

NA

Signed Invoice

SignedQRCode

String

NA

QR code in JWT String.

Status

String

NA

Status of the Invoice

EwbNo

Number

NA

E-Way bill Number.

EwbDt

String

NA

E-Way bill generation date and time.

EwbValidTill

String

NA

E-Way bill expiry date and time.

Sample Request & Response

Request Body

There is no request body for this API.

Response - Success:

HTTP Status Code: 200 OK

[
    {
        "custom_fields": null,
        "deleted": false,
        "document_status": "IRN_GENERATED",
        "error_response": null,
        "errors": null,
        "govt_response": {
            "Success": "Y",
            "AckNo": 112310186022618,
            "AckDt": "2023-10-18 12:23:00",
            "Irn": "833aad2dba44d53d118f79eb8f5018c6ecf1419c83bef79214ba217253e22639",
            "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMTIzMTAxODYwMjI2MTgsXCJBY2tEdFwiOlwiMjAyMy0xMC0xOCAxMjoyMzowMFwiLFwiSXJuXCI6XCI4MzNhYWQyZGJhNDRkNTNkMTE4Zjc5ZWI4ZjUwMThjNmVjZjE0MTljODNiZWY3OTIxNGJhMjE3MjUzZTIyNjM5XCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIllcIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiV0FSQjJCNjhcIixcIkR0XCI6XCIxMC8xMC8yMDIzXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBRkNENTg2MlIwMDBcIixcIkxnbE5tXCI6XCJOSUMgQ29tcGFueSBQdnQgTHRkXCIsXCJUcmRObVwiOlwiTklDIEluZHVzdHJpZXNcIixcIkFkZHIxXCI6XCI1dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiR0FOREhJTkFHQVJcIixcIlBpblwiOjU2MDAzNyxcIlN0Y2RcIjpcIjI5XCIsXCJQaFwiOlwiOTAwMDAwMFwiLFwiRW1cIjpcImFiY0BnbWFpbC5jb21cIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJMZ2xObVwiOlwiWFlaIENvbXBhbnkgUHZ0IEx0ZFwiLFwiVHJkTm1cIjpcIlhZWiBJbmR1c3RyaWVzXCIsXCJQb3NcIjpcIjEyXCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkdBTkRISU5BR0FSXCIsXCJQaW5cIjo1NjIxNjAsXCJQaFwiOlwiOTExMTExMTExMTFcIixcIkVtXCI6XCJ4eXpAeWFob28uY29tXCIsXCJTdGNkXCI6XCIyOVwifSxcIkRpc3BEdGxzXCI6e1wiTm1cIjpcIkFCQyBjb21wYW55IHB2dCBsdGRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIyOUFXR1BWNzEwN0IxWjFcIixcIkxnbE5tXCI6XCJDQkUgY29tcGFueSBwdnQgbHRkXCIsXCJUcmRObVwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJJdGVtTGlzdFwiOlt7XCJJdGVtTm9cIjowLFwiU2xOb1wiOlwiMVwiLFwiSXNTZXJ2Y1wiOlwiTlwiLFwiUHJkRGVzY1wiOlwiUmljZVwiLFwiSHNuQ2RcIjpcIjcxMDY5MlwiLFwiQmFyY2RlXCI6XCIxMjM0NTZcIixcIlF0eVwiOjAuMixcIlVuaXRcIjpcIkJBR1wiLFwiVW5pdFByaWNlXCI6MTAwLjAsXCJUb3RBbXRcIjoyMC4wMCxcIkFzc0FtdFwiOjIwLjAwLFwiR3N0UnRcIjoxOC4wMDAsXCJJZ3N0QW10XCI6My42MCxcIkNnc3RBbXRcIjowLjAwLFwiU2dzdEFtdFwiOjAuMDAsXCJUb3RJdGVtVmFsXCI6MjMuNjB9XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoyMC4wMCxcIkNnc3RWYWxcIjowLjAwLFwiU2dzdFZhbFwiOjAuMDAsXCJJZ3N0VmFsXCI6My42MCxcIlRvdEludlZhbFwiOjIzLjYwLFwiVG90SW52VmFsRmNcIjoxMjg5Ny43MH0sXCJFd2JEdGxzXCI6e1wiVHJhbnNJZFwiOlwiMTJBV0dQVjcxMDdCMVoxXCIsXCJUcmFuc05hbWVcIjpcIlhZWiBFWFBPUlRTXCIsXCJUcmFuc01vZGVcIjpcIjFcIixcIkRpc3RhbmNlXCI6MTAwLFwiVmVoTm9cIjpcImthMTIzNDU2XCIsXCJWZWhUeXBlXCI6XCJSXCJ9fSIsImlzcyI6Ik5JQyBTYW5kYm94In0.xun-87FXuJ0JbPzdotkr87JpIQ-XdsGeF7Iud4N6mEognC-st_DXAq7tZ7QXuGEC-uq5cHHoNiMP8qMeCgkerqBzt81jObv7KHmoHQL9yBwl08omWOQbb0wvLfs-J9jqGlN5qYWELO3oFn2HhrYzEeFz5GxPH4c5oRPW34wdkICUxZh43SUOlHL9vZ8XzOuAosHKli3K23zi4czfQmJY1kaclHxLrOKmWQz04Gb30xdYhE2MZQXk64vX32IgV9NNJ-JRiV-bowKrNoO9CAxvUmPBaWlIPc2Ygvx45K3HOCyX_RWAqFDneY1xgjtVobX1TgQIZjwmaOjvfiwO09qiBw",
            "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFGQ0Q1ODYyUjAwMFwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJEb2NOb1wiOlwiV0FSQjJCNjhcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTAvMTAvMjAyM1wiLFwiVG90SW52VmFsXCI6MjMuNjAsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCI3MTA2OTJcIixcIklyblwiOlwiODMzYWFkMmRiYTQ0ZDUzZDExOGY3OWViOGY1MDE4YzZlY2YxNDE5YzgzYmVmNzkyMTRiYTIxNzI1M2UyMjYzOVwiLFwiSXJuRHRcIjpcIjIwMjMtMTAtMTggMTI6MjM6MDBcIn0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.mWfTFv5SRJishPErx7RgYVHmL4RytCjLeD20x4Pam-Iy1CIA5tNnS9_QhlvxLV8tRIF1Qd0uTRMHOamcOMC6uO4QwNdAaFNFyRepTL5lr80ik-w8NOsW4V-BjgKVyVNl4r_YzfomijfYZzYgNOfhm0GEpECD6xK2uR_r23GpHQ-qwOxwAQE0ciaZN_BKqXmqjXwrgoQeVKGm9XiqiFxydjNvged1i0Cy2PrNYMUufr4kyfHW9zaniWkURLivUPW13TQWzo6qE6nQ0Ta7Yk_lPGdG_k0O5tlHDxszoK8wtl36q4VGSd_-mvW5qkKVMp0R2Ch97gEAYbyzMW1tSR00UQ",
            "Status": "ACT",
            "EwbNo": 191010273815,
            "EwbDt": "2023-10-18 12:23:00",
            "EwbValidTill": "2023-10-19 23:59:00"
        },
        "group_id": null,
        "gstin": "29AAFCD5862R000",
        "is_deleted": false,
        "owner_id": null,
        "tag_identifier": null,
        "transaction": {
            "Version": "1.1",
            "Irn": "833aad2dba44d53d118f79eb8f5018c6ecf1419c83bef79214ba217253e22639",
            "TranDtls": {
                "TaxSch": "GST",
                "RegRev": "Y",
                "SupTyp": "B2B",
                "IgstOnIntra": "N"
            },
            "DocDtls": {
                "Typ": "INV",
                "No": "WARB2B68",
                "Dt": "10/10/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": "9000000",
                "Em": "[email protected]"
            },
            "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": "[email protected]"
            },
            "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": "710692",
                    "Barcde": "123456",
                    "Qty": 0.200,
                    "Unit": "BAG",
                    "UnitPrice": 100.000,
                    "TotAmt": 20.00,
                    "AssAmt": 20.00,
                    "GstRt": 18.00,
                    "IgstAmt": 3.60,
                    "CgstAmt": 0.00,
                    "SgstAmt": 0.00,
                    "TotItemVal": 23.60
                }
            ],
            "ValDtls": {
                "AssVal": 20.00,
                "CgstVal": 0.00,
                "SgstVal": 0.00,
                "IgstVal": 3.60,
                "TotInvVal": 23.60,
                "TotInvValFc": 12897.70
            },
            "EwbDtls": {
                "TransId": "12AWGPV7107B1Z1",
                "TransName": "XYZ EXPORTS",
                "TransMode": "1",
                "Distance": 100,
                "VehNo": "ka123456",
                "VehType": "R"
            }
        },
        "transaction_id": "29AAFCD5862R000_WARB2B68_INV_2023",
        "transaction_metadata": null
    }
]

Response - Failure:

HTTP Status Code: 200 OK

[
    {
        "custom_fields": null,
        "deleted": false,
        "document_status": "NOT_CREATED",
        "error_response": null,
        "errors": null,
        "govt_response": {
            "Success": "N",
            "ErrorDetails": [
                {
                    "error_code": "107",
                    "error_message": "null : Invalid IRN, it must be equal to 64 characters in length. Please send a valid value of IRN and try again.",
                    "error_source": "CLEARTAX"
                }
            ]
        },
        "group_id": null,
        "gstin": null,
        "is_deleted": false,
        "owner_id": null,
        "tag_identifier": null,
        "transaction": null,
        "transaction_id": null,
        "transaction_metadata": null
    }
]

API Validations

Currently there are no known validations for this API.

API Constraints

A Maximum of 5 invoices can be fetched per API call.

PreviousGet E-Invoice PDFNextGet Invoice Details

Last updated

Was this helpful?