Skip to main content
POST
Update Proposal Item Quantity
Sets the Quantity of a proposal item. Fractional values are supported and stored rounded to 2 decimals, so 5.5 hours of labor is a valid quantity. A quantity of 0 is allowed and keeps the item in the proposal at a zero total — use delete items to remove it.
IncludeAttachments rescales the items nested under this one proportionally rather than setting them to the same number. Going from 2 to 6 multiplies every nested quantity by 3, so a child at 1 becomes 3, rounded to 2 decimals. A child already at 0 stays at 0, and if the parent’s current quantity is 0 there is no factor to apply, so only the parent changes. Defaults to false.

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

quantity
number<double>
required

New quantity for the item, stored rounded to 2 decimals. Zero is allowed and leaves the item in place - use the delete endpoint to remove it.

includeAttachments
boolean

When true, the items nested under this item are rescaled by the same factor as this item, rather than being set to the same quantity. For example, changing this item from 2 to 6 multiplies every nested quantity by 3, so a nested item at 1 becomes 3. If this item's current quantity is zero there is no factor to apply and only this item changes. 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