Table of Contents

Crm.PromotionalPackages Entity

Namespace: Crm

Promotional packages are packages of products, which are sold together at a special pricing and discount conditions. Entity: Crm_Promotional_Packages

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
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 Tree

Attributes

Name Type Description
Active boolean Package status: true = the offer is available for new documents; false = otherwise. Required Default(true) Filter(eq)
Code string (20) Unique code of the promotional package. Required Filter(eq;like) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
Name string (254) The name of this PromotionalPackage. 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.
ValidForCustomerFilterXML dataaccessfilter nullable When not null, the package is valid only for the customers, that match the filter. Unit: CustomersRepository.TableName
ValidForDistribution
ChannelFilterX
ML		 dataaccessfilter nullable When not null, the package is valid only if the specified distribution channel of the sales order fits in the filter criteria. Unit: Marketing.DistributionChannels<br />Repository.TableName
ValidForShipTo
CustomerFilter
XML		 dataaccessfilter nullable When not null, specifies validity condition for the Ship To Customer of the sales document. Unit: CustomersRepository.TableName
ValidFromDate date nullable When not null specifies the first date when the package is valid for offering. The date is compared against the document date. Filter(eq;ge;le)
ValidToDate date nullable When not null specifies the last date (inclusive) when the package is valid. The date is compared against the document date. 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
EnterpriseCompany EnterpriseCompanies (nullable) When not null, indicates that the package is valid only for the specified enterprise company. Filter(multi eq)
EnterpriseCompanyLocation CompanyLocations (nullable) The Enterprise Company Location to which this PromotionalPackage applies, or null if it is for all enterprise company locations. Filter(multi eq)
ValidForCustomer Customers (nullable) When not null, the package is valid only for the specified customer. Filter(multi eq)
ValidForDistribution
Channel		 DistributionChannels (nullable) When not null, the package is valid only for the specified distribution channel of the sales order. Filter(multi eq)
ValidForPriceList PriceLists (nullable) When not null, the package is valid only for the specified price list. Filter(multi eq)
ValidForShipToCustomer Customers (nullable) When not null, specifies that the package is valid only when the sales document is for the specified Ship To Customer. Filter(multi eq)
ValidForTargetGroup TargetGroups (nullable) When not null, the package is valid only for the specified customer target group. Filter(multi eq)

Child Collections

Name Type Description
Lines PromotionalPackageLines List of PromotionalPackageLine(Crm.PromotionalPackageLines.md) child objects, based on the Crm.PromotionalPackageLine.PromotionalPackage(Crm.PromotionalPackageLines.md#promotionalpackage) back reference

Attribute Details

Active

Package status: true = the offer is available for new documents; false = otherwise. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Code

Unique code of the promotional package. Required Filter(eq;like) ORD

Type: string (20)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 20
Show in UI: ShownByDefault

Back-End Default Expression:
obj.IncMax( o => o.Code, null, "00000")

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

Name

The name of this PromotionalPackage. Required Filter(eq;like) ORD

Type: string (254)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 254
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

ValidForCustomerFilterXML

When not null, the package is valid only for the customers, that match the filter. Unit: CustomersRepository.TableName

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

ValidForDistributionChannelFilterXML

When not null, the package is valid only if the specified distribution channel of the sales order fits in the filter criteria. Unit: Marketing.DistributionChannelsRepository.TableName

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

ValidForShipToCustomerFilterXML

When not null, specifies validity condition for the Ship To Customer of the sales document. Unit: CustomersRepository.TableName

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

ValidFromDate

When not null specifies the first date when the package is valid for offering. The date is compared against the document date. Filter(eq;ge;le)

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

ValidToDate

When not null specifies the last date (inclusive) when the package is valid. The date is compared against the document date. Filter(eq;ge;le)

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

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

EnterpriseCompany

When not null, indicates that the package is valid only for the specified enterprise company. Filter(multi eq)

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

EnterpriseCompanyLocation

The Enterprise Company Location to which this PromotionalPackage applies, or null if it is for all enterprise company locations. Filter(multi eq)

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

ValidForCustomer

When not null, the package is valid only for the specified customer. Filter(multi eq)

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

ValidForDistributionChannel

When not null, the package is valid only for the specified distribution channel of the sales order. Filter(multi eq)

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

ValidForPriceList

When not null, the package is valid only for the specified price list. Filter(multi eq)

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

ValidForShipToCustomer

When not null, specifies that the package is valid only when the sales document is for the specified Ship To Customer. Filter(multi eq)

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

ValidForTargetGroup

When not null, the package is valid only for the specified customer target group. Filter(multi eq)

Type: TargetGroups (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

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

Front-End Business Rules

None

API

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

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

Suggest improvement to this page