Get e-Invoice by IRN

Every e-Invoice has a unique Invoice Registration Number (IRN) for a financial year. Use this API to fetch IRN details.

Overview

Use this API to fetch e-Invoice details by passing irn

Endpoint

HTTP MethodResource
GET/irp/tax-payer/e-invoice/:irn

API Endpoint  Contact Us  Free Trial

Request

Follow the below guidelines to pass GSTIN and IRN to call the API.

Headers

ParamTypeDescriptionExample
x-api-keystringAn API key is a public key to identify users when calling any Sandbox API.key_live_ZUQT5UEf4......
AuthorizationstringJWT Authorization token which is generated using e-Invoice Authentication API.eyJhsebihGyUf......

Path Parameters

ParamTypeDescriptionExample
irnstringInvoice Reference Numberd056a57cc7cfcc64e439259d0dc57cfa4eea2326253011fd53ea7e

Sample CURL Request

curl --request GET \
     --url https://api.sandbox.co.in/irp/tax-payer/e-invoice/d056a57cc7cfcc64e439259d0dc57cfa4eea2326253011fd53ea7e \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'

❗️

Test Environment Not Available

Response

ParamTypeDescriptionExample
AckNonumTransaction number112010000002315
AckDtstringDate and time on which invoice is registered(Date format is ‘yyyy-MM-dd HH:mm:ss ’)2019-12-25 12:03:00
IrnstringSHA256 hash of Gstin, DocDtls.No, DocDtls.Typ, financial year of DoctDtls.Dtd056a57cc7cfcc6c9230aa0014e439259d0dc57cfa4eea2326253011fd53ea7e
SignedInvoicestringComplete e-Invoice data digitally signed using JSON Web Token(JWT) and JSON Web Signature (JWS) with “SHA256RSA” algorithm
SignedQRCodestringComplete QR- Code data digitally signed using JSON Web Token(JWT) and JSON Web Signature (JWS) with “SHA256RSA” algorithm
Statusstring‘ACT’ for Active and ‘CNL’ for CancelledACT
EwbNonumE Way Bill No. , if E Way Bill is generated191008688443
EwbDtstringE Way Bill Date. , if E Way Bill is generated2020-08-05 15:18:00
EwbValidTillstringE Way Bill validity date, if Part B details are provided in the payload2020-08-06 23:59:00
RemarksstringAdditional information such as, If the distance passed is 0, shows the actual distance calculated for the pair of PIN codesPin-Pin calc distance: 997KM

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since Get GSTIN Details API is a Paid API, a wallet charge of INR 0.25 + GST will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here