Skip to main content
GET
Use this endpoint to retrieve the full detail of a specific change order. The response includes the complete financial summary (parts, labor, fees, subtotal, and sales tax), all areas with their options and line items, and customer contact information. The HTTP response also sets the Last-Modified header from the change order’s lastModifiedDate, which you can use for conditional requests.

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.

ChangeOrderId
null | integer<int32>
required

Change Order Id.

Response

Success

Detailed change-order representation

number
integer<int32>
required

Proposal number unique within the dealer account.

name
string
required

Display name of the proposal.

id
integer<int32>
required

Unique numeric identifier 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 either the system or a user.

lastModifiedByUserDate
string<date-time>
required

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

status
enum<string>
Available options:
Undefined,
Draft,
Submitted,
ViewedByClient,
Accepted,
Declined,
Delayed,
Completed,
EmailFailed,
Expired
lastSubmittedDate
string<date-time>

UTC timestamp when the proposal was last submitted to the customer.

clientLastOpenedDate
string<date-time>

UTC timestamp when the customer last opened the proposal viewer link.

customer
PublicCustomerModel · object

Customer contact

dealer
PublicDealerModel · object

Dealer information

coverpageImageUrl
string

Absolute URL of the proposal cover image, when one is available.

aboutUs
string

The about us text for the company profile.

projectDescription
string

A description of the project.

areas
PublicAreaModel · object[]

The list of areas.

profit
PublicProfitModel · object

Profit summary for the proposal

recurringServices
PublicRecurringServicesModel · object

Recurring service summary associated with the proposal.

paymentSchedule
PublicPaymentScheduleModel · object

Payment schedule configuration for the proposal, including the customer-facing description and individual payment milestones.

paymentRequests
PublicPaymentRequestModel · object[]

Payment requests already issued for this proposal.

projectTerms
string

The terms and conditions for the project.

lastModifiedUser
PublicUserModel · object

User summary returned within proposal detail responses

clientLastDecisionDate
string<date-time>

UTC timestamp when the customer last accepted or declined the change order.

lastCompletedDate
string<date-time>

UTC timestamp when the change order was completed, if it has reached a completed state.

financialSummary
PublicChangeOrderFinancialSummaryModel · object

Financial summary for a change order