Crm.Marketing.MarketingActivityLines Entity

Namespace: Crm.Marketing

Detail records (lines) of the marketing activities. Entity: Crm_Marketing_Activity_Lines (Introduced in version 22.1.5.56)

Default Visualization

Default Display Text Format:
{LineNo}. {MarketingActivity.DocumentNo} {MarketingActivity.DocumentType.TypeName:T}
Default Search Members:
MarketingActivity.DocumentNo
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.Marketing.MarketingActivities
Aggregate Root:
Crm.Marketing.MarketingActivities

Attributes

Name	Type	Description
CompetitorPrice	decimal (15, 5) nullable	Price of the competitor.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
InStoreAvailableQuantity	Quantity (10, 3) nullable	The quantity found in store (in Quantity Unit). null means that count was not performed. `Unit: OrderQuantityUnit` `Filter(eq;ge;le)`
InStoreLocation	string (32) nullable	Location in store, like row, stand, etc.
InStorePrice	decimal (15, 5) nullable	Price displayed in store. `Filter(eq;ge;le)`
LineNo	int32	Consecutive line number, unique within the marketing activity. Usually is increasing in steps of 10, like in 10, 20, 30, etc. `Required` `Filter(eq)`
Notes	string (max) nullable	Notes for this MarketingActivityLine.
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.
OrderQuantity	Quantity (15, 3) nullable	Recommended quantity (in Quantity Unit) for new order as a result of the marketing activity. null means that there is no specific recommendation. `Unit: OrderQuantityUnit` `Filter(eq;ge;le)`

References

Name	Type	Description
Competitor	Competitors (nullable)	Competitor where marketing activity was held. `Filter(multi eq)`
Document	MarketingActivities	Marketing activity. `Required` `Filter(multi eq)`
MarketingActivity	MarketingActivities	Marketing activity. `Required` `Filter(multi eq)` `Owner`
MarketingActivityLineType	MarketingActivityLineTypes	Describes what the purpose of the marketing activity is. `Required` `Filter(multi eq)`
OrderQuantityUnit	MeasurementUnits (nullable)	The measurement unit of In_Store_Available_ Quantity and Order_Quantity. `Filter(multi eq)`
Product	Products	The specific product that was target of the marketing activity. `Required` `Filter(multi eq)`

Attribute Details

CompetitorPrice

Price of the competitor.

Type: decimal (15, 5) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
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

InStoreAvailableQuantity

The quantity found in store (in Quantity Unit). null means that count was not performed. Unit: OrderQuantityUnit Filter(eq;ge;le)

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

InStoreLocation

Location in store, like row, stand, etc.

Type: string (32) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault

InStorePrice

Price displayed in store. Filter(eq;ge;le)

Type: decimal (15, 5) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

LineNo

Consecutive line number, unique within the marketing activity. Usually is increasing in steps of 10, like in 10, 20, 30, etc. Required Filter(eq)

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

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

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

Notes

Notes for this MarketingActivityLine.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

OrderQuantity

Recommended quantity (in Quantity Unit) for new order as a result of the marketing activity. null means that there is no specific recommendation. Unit: OrderQuantityUnit Filter(eq;ge;le)

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

Reference Details

Competitor

Competitor where marketing activity was held. Filter(multi eq)

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

Document

Marketing activity. Required Filter(multi eq)

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

MarketingActivity

Marketing activity. Required Filter(multi eq) Owner

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

MarketingActivityLineType

Describes what the purpose of the marketing activity is. Required Filter(multi eq)

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

OrderQuantityUnit

The measurement unit of In_Store_Available_Quantity and Order_Quantity. Filter(multi eq)

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

Front-End Recalc Expressions:
obj.Product.MeasurementUnit

Product

The specific product that was target of the marketing activity. Required Filter(multi eq)

Type: Products
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