Sign in
Change Order

Finds change orders based on search parameters. Rows carry the change order header without its impacted records; read one change order to get those. Sorts on `number`, `status`, `requestedUtc`, `approvedUtc`, `completedUtc`, `dueDateUtc`, `createdUtc`, `modifiedUtc`, `customer`, `disposition` or `detail`; an unrecognised sort field falls back to `requestedUtc` ascending.

post/api/change-orders/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

searchstring nullable

Case-insensitive search over the customer name, the original and new revision items, and the detail

statusesChangeOrderStatusEnum[] nullable

Only change orders in these statuses

customerIdsstring[] nullable

Only change orders raised for these customers

dispositionIdsstring[] nullable

Only change orders carrying these dispositions

requestedFromUtcstring date-time nullable

Inclusive lower bound on requestedUtc

requestedToUtcstring date-time nullable

Inclusive upper bound on requestedUtc

dueFromUtcstring date-time nullable

Inclusive lower bound on dueDateUtc

dueToUtcstring date-time nullable

Inclusive upper bound on dueDateUtc

createdFromUtcstring date-time nullable

Inclusive lower bound on createdUtc

createdToUtcstring date-time nullable

Inclusive upper bound on createdUtc

completedFromUtcstring date-time nullable

Inclusive lower bound on completedUtc

completedToUtcstring date-time nullable

Inclusive upper bound on completedUtc

overdueboolean nullable

True narrows to change orders whose due date has passed and that are not Completed. False and omitted both apply no clause — this narrows, it does not select the complement

impactedDocumentIdstring nullable

Only change orders impacting this sales order, job or quote

revisionItemIdstring nullable

Only change orders whose original or new revision item is this item

modifiedAfterUtcstring date-time nullable

Only change orders written strictly after this UTC instant. Poll with the largest modifiedUtc you hold to pick up creates and edits; deletions do not advance modifiedUtc

modifiedBeforeUtcstring date-time nullable

Only change orders written at or before this UTC instant

Response

The matching change orders

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page

Changes

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