v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Job

Partially update a job

patch/api/jobs/{jobId}

Path parameters

jobIdstring required

Response

Job item

idstring required

Unique Id associated to this entity

numberinteger required

Job number

namestring required

Job name, defaults to number unless otherwise specified.

parentItemIdstring required

Unique identifier of the parent item produced by this job. Please reference api/items endpoint.

quantityToMakenumber double required

Quantity of parent item produced by this job

productionDueDatestring date-time nullable

Due date

earliestStartDatestring date-time nullable

If set, this is the earliest date that the job should be scheduled to begin.

salesOrderIdstring nullable

Identifier of sales order fulfilled by this job, if applicable. Please reference api/sales-orders endpoint.

salesOrderLineItemIdstring nullable

Identifier of sales order line item fulfilled by this job, if applicable. Please reference endpoints nested under api/sales-orders.

createdUtcstring date-time

The date the job was created

originalScheduledStartUtcstring date-time nullable

The first scheduled start time.

originalScheduledEndUtcstring date-time nullable

The first scheduled end time.

scheduledStartUtcstring date-time nullable

The current scheduled start time.

scheduledEndUtcstring date-time nullable

The current scheduled end time.

completedOnUtcstring date-time nullable

The job completion datetime.

cancelledOnUtcstring date-time nullable

The job cancelled datetime.

revenuenumber double nullable

Revenue

notesstring nullable

Job level internal notes

workOrderIdsstring[] required

Identifier of work order(s) that this job is associated to, if applicable. Please reference api/work-orders endpoint.

Job status

priority'low' | 'moderate' | 'high' required

Job priority

customFieldsobject nullable

Custom fields that have been defined on this entity.