Skip to main content
POST
Update Proposal Item Tax-Exempt Flag
Marks a proposal item as tax-exempt, excluding it from the proposal’s sales tax calculation while leaving it in the subtotal. Applies to the targeted item only: there is no UpdateAllInstances here, so exempting the same product elsewhere in the proposal takes one call per instance.
SetDefault saves the setting on the library item behind a Labor or CustomItem, so items added from it later start tax-exempt. It works only while IsTaxExempt is true, and does nothing for Part or Fee items.

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

isTaxExempt
boolean
required

Whether the item is tax-exempt.

setDefault
boolean

Saves the tax-exempt setting on the library item, so new items created from it are tax-exempt too. Works only when isTaxExempt is true. Works only for Labor and CustomItem items. 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