Skip to main content

Generate EWB

Generation of E-Way Bill (EWB) for Indian Business Invoices

Overview

An e-Way Bill (EWB) is required for the movement of goods under the GST framework. You can generate an EWB for an invoice with or without an Invoice Reference Number (IRN), and update its vehicle or transporter details when needed.


Generate EWB without IRN

post /businesses/:urlKey/invoices/:invoice/ewayBill?withoutIrn=true

This endpoint generates an EWB for an existing invoice without an IRN.

Path Params

urlKey - The unique identifier of the business.
invoice - The invoice ID for which the EWB is to be generated.

Headers

NameTypeValue Description
Content-Type *stringapplication/json
Authorization *stringBearer <jwt>

This endpoint does not require a request body.


Update Vehicle Details

patch /businesses/:urlKey/invoices/:invoice/ewaybill/vehicle

This endpoint updates the vehicle details for an EWB and also regenerates the EWB.

PRE-CONDITIONS

The EWB on the invoice must exist (EwbNo must be present), must not be cancelled, and must not be expired (EwbValidTill must be in the future).

Path Params

urlKey - The unique identifier of the business.
invoice - The invoice ID for which the vehicle details are to be updated.

Headers

NameTypeValue Description
Content-Type *stringapplication/json
Authorization *stringBearer <jwt>

Body

NameTypeValue Description
vehicleNumber *stringVehicle number
vehicleType *string (enum)REGULAR, OVERDIMENSIONALCARGO
transportMode *string (enum)ROAD, RAIL, AIR, SHIP
reasonCode *numberNIC reason code: 1 Breakdown, 2 Trans-shipment, 3 Others, 4 First Time
reasonRem *stringReason remarks
transDocNostringOptional transport document number
transDocDatestringOptional transport document date in dd/MM/yyyy format

Update Transporter Details

patch /businesses/:urlKey/invoices/:invoice/ewaybill/transporter

This endpoint updates the transporter details for an EWB and also regenerates the EWB.

PRE-CONDITIONS

The EWB on the invoice must exist (EwbNo must be present), must not be cancelled, and must not be expired (EwbValidTill must be in the future).

Path Params

urlKey - The unique identifier of the business.
invoice - The invoice ID for which the transporter details are to be updated.

Headers

NameTypeValue Description
Content-Type *stringapplication/json
Authorization *stringBearer <jwt>

Body

NameTypeValue Description
transporterId *stringThe GSTIN of the transporter; must be exactly 15 characters
transporterNamestringOptional transporter name