Get E-way Bill Details by IRN#
Given an E-invoice IRN number, you can get it’s E-way bill details using this API.
Route
/basic/einv/{flynn-version}/{irp}/eiewb/{e-invoice-api-version}/ewaybill/irn/{irn_no}
- active ‘flynn-version’: v1.0
- method: GET
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 (ni1, ni2) |
e-invoice-api-version | E-invoice API version | string |
irn_no | E-invoice number | 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 value for the header key accept
is application/json
.
Also, since no request body is sent, header key Content-type
is optional.
Response#
200
:#
Successful response will be the same payload as per the ‘E-Invoice API Documentation’ published by NIC.
Sample Response Body
{
"data": "{\"EwbNo\":611009719079,\"Status\":\"ACT\",\"GenGstin\":\"24AAAPI3182M002\",\"EwbDt\":\"2020-10-26 18:21:00\",\"EwbValidTill\":\"2020-10-27 23:59:00\"}\"}"
}
404
:#
When the E-way bill isn’t found.
Sample Response Body
{
"error": {
"message": "err-resource-not-found",
"type": "ResourceNotFound",
"args": {
"ewb-number": "ABCD"
}
}
}
Other e-invoice errors are mentioned under common errors.
Notes#
IRP - nic is deprecated. Instead of it please use ni1 or ni2