Overview

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

🚧
IRN can be only retrieved within three days from the date of generation

Endpoint

HTTP Method	Resource
`GET`	/irp/tax-payer/e-invoice/:irn

Request

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

Headers

Param	Type	Description	Example
x-api-key	`string`	An API key is a public key to identify users when calling any Sandbox API.	key_live_ZUQT5UEf4......
Authorization	`string`	JWT Authorization token which is generated using e-Invoice Authentication API.	eyJhsebihGyUf......

Path Parameters

Param	Type	Description	Example
irn	`string`	Invoice Reference Number	d056a57cc7cfcc64e439259d0dc57cfa4eea2326253011fd53ea7e

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

Param	Type	Description	Example
AckNo	`num`	Transaction number	112010000002315
AckDt	`string`	Date and time on which invoice is registered(Date format is ‘yyyy-MM-dd HH:mm:ss ’)	2019-12-25 12:03:00
Irn	`string`	SHA256 hash of Gstin, DocDtls.No, DocDtls.Typ, financial year of DoctDtls.Dt	d056a57cc7cfcc6c9230aa0014e439259d0dc57cfa4eea2326253011fd53ea7e
SignedInvoice	`string`	Complete e-Invoice data digitally signed using JSON Web Token(JWT) and JSON Web Signature (JWS) with “SHA256RSA” algorithm
SignedQRCode	`string`	Complete QR- Code data digitally signed using JSON Web Token(JWT) and JSON Web Signature (JWS) with “SHA256RSA” algorithm
Status	`string`	‘ACT’ for Active and ‘CNL’ for Cancelled	ACT
EwbNo	`num`	E Way Bill No. , if E Way Bill is generated	191008688443
EwbDt	`string`	E Way Bill Date. , if E Way Bill is generated	2020-08-05 15:18:00
EwbValidTill	`string`	E Way Bill validity date, if Part B details are provided in the payload	2020-08-06 23:59:00
Remarks	`string`	Additional information such as, If the distance passed is 0, shows the actual distance calculated for the pair of PIN codes	Pin-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