Sign in
Job

Create a new job

post/api/jobs

Request body

nameOfJobstring nullable

Name of the job to create. If omitted, the default naming convention will be used

customerIdstring nullable

The id of the customer to be created

autoScheduleboolean nullable

Auto Schedule job. Defaults to FALSE if omitted.

notestring nullable

Note to customer. This will appear on PDFs.

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

Job priority

productionDueDatestring date-time nullable

The date that the production of items on the job needs to be completed by.

earliestStartDatestring date-time nullable

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

quantityToMakenumber double required

Quantity to make

salesOrderIdstring nullable

Sales Order Id the job is created for. If used, ItemToMakeId will be ignored.

salesOrderLineItemIdstring nullable

Sales Order Line Item Id the job is created for. If used, ItemToMakeId will be ignored.

salesOrderLineItemNameOverridestring nullable

Sales Order Line Item - Name Override

itemToMakeIdstring nullable

Id of the item to make. If SalesOrderId/SalesOrderLineItemId is set then ItemToMakeId will be ignored

Response

Job created

idstring required

The id of the created record

Changes

No recorded changes to this endpoint across all 12 revisions of this API.