Cancel IRN
The Invoice Registration Number can only be canceled within 24 hours of generating it.
Overview
API to cancel the e-invoice by passing the irn number.
Stipulated Time
IRN can be canceled only within 24 hours of its generation. However, it cannot be canceled if a Valid or Active E-Way Bill exists for the same.
Endpoint
| HTTP Method | Resource |
|---|---|
POST | /irp/tax-payer/e-invoice/:irn/cancel |
Request
Follow the below guidelines to pass GSTIN in path parameters 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 | a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229 |
Body Parameters
| Param | Type | Description | Example |
|---|---|---|---|
| Irn | string | Invoice Reference Number | a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229 |
| CnlRsn | string | Cancel Reason 1- Duplicate, 2 - Data entry mistake, 3- Order Cancelled, 4 - Others | 1 |
| CnlRem | string | Cancel Remarks | Wrong entry |
Sample CURL Request
curl --request POST \
--url https://api.sandbox.co.in/irp/tax-payer/e-invoice/a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229/cancel \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0' \
--data '
{
"Irn": "a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229",
"CnlRsn": "1 ",
"CnlRem": "Wrong entry"
}
'
Test Environment Not Available
Response
| Param | Type | Description | Example |
|---|---|---|---|
| Irn | string | IRN that is canceled | a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229 |
| CancelDate | string | Date of cancellation of the IRN | 2019-12-05 14:26:00 |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Cancel IRN 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
Updated about 1 month ago