Skip to main content
GET
Use this endpoint to retrieve all change orders associated with a proposal. The response is an array of change order summary objects, each including the change order’s status, financial total, currency, customer contact information, and creation and modification timestamps. Use the id from this list to fetch full change order details with the Get Change Order endpoint.

Authorizations

X-MSS-API-APPID
string
header
required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY
string
header
required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE
string
header
required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE
string
header
required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Path Parameters

ProposalId
null | integer<int32>
required

Proposal Id.

Response

Success

id
integer<int32>
required

Unique numeric identifier of the change order

number
integer<int32>
required

Change-order number shown to the dealer in the UI

name
string
required

Display name of the change order

createdDate
string<date-time>
required

UTC timestamp when the change order was created

lastModifiedDate
string<date-time>
required

UTC timestamp when the change order was last modified by the system or a user

status
enum<string>
Available options:
Undefined,
Draft,
Submitted,
ViewedByClient,
Accepted,
Declined,
Delayed,
Completed,
EmailFailed,
Expired
total
PublicChangeOrderTotalModel · object

Change-order total amount and currency

customer
PublicContactModel · object

Contact summary model

lastModifiedByUserDate
string<date-time>

UTC timestamp when the change order was last modified by a user action