Table of Contents

Crm.Pricing.ProductPrices Entity

Namespace: Crm.Pricing

Specific prices of products. A price is applied after matching the specified criteria. Entity: Crm_Product_Prices

Renames

Old name: Crm.ProductPrices
New name: Crm.Pricing.ProductPrices
Version: 25.1.1.36
Case: 37717

Default Visualization

Default Display Text Format:
{Price} - {FromDate}
Default Search Members:
Notes
Category: Definitions
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

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate date nullable Starting date of validity of the price. Filter(eq;ge;le)
Id guid
IsActive boolean Indicates whether the current Product price is active. Required Default(true) Filter(eq) Introduced in version 25.1.0.18
MaxQuantity Quantity (18, 3) nullable Maximum quantity for which this price is valid in the Price_Quantity_
Measurement_Unit. Unit: PriceQuantityMeasurement<br />Unit Filter(eq;ge;le)
MinQuantity Quantity (18, 3) nullable Minimal quantity required to use this price (in the Price_Quantity_Measurement_Unit). Unit: PriceQuantityMeasurement<br />Unit Filter(eq;ge;le)
Notes string (254) nullable Notes for this ProductPrice. Filter(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.
Price Amount (13, 5) Price in the specified currency and for the specified quantity. Currency: Currency Required Default(0) Filter(eq;ge;le)
PriceQuantity Quantity (10, 3) The quantity of the product for which the price is specified. Unit: PriceQuantityMeasurement<br />Unit Required Default(1) Filter(ge;le)
Priority Priority Priority of the price comparative to other prices. Only the highest priority price is applied. Required Default(2) Filter(multi eq)
ThruDate date nullable Ending date (inclusive) of the validity of the price. Filter(eq;ge;le)

References

Name Type Description
Campaign Campaigns (nullable) Тhe marketing campaign to which the current definition belongs. Filter(multi eq) Introduced in version 22.1.4.67
Currency Currencies The currency of the price. Required Filter(multi eq)
Customer Customers (nullable) When not null, specifies that the customer of the sales document must be the specified customer. Filter(multi eq)
DistributionChannel DistributionChannels (nullable) Use the price only when selling through the specified channel. Filter(multi eq)
EnterpriseCompany EnterpriseCompanies (nullable) When not null, specifies that the sales document must be in the specified enterprise company. Filter(multi eq)
EnterpriseCompanyLocation CompanyLocations (nullable) When set, specifies that the sales document must be of the specified enterprise company location. Filter(multi eq)
PriceList PriceLists (nullable) When not null, specifies that the sales document must have the specified price list. Filter(multi eq)
PriceQuantityMeasurement
Unit		 MeasurementUnits The measurement unit of Price_Quantity. Required Filter(multi eq)
PriceType PriceTypes (nullable) Price type of the current product price. The price types are used to set additional priority condition for the prices. Filter(multi eq)
Product Products The product for which a price will be defined. Required Filter(multi eq) FilterableReference
ShipToCustomer Customers (nullable) When not null, specifies that the price will be applied only when the sales document has the specified Ship-To-Customer. Filter(multi eq)
TargetGroup TargetGroups (nullable) When not null, specifies a criteria, which is matched only when the customer of the sales document is included in the group. Filter(multi eq)

Attribute Details

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

FromDate

Starting date of validity of the price. Filter(eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
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 Product price 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

MaxQuantity

Maximum quantity for which this price is valid in the Price_Quantity_Measurement_Unit. Unit: PriceQuantityMeasurementUnit Filter(eq;ge;le)

Type: Quantity (18, 3) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

MinQuantity

Minimal quantity required to use this price (in the Price_Quantity_Measurement_Unit). Unit: PriceQuantityMeasurementUnit Filter(eq;ge;le)

Type: Quantity (18, 3) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Notes

Notes for this ProductPrice. Filter(like)

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

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

Price

Price in the specified currency and for the specified quantity. Currency: Currency Required Default(0) Filter(eq;ge;le)

Type: Amount (13, 5)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

PriceQuantity

The quantity of the product for which the price is specified. Unit: PriceQuantityMeasurementUnit Required Default(1) Filter(ge;le)

Type: Quantity (10, 3)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: HiddenByDefault

Priority

Priority of the price comparative to other prices. Only the highest priority price is applied. Required Default(2) Filter(multi eq)

Type: Priority
Category: System
Generic enum type for Priority properties
Allowed Values (General.Priority Enum Members)

Value Description
Lowest Lowest value. Stored as 1.
Database Value: 1
Model Value: 1
Domain API Value: 'Lowest'
Low Low value. Stored as 2.
Database Value: 2
Model Value: 2
Domain API Value: 'Low'
Medium Medium value. Stored as 3.
Database Value: 3
Model Value: 3
Domain API Value: 'Medium'
High High value. Stored as 4.
Database Value: 4
Model Value: 4
Domain API Value: 'High'
Highest Highest value. Stored as 5.
Database Value: 5
Model Value: 5
Domain API Value: 'Highest'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: 2
Show in UI: ShownByDefault

ThruDate

Ending date (inclusive) of the validity of the price. Filter(eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Reference Details

Campaign

Тhe marketing campaign to which the current definition belongs. Filter(multi eq) Introduced in version 22.1.4.67

Type: Campaigns (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Currency

The currency of the price. Required Filter(multi eq)

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

Customer

When not null, specifies that the customer of the sales document must be the specified customer. Filter(multi eq)

Type: Customers (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

DistributionChannel

Use the price only when selling through the specified channel. Filter(multi eq)

Type: DistributionChannels (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EnterpriseCompany

When not null, specifies that the sales document must be in the specified enterprise company. Filter(multi eq)

Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

EnterpriseCompanyLocation

When set, specifies that the sales document must be of the specified enterprise company location. Filter(multi eq)

Type: CompanyLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( ( obj.EnterpriseCompanyLocation != null) AndAlso ( obj.EnterpriseCompanyLocation.Company != obj.EnterpriseCompany)), null, obj.EnterpriseCompanyLocation.Company)

PriceList

When not null, specifies that the sales document must have the specified price list. Filter(multi eq)

Type: PriceLists (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PriceQuantityMeasurementUnit

The measurement unit of Price_Quantity. Required Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( obj.Product != null), obj.Product.MeasurementUnit, obj.PriceQuantityMeasurementUnit)

PriceType

Price type of the current product price. The price types are used to set additional priority condition for the prices. Filter(multi eq)

Type: PriceTypes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Product

The product for which a price will be defined. Required Filter(multi eq) FilterableReference

Type: Products
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

ShipToCustomer

When not null, specifies that the price will be applied only when the sales document has the specified Ship-To-Customer. Filter(multi eq)

Type: Customers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( obj.ShipToCustomer.Party.ParentParty != obj.Customer), null, obj.ShipToCustomer)

TargetGroup

When not null, specifies a criteria, which is matched only when the customer of the sales document is included in the group. Filter(multi eq)

Type: TargetGroups (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Pricing_ProductPrices?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pricing_ProductPrices?$top=10

Suggest improvement to this page