WebhooksOrdersTimesheets & Billing
Order Billing Details Updated
Webhook payload sent when the billing details of an order change.
Order Billing Details Updated Webhook Payload
{
"created_at": "2021-01-01T14:01:00.000000Z",
"recorded_at": "2021-01-01T14:00:00.000000Z",
"device_id": "00112233-4455-6677-8899-AABBCCDDEEFF",
"worker_handle": "Worker-1",
"account_id": "6784e919-7168-4f61-b686-2020f547637f",
"type": "order",
"data": {
"value": "billing_details_updated",
"order_handle": "DGC127092",
"route_handle": "4359cc65-90dd-4b2b-875b-26e6d2eba11d",
"status": "ongoing",
"share_url": "https://trck.at/vr1RNLq",
"billing_details": {
"billable_hours": 10,
"travel_time": 10,
"service_time": 10,
"breaks": [
{
"end_time": "2021-01-01T14:30:00.000Z",
"id": "28315a00-2ee9-4477-bd77-37dc096a8f49",
"start_time": "2021-01-01T14:20:00.000Z"
}
]
},
"metadata": {
"storeId": "123490809808",
"customerName": "Andrew"
}
},
"version": "3.0.0"
}| Name | Type | Mandatory | Description |
|---|---|---|---|
| data.value | string | Yes | billing_details_updated |
| data.order_handle | string | Yes | Unique handle for the Order |
| data.route_handle | string | Yes | Unique identifier of the route containing the order |
| data.status | string | Yes | Status of the order - ongoing |
| data.share_url | string | Yes | Contains tracking url of the order to provide real time visibility of worker on route of this order |
| data.metadata | object | No | Metadata that you have assigned to this order |
| data.billing_details | object | Yes | Billing Details |
| data.billing_details.billable_hours | float | No | Total billable hours computed for the order. |
| data.billing_details.travel_time | integer | No | Time spent traveling to the order destination. |
| data.billing_details.service_time | integer | No | Time spent servicing the order. |
| data.billing_details.breaks | object | No | List of breaks observed during the order. |
| data.billing_details.breaks.id | string | Unique identifier for the break | |
| data.billing_details.breaks.start_time | string | Timestamp indicating the start of break | |
| data.billing_details.breaks.end_time | string | Timestamp indicating the end of break |