Get E-Waybills
You can use this API to get the complete details of the E-way bill from our database. Also, details of E-way bills generated by 3rd party can also be fetched from our database by-passing the right parameters.
Request Method
GET
Request URL
{{HOST}}/einv/ewaybillsRequest Headers
| Parameter | Data Type | Field Validation | Description |
|---|---|---|---|
x-cleartax-auth-token | String | NA | Mandatory. User auth token. |
gstin | String | NA | Mandatory. GSTIN number for the user |
Request Path Params
There are no path parameters for this API.
Request Query Params
| PARAMETER | Data Type | Field Validations | DESCRIPTION |
|---|---|---|---|
pullFilterType | String | NA | EWB_BY_ME, EWB_FOR_MY_GSTIN, EWB_FOR_TRANSPORTATION |
start_date | String | NA Accepted format: YY-MM-DD | Start date by which you need to filter |
end_date | String | NA Accepted format: YY-MM-DD | End date by which you need to filter |
start | String | NA | Default: 0 /used for pagination |
limit | String | NA | Default: 100 / number of invoices to limit in the response |
seller_gstin | String | NA | Seller GSTIN number |
buyer_gstin | String | NA | Buyer GSTIN number |
ewb_numbers | String | NA | Eway Bill number |
ewb_status | String | NA | PENDING, PART_A, GENERATED, CANCELLED |
document_numbers | String | NA | Document Number |
document_type | String | NA | Document Type |
document_date | String | NA | Document Date |
transporter_gstins | String | NA | Transporter GSTIN |
vehicleNumbers | String | NA | Vehicle number |
min_distance | String | NA | Minimum distance |
max_distance | String | NA | Maximum distance |
Request Body
There will be no request body for this API.
Response Status Codes
| HTTP Status Code | Description |
|---|---|
200 | For a successfully processed request (may be a success or validation error). |
401 | If the user is not authenticated for the operation. |
403 | If the user is not authorized for the operation. |
500 | If there are any unhandled exceptions on Clear side. |
Sample Response
[
{
"ignored_warnings": null,
"owner": null,
"id": "141009551909",
"transaction_date": "02/02/2022",
"return_period": null,
"source": "USER",
"total_taxable_val": 67796.61,
"total_cgst_val": 0.0,
"total_sgst_val": 0.0,
"total_igst_val": 12203.39,
"total_cess_val": 0.0,
"discount_type": null,
"total_val": 80000.0,
"tags": null,
"gst_status": null,
"gst_validation_errors": null,
"place_of_supply": "GUJARAT",
"updated_at": null,
"user_updated_at": null,
"is_canceled": false,
"created_at": null,
"cancel_reason": null,
"cancel_remarks": null,
"seller_contact_id": null,
"consignee_contact_id": null,
"receiver_contact_id": null,
"bank_details": null,
"custom_fields": null,
"branch_id": null,
"document_number": "testotherewb3",
"type": "SALE",
"seller": {
"name": null,
"gstin": "29AAFCD5862R000",
"address1": "TEST TEST",
"address2": "TEST TEST TEST",
"city": "560007",
"state": "KARNATAKA",
"zip_code": "560007",
"country": null,
"phone_number": null
},
"receiver": {
"name": "sana kumari",
"gstin": "24AAFCD5862R005",
"address1": null,
"address2": null,
"city": null,
"state": "GUJARAT",
"zip_code": null,
"country": null,
"phone_number": null
},
"consignee": {
"name": "sana kumari",
"gstin": "24AAFCD5862R005",
"address1": "Z-5, raja garden,uttam nagar",
"address2": "NA",
"city": "Delhi",
"state": "GUJARAT",
"zip_code": "360001",
"country": null,
"phone_number": null
},
"ewb_number": "141009551909",
"irn": null,
"ewb_generated_date": "02-02-2022 20:19:00",
"ewb_valid_from_date": "02-02-2022 20:19:00",
"ewb_due_date": "11-02-2022 23:59:00",
"ewb_govt_sync_status": "COMPLETE",
"other_val": 0.0,
"total_cess_non_advol_val": 0.0,
"is_multi_vehicle": false,
"schedule_date": null,
"transporter_history_dtos": null,
"ewb_status": "GENERATED",
"document_type": "INV",
"transport_mode": "ROAD",
"transporter_gstin": "29AAFCD5862R000",
"transporter_name": "XYZ EXPORTS",
"transporter_from_place": "560007",
"transporter_from_state": "KARNATAKA",
"transport_doc_number": "DOC01",
"transport_date": "02/02/2022",
"vehicle_number": "KA123456",
"vehicle_type": "REGULAR",
"update_reason": null,
"update_remarks": null,
"extend_validity_reason": null,
"extend_validity_remarks": null,
"sub_supply": "SUPPLY",
"ewb_errors": null,
"cewb_number": "0",
"distance": 1687,
"remaining_distance": null,
"extended_date": null,
"dispatch_from_state": "KARNATAKA",
"nic_ewb_status": "ACTIVE",
"export_type": null,
"generation_interaction_type": "API",
"sub_supply_desc": null,
"transaction_type": "Regular",
"from_pincode": "560007",
"consignment_status": null,
"transit_type": null,
"line_items": [
{
"item_code": null,
"gst_code": "85167200",
"gst_type": "GOODS",
"description": null,
"notes": null,
"unit_price": null,
"unit_price_including_tax": null,
"unit_of_measurement": "PCS",
"item_id": "0",
"serial_number": 1,
"quantity": 1.000,
"discount_rate": null,
"discount": null,
"taxable_val": 67796.61,
"cgst_rate": 0.00,
"cgst_val": null,
"sgst_rate": 0.00,
"sgst_val": null,
"igst_rate": 18.00,
"igst_val": null,
"cess_rate": 0.00,
"cess_val": null,
"total_val": null,
"tags": null,
"cess_non_advol_rate": null,
"cess_non_advol_val": 0.0,
"tcs_val": null
}
],
"transporter_code": null,
"owned_by": null,
"owner_gstin": null,
"branch_name": null,
"active": true,
"version_num": null
},
{
"ignored_warnings": null,
"owner": null,
"id": "101009551907",
"transaction_date": "02/02/2022",
"return_period": null,
"source": "USER",
"total_taxable_val": 67796.61,
"total_cgst_val": 0.0,
"total_sgst_val": 0.0,
"total_igst_val": 12203.39,
"total_cess_val": 0.0,
"discount_type": null,
"total_val": 80000.0,
"tags": null,
"gst_status": null,
"gst_validation_errors": null,
"place_of_supply": "GUJARAT",
"updated_at": null,
"user_updated_at": null,
"is_canceled": false,
"created_at": null,
"cancel_reason": null,
"cancel_remarks": null,
"seller_contact_id": null,
"consignee_contact_id": null,
"receiver_contact_id": null,
"bank_details": null,
"custom_fields": null,
"branch_id": null,
"document_number": "testotherewb1",
"type": "SALE",
"seller": {
"name": null,
"gstin": "29AAFCD5862R000",
"address1": "TEST TEST",
"address2": "TEST TEST TEST",
"city": "560007",
"state": "KARNATAKA",
"zip_code": "560007",
"country": null,
"phone_number": null
},
"receiver": {
"name": "sana kumari",
"gstin": "24AAFCD5862R005",
"address1": null,
"address2": null,
"city": null,
"state": "GUJARAT",
"zip_code": null,
"country": null,
"phone_number": null
},
"consignee": {
"name": "sana kumari",
"gstin": "24AAFCD5862R005",
"address1": "Z-5, raja garden,uttam nagar",
"address2": "NA",
"city": "Delhi",
"state": "GUJARAT",
"zip_code": "360001",
"country": null,
"phone_number": null
},
"ewb_number": "101009551907",
"irn": null,
"ewb_generated_date": "02-02-2022 20:12:00",
"ewb_valid_from_date": "02-02-2022 20:12:00",
"ewb_due_date": "11-02-2022 23:59:00",
"ewb_govt_sync_status": "COMPLETE",
"other_val": 0.0,
"total_cess_non_advol_val": 0.0,
"is_multi_vehicle": false,
"schedule_date": null,
"transporter_history_dtos": null,
"ewb_status": "GENERATED",
"document_type": "INV",
"transport_mode": "ROAD",
"transporter_gstin": "29AAACW1988L1ZM",
"transporter_name": "XYZ EXPORTS",
"transporter_from_place": "560007",
"transporter_from_state": "KARNATAKA",
"transport_doc_number": "DOC01",
"transport_date": "02/02/2022",
"vehicle_number": "KA123456",
"vehicle_type": "REGULAR",
"update_reason": null,
"update_remarks": null,
"extend_validity_reason": null,
"extend_validity_remarks": null,
"sub_supply": "SUPPLY",
"ewb_errors": null,
"cewb_number": "0",
"distance": 1687,
"remaining_distance": null,
"extended_date": null,
"dispatch_from_state": "KARNATAKA",
"nic_ewb_status": "ACTIVE",
"export_type": null,
"generation_interaction_type": "API",
"sub_supply_desc": null,
"transaction_type": "Regular",
"from_pincode": "560007",
"consignment_status": null,
"transit_type": null,
"line_items": [
{
"item_code": null,
"gst_code": "85167200",
"gst_type": "GOODS",
"description": null,
"notes": null,
"unit_price": null,
"unit_price_including_tax": null,
"unit_of_measurement": "PCS",
"item_id": "0",
"serial_number": 1,
"quantity": 1.000,
"discount_rate": null,
"discount": null,
"taxable_val": 67796.61,
"cgst_rate": 0.00,
"cgst_val": null,
"sgst_rate": 0.00,
"sgst_val": null,
"igst_rate": 18.00,
"igst_val": null,
"cess_rate": 0.00,
"cess_val": null,
"total_val": null,
"tags": null,
"cess_non_advol_rate": null,
"cess_non_advol_val": 0.0,
"tcs_val": null
}
],
"transporter_code": null,
"owned_by": null,
"owner_gstin": null,
"branch_name": null,
"active": true,
"version_num": null
},
{
"ignored_warnings": null,
"owner": null,
"id": "131009551906",
"transaction_date": "02/02/2022",
"return_period": null,
"source": "USER",
"total_taxable_val": 67796.61,
"total_cgst_val": 0.0,
"total_sgst_val": 0.0,
"total_igst_val": 12203.39,
"total_cess_val": 0.0,
"discount_type": null,
"total_val": 80000.0,
"tags": null,
"gst_status": null,
"gst_validation_errors": null,
"place_of_supply": "GUJARAT",
"updated_at": null,
"user_updated_at": null,
"is_canceled": false,
"created_at": null,
"cancel_reason": null,
"cancel_remarks": null,
"seller_contact_id": null,
"consignee_contact_id": null,
"receiver_contact_id": null,
"bank_details": null,
"custom_fields": null,
"branch_id": null,
"document_number": "testotherewb",
"type": "SALE",
"seller": {
"name": null,
"gstin": "29AAFCD5862R000",
"address1": "TEST TEST",
"address2": "TEST TEST TEST",
"city": "560007",
"state": "KARNATAKA",
"zip_code": "560007",
"country": null,
"phone_number": null
},
"receiver": {
"name": "sana kumari",
"gstin": "24AAFCD5862R005",
"address1": null,
"address2": null,
"city": null,
"state": "GUJARAT",
"zip_code": null,
"country": null,
"phone_number": null
},
"consignee": {
"name": "sana kumari",
"gstin": "24AAFCD5862R005",
"address1": "Z-5, raja garden,uttam nagar",
"address2": "NA",
"city": "Delhi",
"state": "GUJARAT",
"zip_code": "360001",
"country": null,
"phone_number": null
},
"ewb_number": "131009551906",
"irn": null,
"ewb_generated_date": "02-02-2022 20:10:00",
"ewb_valid_from_date": "02-02-2022 20:10:00",
"ewb_due_date": null,
"ewb_govt_sync_status": "COMPLETE",
"other_val": 0.0,
"total_cess_non_advol_val": 0.0,
"is_multi_vehicle": false,
"schedule_date": null,
"transporter_history_dtos": null,
"ewb_status": "PART_A",
"document_type": "INV",
"transport_mode": null,
"transporter_gstin": "29AAPCS9575E1ZJ",
"transporter_name": "TRANSPORT",
"transporter_from_place": "560007",
"transporter_from_state": "KARNATAKA",
"transport_doc_number": null,
"transport_date": null,
"vehicle_number": null,
"vehicle_type": null,
"update_reason": null,
"update_remarks": null,
"extend_validity_reason": null,
"extend_validity_remarks": null,
"sub_supply": "SUPPLY",
"ewb_errors": null,
"cewb_number": null,
"distance": 1687,
"remaining_distance": null,
"extended_date": null,
"dispatch_from_state": "KARNATAKA",
"nic_ewb_status": "ACTIVE",
"export_type": null,
"generation_interaction_type": "API",
"sub_supply_desc": null,
"transaction_type": "Regular",
"from_pincode": "560007",
"consignment_status": null,
"transit_type": null,
"line_items": [
{
"item_code": null,
"gst_code": "85167200",
"gst_type": "GOODS",
"description": null,
"notes": null,
"unit_price": null,
"unit_price_including_tax": null,
"unit_of_measurement": "PCS",
"item_id": "0",
"serial_number": 1,
"quantity": 1.000,
"discount_rate": null,
"discount": null,
"taxable_val": 67796.61,
"cgst_rate": 0.00,
"cgst_val": null,
"sgst_rate": 0.00,
"sgst_val": null,
"igst_rate": 18.00,
"igst_val": null,
"cess_rate": 0.00,
"cess_val": null,
"total_val": null,
"tags": null,
"cess_non_advol_rate": null,
"cess_non_advol_val": 0.0,
"tcs_val": null
}
],
"transporter_code": null,
"owned_by": null,
"owner_gstin": null,
"branch_name": null,
"active": false,
"version_num": null
},
{
"ignored_warnings": null,
"owner": null,
"id": "161009551905",
"transaction_date": "12/12/2020",
"return_period": null,
"source": "USER",
"total_taxable_val": 0.0,
"total_cgst_val": 0.0,
"total_sgst_val": 0.0,
"total_igst_val": 0.0,
"total_cess_val": 0.0,
"discount_type": null,
"total_val": 0.0,
"tags": null,
"gst_status": null,
"gst_validation_errors": null,
"place_of_supply": "KARNATAKA",
"updated_at": null,
"user_updated_at": null,
"is_canceled": false,
"created_at": null,
"cancel_reason": null,
"cancel_remarks": null,
"seller_contact_id": null,
"consignee_contact_id": null,
"receiver_contact_id": null,
"bank_details": null,
"custom_fields": null,
"branch_id": null,
"document_number": "upload01",
"type": "SALE",
"seller": {
"name": null,
"gstin": "29AAFCD5862R000",
"address1": "2ND CROSS NO 59 19 A",
"address2": "GROUND FLOOR OSBORNE ROAD",
"city": "FRAZER TOWN",
"state": "KARNATAKA",
"zip_code": "560035",
"country": null,
"phone_number": null
},
"receiver": {
"name": null,
"gstin": "24AAFCD5862R005",
"address1": null,
"address2": null,
"city": null,
"state": "KARNATAKA",
"zip_code": null,
"country": null,
"phone_number": null
},
"consignee": {
"name": null,
"gstin": "24AAFCD5862R005",
"address1": "Shree Nilaya",
"address2": "Dasarahosahalli",
"city": "Beml Nagar",
"state": "KARNATAKA",
"zip_code": "560076",
"country": null,
"phone_number": null
},
"ewb_number": "161009551905",
"irn": null,
"ewb_generated_date": "02-02-2022 20:00:00",
"ewb_valid_from_date": "02-02-2022 20:00:00",
"ewb_due_date": "03-02-2022 23:59:00",
"ewb_govt_sync_status": "COMPLETE",
"other_val": 0.0,
"total_cess_non_advol_val": 0.0,
"is_multi_vehicle": false,
"schedule_date": null,
"transporter_history_dtos": null,
"ewb_status": "GENERATED",
"document_type": "INV",
"transport_mode": "ROAD",
"transporter_gstin": "27AADCC6515E1ZX",
"transporter_name": "Cyberplat India Private Ltd",
"transporter_from_place": "FRAZER TOWN",
"transporter_from_state": "KARNATAKA",
"transport_doc_number": "F444444",
"transport_date": "03/03/2021",
"vehicle_number": "PVC1234",
"vehicle_type": "REGULAR",
"update_reason": null,
"update_remarks": null,
"extend_validity_reason": null,
"extend_validity_remarks": null,
"sub_supply": "SUPPLY",
"ewb_errors": null,
"cewb_number": "0",
"distance": 16,
"remaining_distance": null,
"extended_date": null,
"dispatch_from_state": "KARNATAKA",
"nic_ewb_status": "ACTIVE",
"export_type": null,
"generation_interaction_type": "API",
"sub_supply_desc": null,
"transaction_type": "Regular",
"from_pincode": "560035",
"consignment_status": null,
"transit_type": null,
"line_items": [
{
"item_code": null,
"gst_code": "1001",
"gst_type": "GOODS",
"description": "Wheat",
"notes": null,
"unit_price": null,
"unit_price_including_tax": null,
"unit_of_measurement": "BOX",
"item_id": "0",
"serial_number": 1,
"quantity": 4.000,
"discount_rate": null,
"discount": null,
"taxable_val": 0.0,
"cgst_rate": 14.00,
"cgst_val": null,
"sgst_rate": 14.00,
"sgst_val": null,
"igst_rate": 0.00,
"igst_val": null,
"cess_rate": 0.00,
"cess_val": null,
"total_val": null,
"tags": null,
"cess_non_advol_rate": null,
"cess_non_advol_val": 0.0,
"tcs_val": null
}
],
"transporter_code": null,
"owned_by": null,
"owner_gstin": null,
"branch_name": null,
"active": false,
"version_num": null
}
][]API Validations
Currently there are no known validations.
API Constraints
The user should have a EWB present in Clear database.
Last updated