Sign in
Change Order

Create a change order. `originalRevisionItem.id` is required and `disposition.id`, when sent, must resolve to a change order disposition. The change order's sequential number is assigned server-side, `requestedUtc` defaults to the moment of creation, and a change order created Completed is stamped with `completedUtc`. The change order is created with no impacted records and no tasks. Creates are not idempotent: a retried request creates a second change order.

post/api/change-orders

Request body

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)

approvedUtcstring date-time nullable

When the change order was approved (UTC)

completedUtcstring date-time nullable

When the change order was completed (UTC). Stamped server-side when status is Completed and none is 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. Null on a create takes the company default; null on an update keeps what the change order carries

Response

The created change order

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

Changed in 1 of the 23 revisions of this API.1