Cancel E-Invoice by IRN

Cancel IRN offers single e-invoice cancellation as opposed to its enriched counterpart.

Route

/basic/einv/{flynn-version}/{irp}/eicore/{e-invoice-api-version}/Invoice/Cancel

• active ‘flynn-version’: v3.0
• method: POST

URL Parameters

Name	Description	Type
flynn-version	version of the API for example, v3.0	string
irp	IRP Provider as per GST registration for e-invoicing	enum (ni1, ni2)
e-invoice-api-version	E-invoice API version	string

Headers

All headers as mentioned in the Basic E-Invoice API introduction.

Apart from the common headers need to pass below headers

header	Description
irp	This request header is mandatory if Taxpayer wants to perform interoperability / criss-cross operations on IRN. Accepted values are NIC1 or NIC2

Tip

The only valid values for the header keys Content-Type and accept must have to be application/json.

Request

Body consists of the payload guided by IRP documentation present on this page

Please refer the following request body for reference-

Sample request body

{
    "Irn":"a5c12dca80e743321740b001fd70953e8738d109865d28ba4013750f2046f229",
    "CnlRsn":"1 ",
    "CnlRem":"Wrong entry"
}

Response

200:

Successful response will have the cancelled e-invoice in “data” attribute as a String.

Sample response body

{
"status": "1",
"data": {
    "Irn": "9a36c874d574eda42385fd2796463577dbd66692e3b28a5301c88a1fe9429b91",
    "CancelDate": "2023-07-06 06:14:00"
},
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
}

E-invoice errors are mentioned under common errors for v3.0 api.

Notes

IRP - nic is deprecated. Instead of it please use ni1 or ni2