This API is used for cancelling an e-Invoice within stipulated time by passing the IRN.
The format and details of Cancellation of IRN API request is depicted in following table.
URL | <URL>/api/Cancel |
---|---|
Content-Type |
application/json |
Method |
POST |
Attributes | Description |
---|---|
client_id | client id to be provided by E-Invoice System |
client_secret |
client secret to be provided by E-Invoice System |
Gstin |
GSTIN of the authenticated user |
sup_gstin |
(Optional) Supplier GSTIN, only in case E Comm. operator is cancelling the IRN |
irp |
(Optional, Required for criss-cross operations) If operations on IRNs to be performed at eInvoice 1 System on IRNs generated at eInvoice 2 System,’NIC2’ has to be passed and If operations on IRNs to be performed at eInvoice 2 System on IRNs generated at eInvoice 1 System, ‘NIC1’ has to be passed. |
user_name |
User name of the authenticated user |
AuthToken |
Authentication token returned by the E-Invoice system |
Attributes | Description |
---|---|
Data | encoded string of encrypted Cancel e-invoice JSON using Sek. |
Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Status | Status of the Cancel IRN request(values 1-Success and 0- Failure) | ||||||||||
Data | If Status is ‘1’ | ||||||||||
InfoDtls | Any additional message to be conveyed would be passed. | ||||||||||
ErrorDetails | If Status is ‘0’ | ||||||||||
If Status is "1"
|
|||||||||||
If Status is "0"
|
Cancel IRN Request
JSON corresponds to the "Data" element of Cancel E-Invoice Request above
JSON (corresponds to the data element of Cancelled e-Invoice Response(Success))
JSON(in case of error)
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "Irn": { "type": "string", "minLength": 64, "maxLength": 64, "description": "Invoice Reference Number" }, "CnlRsn": { "type": "string", "minLength": 1, "maxLength": 1, "enum": ["1", "2", "3", "4"], "description": "Cancel Reason 1- Duplicate, 2 - Data entry mistake, 3- Order Cancelled, 4 - Others" }, "CnlRem": { "type": "string", "minLength": 0, "maxLength": 100, "description": "Cancel Remarks" }, "required": [ "Irn", "CnlRsn" ] } }
Content will be updated shortly.