Sign in
Change Order

Get a change order by id, including the sales orders, jobs and quotes it impacts. Its tasks are not embedded — read them from the change order task list.

get/api/change-orders/{id}

Path parameters

idstring required

Response

The change order for the given id

idstring nullable

The id of the change order

numberinteger

The change order's sequential number, unique within the tenant and assigned server-side

requestedUtcstring date-time nullable

When the change was requested (UTC). Defaults to the moment of creation when not supplied

dueDateUtcstring date-time nullable

When the change order is due (UTC), or null when it carries no date

approvedUtcstring date-time nullable

When the change order was approved (UTC), or null when it has not been

completedUtcstring date-time nullable

When the change order was completed (UTC). Stamped server-side when status moves to Completed without one supplied

status'new' | 'inProgress' | 'completed'

Where a change order stands.

detailstring nullable

What the change is

notificationsEnabledboolean nullable

Whether completing a task on this change order tells the owners of the next step

createdUtcstring date-time nullable

When the change order was created (UTC). Read-only

modifiedUtcstring date-time nullable

When the change order was last modified (UTC); supports incremental sync. Read-only

Changes