Crm.PromotionalPackageLines Entity

Namespace: Crm

Detail records (lines) of promotional package definition. Entity: Crm_Promotional_Package_Lines

Default Visualization

Default Display Text Format:
{PromotionalPackage.Name}
Default Search Members:
PromotionalPackage.Name
Name Data Member:
PromotionalPackage.Name
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 Parent:
Crm.PromotionalPackages
Aggregate Root:
Crm.PromotionalPackages

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
LineNumber	int32	Consecutive line number. `Required`
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.
Quantity	Quantity (9, 3)	The quantity of the product in the package in the base measurement unit of the Product. `Unit: Product.BaseMeasurementCategory.BaseUnit` `Required` `Default(1)` `Filter(ge;le)`
StandardDiscount AdjustOrReplace	StandardDiscount AdjustOrReplace	Specifies standard discount change action: A=ADD, M=Mark down - apply after standard discount; R=REPLACE the standard discount. `Required` `Default("R")`
StandardDiscount PercentAdjust	decimal (7, 6)	The value of change (in percents) for the standard discount. `Required` `Default(0)`
UnitPrice	Amount (13, 5) nullable	When not null specifies directly unit price for the product. When null, the package specifies only discount. `Currency: UnitPriceCurrency`

References

Name	Type	Description
Lot	Lots (nullable)	The Product lot number in the promotional package. `Filter(multi eq)` `Introduced in version 19.1`
Product	Products	The product, which is included in the promotional package. `Required` `Filter(multi eq)`
PromotionalPackage	PromotionalPackages	The to which this PromotionalPackageLine belongs. `Required` `Filter(multi eq)` `Owner`
UnitPriceCurrency	Currencies (nullable)	Currency of the unit price. null if the package specifies only discount. `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

Id

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

LineNumber

Consecutive line number. Required

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.PromotionalPackage.Lines.Select( c => c.LineNumber).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.PromotionalPackage.Lines.Select( c => c.LineNumber).DefaultIfEmpty( 0).Max( ) + 1)

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

Quantity

The quantity of the product in the package in the base measurement unit of the Product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(1) Filter(ge;le)

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

StandardDiscountAdjustOrReplace

Specifies standard discount change action: A=ADD, M=Mark down - apply after standard discount; R=REPLACE the standard discount. Required Default("R")

Type: StandardDiscount
AdjustOrReplace
Category: System
Allowed values for the StandardDiscountAdjustOrReplace(Crm.PromotionalPackageLines.md#standarddiscountadjustorreplace) data attribute
Allowed Values (Crm.PromotionalPackageLinesRepository.StandardDiscountAdjustOrReplace Enum Members)

Value	Description
Add	Add value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'Add'
Replace	Replace value. Stored as 'R'. Database Value: 'R' Model Value: 1 Domain API Value: 'Replace'
MarkDown	MarkDown value. Stored as 'M'. Database Value: 'M' Model Value: 2 Domain API Value: 'MarkDown'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Replace
Show in UI: ShownByDefault

StandardDiscountPercentAdjust

The value of change (in percents) for the standard discount. Required Default(0)

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

UnitPrice

When not null specifies directly unit price for the product. When null, the package specifies only discount. Currency: UnitPriceCurrency

Type: Amount (13, 5) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

Lot

The Product lot number in the promotional package. Filter(multi eq) Introduced in version 19.1

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

Product

The product, which is included in the promotional package. Required Filter(multi eq)

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

PromotionalPackage

The to which this PromotionalPackageLine belongs. Required Filter(multi eq) Owner

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

UnitPriceCurrency

Currency of the unit price. null if the package specifies only discount. Filter(multi eq)

Type: Currencies (nullable)
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