Skip to main content
POST

​
NIC validations

  1. IRN can be cancelled within 24 hours of IRN generation.
  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.
  4. If e-commerce wants to Get the RCM Invoice details, in the headers the supplier GSTIN value should be the Recipient GSTIN.

​
Request body schema

View request body schema

Authorizations

​
authorization
string
header
required

E-invoice taxpayer access token returned by Authenticate.

​
x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

​
x-source
enum<string>
default:primary

NIC server for the session used by this request. primary selects NIC1. secondary selects NIC2. Defaults to primary. See NIC1 and NIC2 routing.

Available options:
primary,
secondary
Example:

"primary"

​
x-proxy
enum<string>

NIC server that receives the request. If omitted, the request goes to the server selected by x-source. When specified, selects the other server. See NIC1 and NIC2 routing.

Available options:
primary,
secondary
Example:

"secondary"

​
x-api-version
string
default:1.0.0

API version

Path Parameters

​
irn
string
required

Query Parameters

​
supplier_gstin
string

Supplier GSTIN when an e-commerce operator acts on behalf of the supplier. For reverse charge mechanism (RCM) invoices, this is the recipient GSTIN.

Body

application/json
​
Irn
string
required

Invoice Reference Number

Required string length: 64
​
CnlRsn
enum<string>
required

Cancel Reason 1- Duplicate, 2 - Data entry mistake, 3- Order Cancelled, 4 - Others

Available options:
1,
2,
3,
4
Required string length: 1
​
CnlRem
string

Cancel Remarks

Maximum string length: 100

Response

200 - application/json

200 IRN cancelled / 9999 IRN is not active / 2270 More than 24 hrs old / 2230 IRN cannot be cancelled as EWB is active / 2143 IRN doesn't belong to user

A successful NIC response or a NIC business-error response. Both variants use HTTP 200.

​
code
enum<integer>
required

HTTP-compatible Sandbox response code.

Available options:
200
​
timestamp
integer<int64>
required

Unix timestamp in milliseconds.

​
transaction_id
string
required

Request transaction identifier.

​
data
object
required