Table of Contents

Crm.Pricing.BonusProgramProducts

Provides a way to specify additional (to the one specified in Bonus Program.Conditional Product) products, which will be used to evaluate bonus program conditions. When any of the products exists in the sales document, the conditions are satisfied and the program is applied. When the conditional products list for a bonus program is empty, it is considered that the program is valid for all products.

General

Namespace: Crm.Pricing
Repository: Crm.Pricing.BonusProgramProducts
Base Table: Crm_Bonus_Program_Products
API access: ReadWrite

Renames

Old name: Crm.Marketing.BonusProgramProducts
New name: Crm.Pricing.BonusProgramProducts
Version: 25.1.1.36
Case: 37717

Visualization

Display Format: {BonusProgram.Name:T}
Search Members: BonusProgram.Name
Name Member: BonusProgram.Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 1 - Track last changes only
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.Pricing.BonusPrograms
Aggregate Root:
Crm.Pricing.BonusPrograms

Attributes

Name Type Description

References

Name Type Description
BonusProgram BonusPrograms The to which this BonusProgramProduct belongs. Required Filter(multi eq) Owner
Product Products The product which is required to exist in the final sales document in order for the bonus program to be applied

System Attributes

Name Type Description
Id guid
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.
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

Id

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

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

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

Reference Details

BonusProgram

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

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

Product

The product which is required to exist in the final sales document in order for the bonus program to be applied

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

API Methods

Methods that can be invoked in public APIs.

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

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

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

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

GetOrCreateExtensibleDataObject

Gets an existing extensible data object associated with the specified entity, or creates a new one if none exists. The newly created extensible data object is immediately commited to the database.
Return Type: ExtensibleDataObjects
Declaring Type: EntityObject
Domain API Request: GET

GetPropertyAllowedValues

Gets the allowed values for the specified property for this entity object.
Return Type: Collection Of ErpNet.Model.OData.ValueTextPair
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • propertyName
    The name of the attribute or reference
    Type: string

  • search
    The search text - searches by display text. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • 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

Business Rules

None

Front-End Business Rules

None

API

Domain API Entity Set: Crm_Pricing_BonusProgramProducts

Domain API Entity Type: Crm_Pricing_BonusProgramProduct

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

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

Suggest improvement to this page