Get IRN Details

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

API Endpoint  Contact Us  Free Trial

Request

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

Path Parameters

ParamTypeDescriptionExample
gstinstring15-character alphanumeric unique identifier assigned to business entities registering under the GST regime24AAACJ3770E2ZV
irnstringSHA256 hash of GSTIN, DocDtls.No, DocDtls.Typ, the financial year of DoctDtls.Dtd056a57cc7cfcc6c9230aa0014e439259d0dc57cfa4eea2326253011fd53ea7e

Query Parameters

ParamTypeDescriptionExample
sup_gstinstringSupplier GSTIN, only in case E Comm. operator is getting IRN details

Sample CURL Request

curl --location --request GET 'https://api.sandbox.co.in/ /24AAACJ3770E2ZZ/d056a57cc7cfcc6c9230aa0014e439259d0dc57cfa4eea2326253011fd53ea7e' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 3.4.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