Generate/Regenerate Consolidated EWB

You can generate a consolidated EWB by sending a POST request to E-Invoicing API with the following request headers.

Request URL

POST: {{HOST}}/einv/v1/consolidate-ewaybill/generate?action={{action}}

Request Headers

x-cleartax-auth-token: {{USER_AUTH_TOKEN}}
gstin:{{gstin_number}}

PARAMETER	PARAM TYPE	TYPE	DESCRIPTION
X-Cleartax-Auth-Token	Header	String	Mandatory. The auth token generated from ClearTax user id and password. Know how.
gstin	Header	String	Mandatory. GSTIN number for the user
action	Query	String	Mandatory. value = GENERATE_CONSOLIDATED_EWB/REGENERATE_CONSOLIDATED_EWB

Request Parameters

GENERATE CONSOLIDATED BILLS

PARAMETER	DESCRIPTION	DATA TYPE	GENERATE CONSOLIDATED BILLS
VehNo	Vehicle Number	String(min= 7, max = 15)	Conditional
FromPlace	From Place	String(max = 50)	Mandatory
FromState	From State Code	Number(max = 2)	Mandatory
ReasonCode	Reason Code	BREAKDOWN TRANSSHIPMENT OTHERS FIRST_TIME NATURAL_CALAMITY LAW_ORDER_SITUATION ACCIDENT	Not Required
ReasonRemark	Reason Remark	String(max = 50)	Not Required
TransDocNo	Transport Document Number	String(max = 15)	Conditional
TransDocDt	Transport Doucment Date	String(dd/mm/yyyy)	Optional
TransMode	Transport Mode	ROAD RAIL AIR SHIP IN_TRANSIT	Mandatory
EwbNumbers	Consolidate E-Way Bills	List	Mandatory
ConsolidatedEwbNumber	Consolidated E-Way Number	Number(max = 12)	Not Required

REGENERATE CONSOLIDATED BILLS

PARAMETER	DESCRIPTION	DATA TYPE	REGENERATED CONSOLIDATED BILLS
VehNo	Vehicle Number	String(min= 7, max = 15)	Conditional
FromPlace	From Place	String(max = 50)	Mandatory
FromState	From State Code	Number(max = 2)	Mandatory
ReasonCode	Reason Code	BREAKDOWN TRANSSHIPMENT OTHERS FIRST_TIME NATURAL_CALAMITY LAW_ORDER_SITUATION ACCIDENT	Mandatory
ReasonRemark	Reason Remark	String(max = 50)	Mandatory
TransDocNo	Transport Document Number	String(max = 15)	Conditional
TransDocDt	Transport Doucment Date	String(dd/mm/yyyy)	Optional
TransMode	Transport Mode	ROAD RAIL AIR SHIP IN_TRANSIT	Mandatory
EwbNumbers	Consolidate E-Way Bills	List	Not Required
ConsolidatedEwbNumber	Consolidated E-Way Number	Number(max = 12)	Mandatory

Sample Request

{
    "VehNo": "KA12AB123",
    "FromPlace": "BANGALORE SOUTH",
    "FromState": 29,
    "TransDocNo": "1234",
    "TransDocDt": "12/10/2017",
    "TransMode": "AIR",
    "EwbNumbers": [
        181009088610,
        171009088617
    ]
}

Sample Response

JSON Response - SUCCESS

{
  "ConsolidatedEwbNumber": "1810000387",
  "EwbNumbers": ["111000609282", "181000609270"],
  "ConsolidateEwbDate": "15/12/2017 10:27:00 AM"
}

JSON Response - FAILURE

{
  "errors": {
    "error_code": "7001",
    "error_message": "Invalid Vehicle Number, Vehicle number length should be between 7 and 15 ",
    "error_source": "CLEARTAX"
  }
}