Crm.Sales.SalesOrderPromotionalPackages Entity

Namespace: Crm.Sales

The promotional packages, included in a sales order. Entity: Crm_Sales_Order_Promotional_Packages

Default Visualization

Default Display Text Format:
{SalesOrder.EntityName}
Default Search Members:
SalesOrder.EntityName
Name Data Member:
SalesOrder.EntityName
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.Sales.SalesOrders
Aggregate Root:
Crm.Sales.SalesOrders

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 of the package, unique within the document. `Required` `Filter(eq)`
NumberOfPackages	int32	Number of packages sold. `Required` `Default(0)`
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
PromotionalPackage	PromotionalPackages	The type of promotional package sold. `Required` `Filter(multi eq)`
SalesOrder	SalesOrders	The to which this SalesOrderPromotional Package belongs. `Required` `Filter(multi eq)` `Owner`

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 of the package, unique within the document. Required Filter(eq)

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

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

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

NumberOfPackages

Number of packages sold. Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
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

PromotionalPackage

The type of promotional package sold. Required Filter(multi eq)

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

SalesOrder

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

Type: SalesOrders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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