Crm.PriceLists Entity
Namespace: Crm
Price Lists are used to manage multiple price records, assign to customers, etc. Entity: Crm_Price_Lists
Default Visualization
Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
AutoApplyDiscountLevel | DiscountLevel | Indicates the level to which discounts are applied automatically. Increasing the level has performance implications. Discounts, higher than the specified level can also be applied, but must be selected manually by the users. Level 1 discounts are always calculated. Required Default("1") Filter(multi eq) Introduced in version 23.1.2.8 |
Description | string (max) nullable | The description of this PriceList. |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
FromDate | datetime nullable | Starting validity of the price list. Filter(eq;ge;le) |
Id | guid | |
IsActive | boolean | Indicates whether the current Price List is active. Required Default(true) Filter(eq) Introduced in version 25.1.0.18 |
Name | string (50) | The name of this PriceList. Required Filter(eq;like) ORD |
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. |
ThruDate | datetime nullable | Ending validity of the price list. Filter(eq;ge;le) |
References
Name | Type | Description |
---|---|---|
EnterpriseCompany | EnterpriseCompanies (nullable) | The Enterprise Company to which this PriceList applies, or null if it is for all enterprise companies. Filter(multi eq) |
Attribute Details
AutoApplyDiscountLevel
Indicates the level to which discounts are applied automatically. Increasing the level has performance implications. Discounts, higher than the specified level can also be applied, but must be selected manually by the users. Level 1 discounts are always calculated. Required
Default("1")
Filter(multi eq)
Introduced in version 23.1.2.8
Type: DiscountLevel
Category: System
Allowed values for the DiscountLevel
(Crm.LineDiscounts.md#discountlevel) data attribute
Allowed Values (Crm.LineDiscountsRepository.DiscountLevel Enum Members)
Value | Description |
---|---|
One | One value. Stored as '1'. Database Value: '1' Model Value: 0 Domain API Value: 'One' |
Two | Two value. Stored as '2'. Database Value: '2' Model Value: 1 Domain API Value: 'Two' |
Three | Three value. Stored as '3'. Database Value: '3' Model Value: 2 Domain API Value: 'Three' |
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: One
Show in UI: ShownByDefault
Description
The description of this PriceList.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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
FromDate
Starting validity of the price list. Filter(eq;ge;le)
Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
IsActive
Indicates whether the current Price List 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 this PriceList. Required
Filter(eq;like)
ORD
Type: string (50)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 50
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
ThruDate
Ending validity of the price list. Filter(eq;ge;le)
Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
Reference Details
EnterpriseCompany
The Enterprise Company to which this PriceList applies, or null if it is for all enterprise companies. Filter(multi eq)
Type: EnterpriseCompanies (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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
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: UsersnotificationClass
The notification class.
Type: stringsubject
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
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_PriceLists?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_PriceLists?$top=10