| AdjustmentSource |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist,
Sort
- Description
- Indicates the source of the adjustment. This field is
available with B2B Commerce.
- Possible values are:
-
Discretionary—The adjustment is
entered manually, for example, by a sales
rep.
-
Promotion—The adjustment is part
of a promotion.
-
Rule—Reserved for future
use.
-
System—The adjustment is
configured by the system data, for example, as
part of a pricing rule or discount schedule.
|
| AdjustmentType |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist,
Sort
- Description
- Indicates whether the adjustment is a percentage, an amount, or an override.
- Possible values are:
-
AdjustmentAmount—Reserved for
future use. The adjustment value is a numerical
amount.
-
AdjustmentPercentage— The
adjustment value is a percentage.
-
OverrideAmount— The override
value is a numerical amount.
|
| AdjustmentValue |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort
- Description
- The value of the adjustment. To indicate a discount, use
a negative number.
|
| Description |
- Type
- textarea
- Properties
- Create, Nillable
- Description
- User-entered description of the price adjustment group.
Available in API versions 57.0.
|
| PriceAdjustmentCauseId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The ID of the record that is the source of the
adjustment. For example, if the price adjustment is due
to a promotion, this field contains the ID of the
promotion record. If the price adjustment is due to a
price adjustment tier, this field contains the ID of the
price adjustment tier record.
- This field is a polymorphic relationship field.
- Relationship Name
- PriceAdjustmentCause
- Relationship Type
- Lookup
- Refers To
- PriceAdjustmentTier
|
| PriceAdjustmentGroupShapeName |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort
- Description
- Name of the price adjustment group shape.
|
| Priority |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- A positive integer indicating the order in which this
price adjustment group is applied, relative to other
price adjustment groups. A Priority
of 1 indicates this price
adjustment group is applied first.
Price adjustments
with a null priority are applied after price
adjustments with a specified priority. If two or
more price adjustments have a null priority,
percentage adjustments are applied before
amount adjustments. Applying a percentage adjustment
before an amount adjustment results in a larger
total adjustment.
-
The value of Priority must
be unique among price adjustment groups in the same
sales transaction.
|
| SalesTransactionShapeId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The ID of the sales transaction that the price
adjustment group belongs to.
- This field is a relationship field.
- Relationship Name
- SalesTransactionShape
- Relationship Type
- Lookup
- Refers To
- SalesTransactionShape
|
| TotalAmount |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort
- Description
- The total amount of adjustments of all related price adjustment items, inclusive of
quantity, prorated for the duration of the subscription.
This field is a calculated field equal to the sum of the
TotalAmount fields in the
related price adjustment items.
|
j