Cancel E-way Bill#
Available only in sandbox.
This API is Deprecated. Please use VERSION TWO OH (v2.0)
Cancel EWB via IRN offers single EWB cancellation as opposed to its enriched counterpart.
Route
/basic/einv/{flynn-version}/{irp}/{e-invoice-api-version}/ewayapi/cancel
- active ‘flynn-version’: v1.0
- method: POST
URL Parameters#
Name | Description | Type |
---|---|---|
flynn-version | version of the API for example, v1.0 |
string |
irp | IRP Provider as per GST registration for e-invoicing | enum (nic) |
e-invoice-api-version | E-invoice API version | string |
Headers#
All headers as mentioned in the Basic E-Invoice API introduction.
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
{
"ewbNo": 161001728242,
"cancelRsnCode": 2,
"cancelRmrk": "Cancelled the order"
}
Response#
200
:#
Successful response will have the cancelled e-way bill entry in “data” attribute as a String
.
Sample response body
{
"data": "{\"ewayBillNo\":\"161001728242\",\"cancelDate\":\"03/08/2020 12:22:00 PM\"}"
}
E-invoice errors are mentioned under common errors.