Patch Rate Sheet

Update a rate sheet

Path parameters

rate_sheet_idstringRequired

Request

This endpoint expects an object.

namestring or nullOptional

cargo_typeslist of enums or nullOptional

vehicle_typeslist of enums or nullOptional

route_typeslist of enums or nullOptional

Allowed values:

driver_idslist of strings or nullOptional

commentsstring or nullOptional

base_mileage_distance_milesdouble or nullOptional

base_mileage_rate_usd_per_instancedouble or nullOptional

additional_mileage_rate_usd_per_miledouble or nullOptional

long_distance_surcharge_miles_before_surchargedouble or nullOptional

long_distance_surcharge_rate_usd_per_miledouble or nullOptional

fuel_surchage_rate_usd_per_miledouble or nullOptional

wait_time_before_charge_minutesdouble or nullOptional

wait_time_rate_usd_per_minutedouble or nullOptional

extra_stop_rate_usddouble or nullOptional

dangerous_goods_rate_usd_per_instancedouble or nullOptional

after_hoursdouble or nullOptional

weekenddouble or nullOptional

holidaydouble or nullOptional

Response

Successful Response

schema_versioninteger

namestring or null

cargo_typeslist of enums or null

vehicle_typeslist of enums or null

route_typeslist of enums or null

Allowed values:

driver_idslist of strings or null

courier_org_idstring

Must be a string starting with org_

commentsstring or null

base_mileage_distance_milesdouble

base_mileage_rate_usd_per_instancedouble

additional_mileage_rate_usd_per_miledouble

applies only to the additional miles

long_distance_surcharge_miles_before_surchargedouble

long_distance_surcharge_rate_usd_per_miledouble

applies only to the additional miles

fuel_surchage_rate_usd_per_miledouble

wait_time_before_charge_minutesdouble

wait_time_rate_usd_per_minutedouble

extra_stop_rate_usddouble

dangerous_goods_rate_usd_per_instancedouble

after_hoursdouble

weekenddouble

holidaydouble

_idstring

1	curl -X PATCH https://localhost:5000/oort/courier_pay_driver_rate_sheets/rate_sheet_id \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"schema_version": 42,
3	"name": "foo",
4	"cargo_types": [
5	"spare_parts"
6	],
7	"vehicle_types": [
8	"sedan"
9	],
10	"route_types": [
11	"routed"
12	],
13	"driver_ids": [
14	"foo"
15	],
16	"courier_org_id": "foo",
17	"comments": "foo",
18	"base_mileage_distance_miles": 42,
19	"base_mileage_rate_usd_per_instance": 42,
20	"additional_mileage_rate_usd_per_mile": 42,
21	"long_distance_surcharge_miles_before_surcharge": 42,
22	"long_distance_surcharge_rate_usd_per_mile": 42,
23	"fuel_surchage_rate_usd_per_mile": 42,
24	"wait_time_before_charge_minutes": 42,
25	"wait_time_rate_usd_per_minute": 42,
26	"extra_stop_rate_usd": 42,
27	"dangerous_goods_rate_usd_per_instance": 42,
28	"after_hours": 42,
29	"weekend": 42,
30	"holiday": 42,
31	"_id": "foo"
32	}

Patch Rate Sheet

Path parameters

Headers

Request

Response

Errors