Overview

API to fetch IRN details by passing document details.

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

Endpoint

HTTP Method	Resource
`GET`	/irp/tax-payer/e-invoice?doc-type={doc-type}&doc-num={doc-num}&doc-date={doc-date}

Request

Follow the below guidelines to pass document/invoice details to get IRN details.

Query Parameters

Param	Type	Description	Example
doc-type	`string`	Document Type: `INV` - INVOICE `CRN` - CREDIT NOTE `DBN` - DEBIT NOTE	INV
doc-num	`string`	Document Number	DOC/001
doc-date	`string`	Document Date	18/08/2020
sup_gstin (optional)	`string`	Supplier GSTIN, only in case E Comm. operator is getting IRN details	24AAACJ3770E2ZV

Sample cURL Command

curl --request GET \
     --url 'https://api.sandbox.co.in/irp/tax-payer/e-invoice?doc-type=INV&doc-num=DOC%2F001&doc-date=18%2F08%2F2020&sup_gstin=24AAACJ3770E2ZV' \
     --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 distance is passed is 0, shows actual distance calculated for the pair of PIN codes	Pin-Pin calc distance: 997KM

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