Get IRN Details by Document Details
IRN details can be fetched by document type, document date & document number.
Overview
API to fetch IRN details by passing document details.
Endpoint
| HTTP Method | Resource |
|---|---|
GET |
Request
Follow the below guidelines to pass document/invoice details to get IRN details.
Path Parameters
| Param | Type | Description | Example |
|---|---|---|---|
| gstin | string | 15-character alphanumeric unique identifier assigned to business entities registering under the GST regime | 24AAACJ3770E2ZV |
| doctype | string | Document Type:INV - INVOICECRN - CREDIT NOTEDBN - DEBIT NOTE | INV |
| docnum | string | Document Number | DOC/001 |
| docdate | string | Document Date | 18/08/2020 |
Query Parameters
| Param | Type | Description | Example |
|---|---|---|---|
| sup_gstin | string | Supplier GSTIN, only in case E Comm. operator is getting IRN details |
curl --location --request GET 'https://api.sandbox.co.in/ /24AAACJ3770E2ZZ/ / / / ' \
--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
| 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 |
Updated 2 months ago