Crm.Pricing.PricingModels Entity

Namespace: Crm.Pricing

Pricing models are assigned to product groups and are used to automate creation of standard costs and prices and related price records. Entity: Crm_Pricing_Models

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Crm.Pricing.PricingModels
- Crm.Pricing.PricingModelCosts
- Crm.Pricing.PricingModelPriceLists

Attributes

Name	Type	Description
DefaultMarginPercent	decimal (6, 5)	Default margin between standard cost and standard price. The margin is applied to the products when calculating standard price. `Required` `Default(0)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsActive	boolean	Indicates whether the current Pricing model is active. `Required` `Default(true)` `Filter(eq)` `Introduced in version 25.1.0.18`
Name	string (254)	The name of the pricing model. `Required` `Filter(eq;like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

References

Name	Type	Description
Currency	Currencies	The currency in which the prices will be calculated. `Required` `Filter(multi eq)`
PurchasePriceList	PurchasePriceLists	Purchase price list Id, which will be used to get the purchase price of the products. `Required` `Filter(multi eq)`

Child Collections

Name	Type	Description
Costs	PricingModelCosts	List of `PricingModelCost`(Crm.Pricing.PricingModelCosts.md) child objects, based on the `Crm.Pricing.PricingModelCost.PricingModel`(Crm.Pricing.PricingModelCosts.md#pricingmodel) back reference
PriceLists	PricingModelPriceLists	List of `PricingModelPriceList`(Crm.Pricing.PricingModelPriceLists.md) child objects, based on the `Crm.Pricing.PricingModelPriceList.PricingModel`(Crm.Pricing.PricingModelPriceLists.md#pricingmodel) back reference

Attribute Details

DefaultMarginPercent

Default margin between standard cost and standard price. The margin is applied to the products when calculating standard price. Required Default(0)

Type: decimal (6, 5)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Indicates whether the current Pricing model is active. Required Default(true) Filter(eq) Introduced in version 25.1.0.18

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Name

The name of the pricing model. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Reference Details

Currency

The currency in which the prices will be calculated. Required Filter(multi eq)

Type: Currencies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PurchasePriceList

Purchase price list Id, which will be used to get the purchase price of the products. Required Filter(multi eq)

Type: PurchasePriceLists
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST