Subscribe for Updates

Cancel IRN

You can cancel an IRN by sending a PUT request to E-Invoicing API with the following request headers.

Request Method

PUT

Request URL

{{HOST}}/einv/v2/eInvoice/cancel

Request Headers

PARAMETER
PARAMTER TYPE
TYPE
DESCRIPTION

X-Cleartax-Auth-Token

Header

String

Mandatory. The auth token generated from ClearTax user id and password. Know how.

Content-Type

Header

String

Mandatory. This will always be "application/json" for JSON and "application/xml" for XML.

Accept

Header

String

Optional. This will be "application/xml" if you want the response in XML.

gstin

Header

String

Mandatory. GSTIN number for the user

Request Path Params

There are no path parameters for this API.

Request Query Params

There are no query parameters for this API.

Request Body

Parameters
TYPE
VALIDATIONS
DESCRIPTION

irn

String

minLength: 64 maxLength: 64

Mandatory. IRN generated for the invoice.

CnlRsn

String

minLength: 1 maxLength: 1

enum: ["1", "2", "3", "4"]

Mandatory. Reason for cancellation.

1 = Duplicate

2 = Data entry mistake

3 = Order Cancelled

4 = Others

CnlRem

String

minLength: 0 maxLength: 100

Mandatory. Remarks for cancellation.

Response Status Codes

HTTP Status Code
Description

200

For a successfully processed request (may be a success or validation error).

400

Bad Request. Invalid JSON Payload

401

If the user is not authenticated for the operation.

403

If the user is not authorized for the operation.

500

If there are any unhandled exceptions on the Clear side.

Response Schema

Parameter
Data Type
Field Validations
Description

document_status

String

Enum:

IRN_CANCELLED

IRN_CANCELLATION_FAILED

Status of the cancellation request.

govt_response

Object

NA

Details captured from the source Govt.

Govt Response Object

Parameter

Data Type

Field Validations

Description

Success

Boolean

‘Y’, ‘N’

If Success or Failure.

AckNo

Number

NA

Acknowledgement Number

AckDt

String

NA

Acknowledgement Date

IRN

String

64 Digits

Invoice Reference Number

SignedInvoice

String

NA

Signed Invoice

SignedQRCode

String

NA

QR code in JWT String.

Status

String

CancelDate

String

NA

Date and time of cancellation.

Sample Request and Response

Request 

[
{
  "irn": "6ca40d80480362014445a75ea944881f6a31d2b91fc7b88c84e3b250aec447c1",
  "CnlRsn": "1",
  "CnlRem": "Wrong"
}
]

Response - Success:

HTTP Status Code : 200 OK

[
    {
        "custom_fields": null,
        "deleted": false,
        "document_status": "IRN_CANCELLED",
        "error_response": null,
        "errors": null,
        "govt_response": {
            "Success": "Y",
            "AckNo": 112310186209758,
            "AckDt": "2023-10-26 14:28:00",
            "Irn": "1641fc014d8b1b5be859f3f90973ab0fb9307566eaf70b7f272838865bdd8ee3",
            "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMTIzMTAxODYyMDk3NTgsXCJBY2tEdFwiOlwiMjAyMy0xMC0yNiAxNDoyODowMFwiLFwiSXJuXCI6XCIxNjQxZmMwMTRkOGIxYjViZTg1OWYzZjkwOTczYWIwZmI5MzA3NTY2ZWFmNzBiN2YyNzI4Mzg4NjViZGQ4ZWUzXCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIllcIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiV0FSQjJCODNcIixcIkR0XCI6XCIxMC8xMC8yMDIzXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBRkNENTg2MlIwMDBcIixcIkxnbE5tXCI6XCJOSUMgQ29tcGFueSBQdnQgTHRkXCIsXCJUcmRObVwiOlwiTklDIEluZHVzdHJpZXNcIixcIkFkZHIxXCI6XCI1dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiR0FOREhJTkFHQVJcIixcIlBpblwiOjU2MDAzNyxcIlN0Y2RcIjpcIjI5XCIsXCJQaFwiOlwiOTAwMDAwMFwiLFwiRW1cIjpcImFiY0BnbWFpbC5jb21cIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJMZ2xObVwiOlwiWFlaIENvbXBhbnkgUHZ0IEx0ZFwiLFwiVHJkTm1cIjpcIlhZWiBJbmR1c3RyaWVzXCIsXCJQb3NcIjpcIjEyXCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkdBTkRISU5BR0FSXCIsXCJQaW5cIjo1NjIxNjAsXCJQaFwiOlwiOTExMTExMTExMTFcIixcIkVtXCI6XCJ4eXpAeWFob28uY29tXCIsXCJTdGNkXCI6XCIyOVwifSxcIkl0ZW1MaXN0XCI6W3tcIkl0ZW1Ob1wiOjAsXCJTbE5vXCI6XCIxXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJQcmREZXNjXCI6XCJSaWNlXCIsXCJIc25DZFwiOlwiNzEwNjkyXCIsXCJCYXJjZGVcIjpcIjEyMzQ1NlwiLFwiUXR5XCI6MC4yLFwiVW5pdFwiOlwiQkFHXCIsXCJVbml0UHJpY2VcIjoxMDAuMCxcIlRvdEFtdFwiOjIwLjAwLFwiQXNzQW10XCI6MjAuMDAsXCJHc3RSdFwiOjE4LjAwMCxcIklnc3RBbXRcIjozLjYwLFwiQ2dzdEFtdFwiOjAuMDAsXCJTZ3N0QW10XCI6MC4wMCxcIlRvdEl0ZW1WYWxcIjoyMy42MH1dLFwiVmFsRHRsc1wiOntcIkFzc1ZhbFwiOjIwLjAwLFwiQ2dzdFZhbFwiOjAuMDAsXCJTZ3N0VmFsXCI6MC4wMCxcIklnc3RWYWxcIjozLjYwLFwiVG90SW52VmFsXCI6MjMuNjAsXCJUb3RJbnZWYWxGY1wiOjEyODk3LjcwfX0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.tsXT5yvKSTbjCWOhdVllDSXXEZYd5hNqyIlhuL_NkabL1sQsZQK21LQx5-u8-GJrfSSiojr_0lD7LxlMDDZE07FnxLWtWVXehSomC6XV5Gu5hp8F6oZ1JTHuTa-5uLiSXfwywXGw2UZWYb2yEq-pkzSYwNtx5IE8RUJo1ZNPqrF7KX5v2AYTiPtEi2-FWcpHtRqSy_QG3wU8H57ZuhnF1Q2I4VAQidRFj296sBbEm33o4yClHvRiB_GqL1NQuJtcNh32HxsoAsW3Mp4YXoVLVxGZE8njeO_B20XcI7hJzProJMZp6dPVeRi9ErDp1YHv22LpCemIdMLahUuIVQitog",
            "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFGQ0Q1ODYyUjAwMFwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJEb2NOb1wiOlwiV0FSQjJCODNcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTAvMTAvMjAyM1wiLFwiVG90SW52VmFsXCI6MjMuNjAsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCI3MTA2OTJcIixcIklyblwiOlwiMTY0MWZjMDE0ZDhiMWI1YmU4NTlmM2Y5MDk3M2FiMGZiOTMwNzU2NmVhZjcwYjdmMjcyODM4ODY1YmRkOGVlM1wiLFwiSXJuRHRcIjpcIjIwMjMtMTAtMjYgMTQ6Mjg6MDBcIn0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.bO-m7dvcv5ChvIZBBOl-ugPk8JJ-ZcrubPgbwH4EputOBfbFo1atck0KpelErLZQ5nbBjRNNdbEdPYqLoMpwGpS53yPsUtw9iVw4dz7LbtuVQBw7Nj6JOg-YEkwI0b93XdywQRtdwN8kKddd3m489KY4q-4KgAMjzxry7pMLWQvJBi49Uby2Ill_N3_RW142VLSwpavH4aIYeBwR-GzgSWYdKgvdAzZnFGf-i7lcOKztVGohg6O3SjJXiMm3fT4Wg7Vhh8WewTT9GIv2rdg5u4m8zt9owcPb6u02aCLi4FMxhuw9osi3SKTi2itWb4ncCAz2uoL-IGsRYeLYWO7AlA",
            "Status": "ACT",
            "CancelDate": "2023-10-26 14:28:00"
        },
        "group_id": null,
        "gstin": "29AAFCD5862R000",
        "is_deleted": false,
        "owner_id": null,
        "tag_identifier": null,
        "transaction": {
            "Version": "1.1",
            "Irn": "1641fc014d8b1b5be859f3f90973ab0fb9307566eaf70b7f272838865bdd8ee3",
            "TranDtls": {
                "TaxSch": "GST",
                "RegRev": "Y",
                "SupTyp": "B2B",
                "IgstOnIntra": "N"
            },
            "DocDtls": {
                "Typ": "INV",
                "No": "WARB2B83",
                "Dt": "10/10/2023"
            },
            "SellerDtls": {
                "Gstin": "29AAFCD5862R000",
                "LglNm": "NIC Company Pvt Ltd",
                "TrdNm": "NIC Industries",
                "Addr1": "5th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "GANDHINAGAR",
                "Pin": 560037,
                "Stcd": "29",
                "Ph": "9000000",
                "Em": "[email protected]"
            },
            "BuyerDtls": {
                "Gstin": "29AAFCD5862R1ZR",
                "LglNm": "XYZ Company Pvt Ltd",
                "TrdNm": "XYZ Industries",
                "Pos": "12",
                "Addr1": "7th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "GANDHINAGAR",
                "Pin": 562160,
                "Stcd": "29",
                "Ph": "91111111111",
                "Em": "[email protected]"
            },
            "ItemList": [
                {
                    "SlNo": "1",
                    "PrdDesc": "Rice",
                    "IsServc": "N",
                    "HsnCd": "710692",
                    "Barcde": "123456",
                    "Qty": 0.200,
                    "Unit": "BAG",
                    "UnitPrice": 100.000,
                    "TotAmt": 20.00,
                    "AssAmt": 20.00,
                    "GstRt": 18.00,
                    "IgstAmt": 3.60,
                    "CgstAmt": 0.00,
                    "SgstAmt": 0.00,
                    "TotItemVal": 23.60
                }
            ],
            "ValDtls": {
                "AssVal": 20.00,
                "CgstVal": 0.00,
                "SgstVal": 0.00,
                "IgstVal": 3.60,
                "TotInvVal": 23.60,
                "TotInvValFc": 12897.70
            }
        },
        "transaction_id": "29AAFCD5862R000_WARB2B83_INV_2023",
        "transaction_metadata": null
    }
]

Response - Failure:

HTTP Status Code : 200 OK

[
    {
        "custom_fields": null,
        "deleted": false,
        "document_status": "IRN_CANCELLATION_FAILED",
        "error_response": null,
        "errors": null,
        "govt_response": {
            "Success": "N",
            "ErrorDetails": [
                {
                    "error_code": "USER_INPUT_EXCEPTION",
                    "error_message": "E-Invoice with the IRN not present with our datastore",
                    "error_source": "CLEARTAX"
                }
            ]
        },
        "group_id": null,
        "gstin": "29AAFCD5862R000",
        "is_deleted": false,
        "owner_id": null,
        "tag_identifier": null,
        "transaction": null,
        "transaction_id": null,
        "transaction_metadata": null
    }
]

API Validations

  1. IRN should be present in the ClearTax database.

  2. IRN cannot be cancelled, if the Valid/Active E-way Bill exists for the same.

  3. Cancellation can be done by active or suspended taxpayers.

API Constraints

  1. Maximum of 5 IRNs can be cancelled in one API call.

  2. IRN can be cancelled within 24 hours from its time of generation.

PreviousGenerate IRNNextGet E-Invoice PDF

Last updated

Was this helpful?