GENERATE CONSOLIDATED EWAYBILL

Overview

Sequence Diagram

URL	<URL>/ewayapi/
Content-Type	application/json
Method	POST

Request Header

Attributes	Description
client-id	clientid to be provided by E-WAY BILL SYSTEM
client-secret	Secret to be provided by E-WAY BILL SYSTEM
Gstin	GSTIN of Requester(Tax payer or Transporter)
Authtoken	Authentication token returned by the E-way bill system

Request Payload

Attributes	Description
action		GENCEWB
Encrypt(Base64(Request JSON),sek)	Consolidated E-way bill JSON string

Response Payload

Attributes	Description	Value
status	Status of request	1-Success ; 0-Error
Encrypt(Base64(Response JSON),sek)	Response of Consolidated E-way bill JSON string. The response will have consolidated eway bill number and generated date if it is successfully generated. Otherwise the response will have error codes

Sample JSON (Request)

Generate Consolidated E-WAY BILL Request

{ "action":"GENCEWB",
"data":"ew0KICANCiAgImZyb21QbGFjZSI6ICJCQU5HQUxPUkUgU09VVEgiLA0KICAiZnJvbVN0YXRlIjogIjI5Ii,
wNCiAgInZlaGljbGVObyI6ICJLQTEyQUIxMjM0IiwNCiAgInRyYW5zTW9kZSI6ICIxIiwNCiAgInVzZXJHc3RpbiI6,
ICIyOUFBQUNHMDU2OVAxWjMiLA0KICAidXNlcklkIjogIkFNQlVKQU5FMzIiLA0KICAidHJpcFNoZWV0RXdiQmlsbHMiOiBbDQ,
ogICAgew0KICAgICAgImV3Yk5vIjogMTExMDAwNjA5MjgyDQogICAgfSwNCiAgICB7DQogICAg,
ICAiZXdiTm8iOiAxODEwMDA2MDkyNzANCiAgICB9DQogIF0NCn0="
}

“data” JSON (corresponds to the data element of Generate Consolidated E-WAY BILL Request)

{
"fromPlace":"BANGALORE SOUTH",
"fromState":29,
"vehicleNo":"KA12AB1234",
"transMode":"1",
"transDocNo":"1234",
"transDocDate":"12/10/2017",
"tripSheetEwbBills":[
{ "ewbNo":"111000609282" },
{ "ewbNo":"181000609270" }
] }

Sample JSON (Response)

Generate Consolidated E-WAY BILL Response

{
"status":"1",
"data":"ew0KImNFd2JObyI6IjE4MTAwMDAzODciLA0KImNFV0JEYXRlIjoiMTUvMTIvMjAxNyAxMDoyNzowMCBBTSINCn0NCg0K"
}

“data” JSON corresponds to the data element of Generate Consolidated EWB Response(Success) above

{
"cEwbNo":"1810000387",
"cEWBDate":"15/12/2017 10:27:00 AM"
}

JSON(in case of error)

{
"status":"0",
"error":{ "errorCodes":240 }
}

JSON Schema

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"fromPlace": {
"type": "string",
"maxLength": 50,
"description":"From Place"
},

"fromState": {
"type": "number",
"description": "From State"
},

"vehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "Vehicle Number"
},

"transMode": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],

"description": "Transport Mode (Road-1,Rail-2,Air-3,Ship-4)"
},

"transDocNo": {
"type": "string",
"maxLength": 15,
"description": "Transport Document Number"
},

"transDocDate": {
"type": "string",
"pattern": "[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]",
"description": "Transport Document Date"
},

"tripSheetEwbBills": {
"type": "array",
"items": [
{

"type": "object",
"properties": {
"ewbNo": {
"type": "number",
"description": "Ewaybill Number"
}

},
"required": [
"ewbNo"
]
}
]
}
},

"required": [
"fromPlace",
"fromState",
"transMode",
"tripSheetEwbBills"
]

}

Data Structure

Parameter Name	Type	Description	Values	Sample Data	Allowed character
vehicleNo	Text(15)	vehicle number		KA12AP1235	Alpha-numeric
fromPlace	Text(50)	from place of consignor		Rajasthan	Alphabetic
transMode	Number(3)	Mode of Transportation	Refer Code list	2	Number
transDocNo	Text(15)	Transporter Document number		12-86/3	Alphanumeric, -, / If it is more than 15 chars, last 15 chars may be entered
transDocDate	Text	Transporter Document Date	dd/mm/yyyy format	12/09/2017
fromState	Number(2)	State of Consignor	Refer Code list	8
tripSheetEwbBills		List of eway bills
ewbNo	Number(12)	E-way bill Number generated		345654565456	Number

Validations

EWB can be added to the CEWB if the generator of CEWB is a generator or the assigned transporter of the e-way bill.
EWB can be added to the CEWB only if the e-way bill is active, that is, not cancelled.
EWB can be added to the CEWB only if the e-way bill is within validity period, that is validity is not expired.
If vehicle number 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.

Frequently Asked Questions

Content will be updated shortly.