Skip to main content
PATCH
Update a Job for a Company

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

id
string
required

Job ID

company-id
string<uuid>
required

Company ID

Body

application/json
job_start_at
string<date-time>
notes
string | null
quantity
number | null
unit_of_measure
enum<string> | null
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

load_unit_of_measure
enum<string> | null
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

equipment_id
string | null
material_id
string | null
waypoints
Waypoint-Update-Destroyable · object[]
sales_contact
Contact-Update-Destroyable · object
foreman_contact
Contact-Update-Destroyable · object
supervisor_contact
Contact-Update-Destroyable · object
collaborator_contact
Contact-Update-Destroyable · object
driver_id
string | null
priority
integer
customer_rate_id
string<uuid> | null
vendor_rate_id
string<uuid> | null
billable_hours
number
additional_equipment_ids
string<uuid>[]
foreman_ids
string<uuid>[]
collaborator_ids
string<uuid>[]
salesperson_ids
string<uuid>[]
service_class_id
string<uuid> | null
hauler_rate_type
string | null
driver_rate_id
string | null
driver_rate_value
number | null
driver_rate_type
enum<string> | null
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

customer_rate_value
number | null
customer_rate_type
enum<string> | null
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

vendor_rate_value
number | null
vendor_rate_type
enum<string> | null
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

phase_id
string | null
requested_loads_count
integer
deprecated

Deprecated in favor of quantity and unit_of_measure. When unit_of_measure is Load, then quantity is the number of loads, otherwise it is 1.

Required range: 1 <= x <= 25
requested_equipment_type_name
string | null
requested_equipment_type_accounting_id
string | null
equipment_type_gross_capacity
number | null
recurring_loads
boolean
material_rate_assignment
MaterialRateAssignment-Update · object
equipment_type_gross_capacity_unit_of_measure
enum<string> | null
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

job_time
integer | null
compliance_override
boolean

When true, logs a compliance override for the job assignment

Response

OK

data
Job-Read · object
required