v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Accounting Code3

Attachment7

Attachment Certification1

Auth1

CAPAs2

Chart Of Accounts2

Company Info2

Custom Field2

Customer6

Customer Address5

Customer Contact5

Customer Tier2

Department4

Equipment4

Gauge Code2

Grade Code2

InProcessTrackingFieldType2

Inventory6

Inventory Event2

Inventory Event Details3

Inventory Lot3

Inventory Transactions1

Invoice5

Invoice Deposit Adjustment Line Item2

Invoice Deposit Line Item2

Invoice Discount Line Item1

Invoice Fee Line Item4

Invoice Line Item2

Invoice Note1

Invoice Part Line Item4

Invoice Refund Line Item4

Invoice Shipping Charge Line Item1

Invoice Tax Line Item2

Item10

Item Category2

Item Class2

Item Custom Fields2

Item Customer4

Item Material Vendor3

Item PriceBreaks4

Item Routing26

Item Tag5

Item Vendor3

Job8

Job Custom Fields2

Job Full Routing18

Job Item To Make3

Job Item To Make Operation8

Job Operation1

Job Part Line Item Full Routing1

Job Tracking Timers3

Location3

Material4

Material Code2

Material Vendor6

NCRs2

Note3

Operation4

Payment Term3

Purchase Order7

Purchase Order Custom Fields2

Purchase Order Discount Line Item1

Purchase Order Fee Line Item7

Purchase Order Line Item3

Purchase Order Outside Processing Line Item7

Purchase Order Part Line Item7

Purchase Order Tax Line Item2

Purchase Order Vendor Credit Line Item4

Quote10

Quote Custom Fields2

Quote Discount Line Item3

Quote Fee Line Item5

Quote Part Line Item7

Quote Part Line Item Custom Fields2

Quote Part Line Item Full Routing19

Quote Tax Line Item5

Receiving Receipt5

Receiving Receipt Line Item5

Refund Reason Code2

Reporting9

Sales Order7

Sales Order Blanket Line Item4

Sales Order Custom Fields2

Sales Order Discount Line Item3

Sales Order Fee Line Item6

Sales Order Line Item2

Sales Order Part Line Item8

Sales Order Part Line Item Custom Fields2

Sales Order Part Line Item Full Routing19

Sales Order Refund Line Item4

Sales Order Shipping Charge Line Item1

Sales Order Tax Line Item5

ScrapReport1

Shape Code2

Shipment Custom Fields1

Shipment Line Items (V3)1

Shipments4

Shipping Method2

Tag5

Tax Rate4

Time Clock Timers3

Timer4

Tool8

Tool Calibration5

User2

User Status2

Vendor5

Vendor Address5

Vendor Contact5

Work Order2

WorkCenter4

Job

Find jobs based on search parameters.

post/api/jobs/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

jobIdsstring[] nullable

Filter to jobs whose ids are in the list

numbersinteger[] nullable

Filter jobs to only given numbers

jobNamesstring[] nullable

Filter jobs to only given names

Job status

statusesJobStatusEnum[] nullable

Filter jobs to match the given statuses

parentItemIdstring nullable

Filter jobs based on the id of the parent item they produce

hasIncompleteOperationsboolean nullable

Filters jobs to have those that have at least 1 incomplete operation. Note that this will filter out jobs that haven't been approved yet because they technically have no operations on them until approved.

salesOrderIdstring nullable

Filters for jobs that are for this sales order id. Please reference /api/sales-orders endpoint.

createdBeforeUtcstring date-time nullable

Filters jobs created before (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.

createdAfterUtcstring date-time nullable

Filters jobs created after (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.

modifiedBeforeUtcstring date-time nullable

Filters jobs modified before (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.

modifiedAfterUtcstring date-time nullable

Filters jobs modified after (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used. Useful for polling incrementally instead of re-syncing every job.

Response

List of jobs matching the filters

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.