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

Last updated

Was this helpful?