Skip to content
Quotivity Help Center

Get Price Book Entry Adjustment

GET https://api.secure.quotivity.com/v1/pricebooks/{priceBookId}/products/{productId}/adjustment

Retrieves the adjustment for a product in a price book for a specific currency.

Send your API key in the x-api-key header. See Generating API keys.

Path parameters

Section titled “Path parameters”
Name Type Required Description
priceBookId string Yes —
productId string Yes —

Query parameters

Section titled “Query parameters”
Name Type Required Description
currency string Yes —

Responses

Section titled “Responses”
Status Body Description
200 GetPriceBookEntryAdjustmentResponse Adjustment retrieved successfully
401 — Unauthorized
500 — Internal Server Error

Schemas

Section titled “Schemas”

CostPlusAdjustment

Section titled “CostPlusAdjustment”

Derives the list price from the product’s hs_cost_of_goods_sold: basis amount adds value to cost; basis percent applies value as a fraction of cost (0.3 = 30%) as a markup (cost × (1 + value)) or a margin (cost ÷ (1 − value)). Non-primary currencies convert the cost with the account’s cached HubSpot exchange rate. value must not be negative and a margin must be below 1. Requires the Cost Plus feature (Enterprise).

Extends PriceAdjustmentBase.

Field Type Required Description
type costplus Yes —
basis amount | percent Yes —
mode markup | margin No Read only when basis is percent; defaults to markup.
value number Yes Currency amount above cost for amount; fraction of cost for percent.
round boolean No Round the derived price to 2 decimals (default true); false keeps 5 decimals.

GetPriceBookEntryAdjustmentResponse

Section titled “GetPriceBookEntryAdjustmentResponse”
Field Type Required Description
adjustment PriceBookEntryAdjustmentWithResponseFlags Yes —

OverrideAdjustment

Section titled “OverrideAdjustment”

Extends PriceAdjustmentBase.

Field Type Required Description
type override Yes —
amount number Yes —

PercentAdjustment

Section titled “PercentAdjustment”

Extends PriceAdjustmentBase.

Field Type Required Description
type percent Yes —
amount number Yes —

PriceAdjustmentBase

Section titled “PriceAdjustmentBase”
Field Type Required Description
type string Yes —

PriceBookEntryAdjustment

Section titled “PriceBookEntryAdjustment”

Type: OverrideAdjustment | PercentAdjustment | CostPlusAdjustment | VolumeAdjustment | TableEnumAdjustment | TableRangeAdjustment | VariantAdjustment

PriceBookEntryAdjustmentWithResponseFlags

Section titled “PriceBookEntryAdjustmentWithResponseFlags”

Per-currency adjustment as stored, plus allowUnitPriceEditing mirrored from the price book entry in read responses (not part of the persisted adjustment object).

Extends PriceBookEntryAdjustment.

Field Type Required Description
allowUnitPriceEditing boolean Yes Entry-level flag for this product on the price book.

TableEnumAdjustment

Section titled “TableEnumAdjustment”

Extends PriceAdjustmentBase.

Field Type Required Description
type enum Yes —
property string Yes —
values object[] Yes —

TableRangeAdjustment

Section titled “TableRangeAdjustment”

Extends PriceAdjustmentBase.

Field Type Required Description
type range Yes —
property string Yes —
values object[] Yes —

VariantAdjustment

Section titled “VariantAdjustment”

Extends PriceAdjustmentBase.

Field Type Required Description
type variant Yes —
values object[] Yes —

VolumeAdjustment

Section titled “VolumeAdjustment”

Extends PriceAdjustmentBase.

Field Type Required Description
type volume Yes —
tiers object[] Yes —