Skip to main content
POST
Update Proposal Item Sell Price
Sets the per-unit sell price of a proposal item, as either an absolute SellPrice or a SellPercentage plus SellPercentageBasis. Exactly one of the two forms is required: supplying both, neither, or a percentage without its basis returns 400. The two forms replace each other. Writing an absolute price clears any stored percentage and basis; writing a percentage clears any stored absolute price. Percentages are whole numbers — 15 means 15%, with the resulting price rounded to 2 decimals. CostOfSellPrice belongs to update cost and must not be used here.
A percentage price is recalculated rather than stored. With ProposalTotal, PartTotal, or LaborTotal the item’s price changes whenever anything else in the proposal changes, so the sellPrice in this response is only current as of this call. See reading proposal items.
SetDefault also saves the price in the catalog so later proposals start with it — but only an absolute price is saved for a Part, and a percentage-based update instead clears whatever price was saved there before. Labor, CustomItem, and Fee items keep the price, percentage, and basis on their library item. UpdateAllInstances applies the change to the proposal’s other items from the same source item that share its item type, in any area option.

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
integer<int32>
required

Unique ID of the proposal (not the proposal number).

ProposalItemId
integer<int32>
required

Id of the proposal item to update. Must belong to the proposal.

Body

application/json

Proposals Service

sellPrice
number<double>

Absolute per-unit sell price, mutually exclusive with sellPercentage. Supplying it clears any stored percentage and basis.

sellPercentage
number<double>

Sell price as a whole percent of the chosen basis (15 means 15%), with the resulting price rounded to 2 decimals. Requires sellPercentageBasis, is mutually exclusive with sellPrice, and clears any stored absolute price.

sellPercentageBasis
enum<string>
Available options:
ProposalTotal,
PartTotal,
LaborTotal,
AreaTotal,
PartsInAreaTotal,
LaborInAreaTotal,
CostOfSellPrice
setDefault
boolean

When true, also save this sell price in the catalog so later proposals start with it. For a Part, only an absolute price is saved: a percentage-based update saves no price and clears any price saved there before. For a Labor, CustomItem, or Fee item, the price, percentage, and basis are saved on the library item. Defaults to false.

updateAllInstances
boolean

When true, the same change is applied to the proposal's other items that come from the same catalog item and have the same item type, in any area option. Defaults to false.

Response

Success

id
integer<int32>
required

Unique numeric identifier of the proposal item

referencedItemId
integer<int32>
required

Identifier of the catalog, labor, custom, or fee item this proposal item was created from

createdDate
string<date-time>
required

UTC timestamp when the proposal item was created

quantity
number<double>
required

Quantity of the proposal item

parentId
integer<int32>

Identifier of the parent item when this item is nested under another item

itemType
enum<string>
Available options:
Part,
Labor,
CustomItem,
Fee
lastModifiedDate
string<date-time>

UTC timestamp when the proposal item was last modified

brand
string

Brand name of the item

model
string

Model value of the item

name
string

Name of a Labor item

shortDescription
string

Short description shown for the proposal item

clientNote
string

Client-facing note for the proposal item

imageUrl
string

Image URL of the item

msrp
number<double>

MSRP amount of the item

sellPrice
number<double>

Sell price for the proposal item

cost
number<double>

Supplier cost for the proposal item

costUpdateDate
string<date-time>

UTC timestamp when the supplier cost was last updated

supplier
string

Display name of the supplier assigned to the item.

total
PublicItemTotalModel · object

Total amount for a proposal item

isTaxExempt
boolean

Whether the proposal item is tax exempt

isRecurringService
boolean

Whether the proposal item is a recurring service

linkedOrders
PublicLinkedOrderModel · object[]

Linked orders created from this proposal item