Update E-Waybill Part-B
You can update an PART-B of EWB by sending a POST
request to E-Invoicing API with the following request headers.
Request Method
POST
Request URL
Request Headers
X-Cleartax-Auth-Token
Header
String
gstin
Header
String
Mandatory. GSTIN number for the user
Request Path Params
There are no path parameters for this API.
Request Query Params
action
String
NA
Mandatory = PARTB
Request Body
EwbNumber
Number
12 Digits
Mandatory. E-Way Bill Number
VehNo
Number
15 Digits
Conditional. Vehicle Number
FromPlace
String
12 Characters
Mandatory. From Place
FromState
Number
2 Digits
Mandatory. From State Code
ReasonCode
Enum
"BREAKDOWN", "TRANSSHIPMENT", "OTHERS", "FIRST_TIME".
Mandatory,Reasons to update EWB
ReasonRemark
String
50 Characters
Mandatory. Reason Remark
TransDocNo
String
15 Characters
Conditional. Transport Document Number
TransDocDt
String
dd/mm/yyyy
Optional. Transport Document Date
TransMode
Enum
[ROAD
RAIL
AIR
SHIP
IN_TRANSIT]
Mandatory. Transport Mode
VehType
Enum
[Regular
ODC]
Optional. Vehicle Type
Response Status Codes
200
For a successfully processed request (may be a success or validation error).
400
Bad Request. Invalid JSON
401
If the user is not authenticated for the operation.
403
If the user is not authorised for the operation.
500
If there are any unhandled exceptions on the Clear side.
Response Schema
EwbNumber
Number
12 Digits
E-Way Bill number
UpdatedDate
String
NA
Date and time of update. This will be null in case of failure.
ValidUpto
String
NA
Date and time of upto which EWB is valid. This will be null in case of failure.
errors
List
NA
This will be null if there will be no error.
Errors Object
error_code
Number
NA
Error Code. If there is no error, then this field will not be present.
error_message
String
NA
Error message. If there is no error, then this field will not be present.
error_source
String
NA
Error Source. If there is no error, then this field will not be present.
Sample Request and Response
Request
Response - Success
HTTP Status Code - 200
Response - Failure
HTTP Status Code - 200
API Validations
Currently there are no known validations for this API.
API Constraints
Part-B can be updated by the generator of the e-way bill, if there is no transporter, or by the assigned transporter
Part-B can be updated only if the e-way bill is active, that is, not cancelled
Part-B can be updated only if the e-way bill is within the validity period, that is, validity is not expired.
If vehicle is passed, the format of the vehicle number should be valid and as per the format
In case of road as a transportation mode, the vehicle number should be passed and transport document number is optional
In case of rail, air or ship as a transportation mode, the transport document number is must
Last updated
Was this helpful?