Regenerate Consolidated E Way Bill

Overview

Sequence Diagram

The format and details of a Regeneration of Consolidated E-Way bill API request is depicted in following table.

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

Request Payload

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	REGENTRIPSHEET	REGENTRIPSHEET
Encrypt(Base64(Request JSON),sek)	Regeneration of 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 Update Transporter Json string. The response will have updated date if successfully updated. Otherwise the response will have error codes.

Sample JSON (Request)

Regenerate Consolidated E- Way Bill Request

{
  "action":"REGENTRIPSHEET",
  "data":"3AKV9paJsZrOTCbbWh5wQYjcCxzpFVirDbZNUt/5IyIM2JtIdGxoZbR/RVaqiCHlAmj08CK/
  NCIHT9MlFV0/ETSGqrBoTvefQJcuLnG8qL3OA2+qM6e6gBqc2giGbTDRQZMzcIyVDH3oQfuY1BIKlb6
  rm7ZY1LKPM3Rnku9Sllz/qqIDK6alffclJoPF+P05HoewXf01VgBQAgP8aN5FsJ2BoPC++gae2zq5KA
  tYfJlHKyhLFxU7zm83K0fdTVU/gIC35J1UIS0UuF6Zw+vbOA=="
}

“data” JSON corresponds to the data element of Regeneration of Consolidated E-Way Bill Request above

{
  "tripSheetNo": 1710001952,
  "vehicleNo": "PQR1234",
  "fromPlace":"Bengaluru",
  "fromState":29,
  "transDocNo": "1234",
  "transDocDate": "26/04/2018",
  "transMode": "1",
  "reasonCode":1,
  "reasonRem":"Flood"
}

Sample JSON (Response)

Regenerate Consolidated E-Way Bill Response

{
  "status":"1",
  "data":"6EIsamkmutKEw7o4iNNVOARZyD5fgbaZXH3XT18DkVYzXsUxtJbaO2Xy2em2
  "re1tcdnlY6RrAo+J3pbSWtNz1lvcG7GqK7UJzIjF5TrCnoxoo8byaYNv/6l1GUMR4ho8
  "tQpBDQEgu/mPjkk91LV6GxYYOyM2SLAQHvq3i7mtqLs="
}

“data” JSON corresponds to the data element of Regenerate Consolidated E-Way Bill Response(Success) above.

{
  "tripSheetNo":1410001953,
  "tripSheetEwayBills":[
  {"ewbNo":161000843009},
  {"ewbNo":171000842926}
]
}

JSON(in case of error)

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

JSON Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
  "tripSheetNo": {
   "type": "number",
   "description":"TripSheetNo Number"
  },

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

  "fromPlace": {
   "type": "string",
   "maxLength": 50,
   "description":"From Place"
  },

  "fromState": {
   "type": "integer",
   "maximum": 99,
  "description":"From State"
  },

  "reasonCode": {
   "type": "string",
   "maxLength": 1,
   "minLength": 1,
   "description":"Reason Code"
  },

  "reasonRem": {
   "type": "string",
   "maxLength": 50,
   "description":"Remarks"
  },

  "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"
   },

  "transMode": {
   "type": "string",
   "description":"Transport Mode"
  }
  },"required":[

   "fromPlace",
   "fromState",
   "reasonCode",
   "reasonRem",
   "transMode",
   "tripSheetNo"
   ]
}

Data Structure

Parameter Name	Type	Description	Values	Sample Data	Allowed character
tripSheetNo	Number(10)	Consolidated E-Way Bill No (TripSheet No)		1310006768	Numbers
vehicleNo	Text(15)	Vehicle number		BANGALORE SOUTH	Alpha-numeric
fromPlace	Number(50)	Current Place	Refer Code list	Bangalore	Numbers
fromState	Number(2)	Current State	Refer Code list	29	Numbers
reasonCode	Number(2)	Reason code for Regeneration of Consolidated E-Way Bill	Refer Code list	2	Numbers
reasonRem	Text(50)	Reason for Regeneration of Consolidated E-Way Bill		Vehicle details updated	Alpha-numeric
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	12/09/2017

Validations

CEWB can be re-generated by the generator of that CEWB or the current transporter.
Re-generate CEWB considers only the e-way bills which are active, that is, not cancelled.
Re-generate CEWB considers only the e-way bills which are within the 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.