BonusProgram Class

Initializes a new instance of the BonusProgram class with specific ObjectTransaction

General condition if the bonus is active. The other conditions are verified only for active bonus programs. [Default(true)] [Filter(eq)]

Bonus action: P-Add product to the order, A-Add amount, D-Give discount. [Required] [Default("D")] [Filter(multi eq)]

The percent of the document amount that is rewarded. Should be null if and only if the bonus document amount is null.

When not null specifies that a document amount should be added to the order when the bonus conditions are met. null means that the bonus reward is not a document amount. [Filter(multi eq)]

The percent discount to be applied to bonus lines. Used only for bonus programs with Action = D (Discount). [Required] [Default(0)]

The product that is rewarded if the bonus conditions are met. null means that the bonus reward is not product. [Filter(multi eq)]

The quantity rewarded of the bonus product. Should be not null if and only when the bonus product is not null. [Unit: BonusProductQuantityUnit]

When not null, specifies that the bonus quantity should be multiplied for each of the specified lot size. Can be non-null only when condition product is specified. [Unit: ConditionProduct.BaseMeasurementCategory.BaseUnit]

The measurement unit of the quantity rewarded of the bonus product. Should be not null if and only when the bonus product is not null. [Filter(multi eq)]

Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.

When set, specifies that the sales document must be of the specified enterprise company location. [Filter(multi eq)]

When not null, specifies that the bonus should be applied only to the specified customer. [Filter(multi eq)]

When not null, specifies that the bonus should be applied only to customers who meet the specified criteria. The criteria could include custom properties.

When not null, specifies that the bonus should be applied only when the specified channel is used. [Filter(multi eq)]

When not null, specifies that the bonus should be applied only when the distribution channel of the sales order has the specified characteristics.

Condition for the document amount. Should be not null if any of the amount conditions are not null. [Filter(multi eq)]

Starting date of the bonus. null means that there is no starting date restriction. [Filter(eq;ge;le)]

If not null specifies the maximal amount for which the bonus is valid. null means that there is no maximal amount condition for the bonus. [Currency: ConditionDocumentCurrency] [Filter(eq;ge;le)]

When not null, specifies condition for the bonus - maximal quantity of the condition product. If the condition product is null, this cannot be specified. [Unit: ConditionProduct.BaseMeasurementCategory.BaseUnit] [Filter(eq;ge;le)]

If not null specifies the minimal amount for which the bonus is valid. null means that there is no minimal amount condition for the bonus. [Currency: ConditionDocumentCurrency] [Filter(eq;ge;le)]

When not null, specifies condition for the bonus - minimal quantity of the condition product. If the condition product is null, this cannot be specified. [Unit: ConditionProduct.BaseMeasurementCategory.BaseUnit] [Filter(eq;ge;le)]

When not null, specifies that the bonus should be applied only when the sales order is based on the speicfied price list. [Filter(multi eq)]

When not null, specifies a conditional product, which is required to exist in the sales document in order for the bonus program to be applied. If a condition with multiple products is required, additional products can be added to Bonus Program Products. If null the other conditions should be evaluated against the whole order. [Filter(multi eq)]

When not null, specifies that the bonus should be applied only to products from the specified product group or its subgroups. [Filter(multi eq)]

When not null, specifies that the bonus should be applied only when shipping to the specified customer. [Filter(multi eq)]

When not null, specifies that the bonus should be applied only when shipping to customer with the specified characteristics.

When not null, specifies that the bonus should be applied only to the specified target customer group. [Filter(multi eq)]

Ending date (inclusive) of the bonus. null means that there is no ending date restriction. [Filter(eq;ge;le)]

Gets the custom properties of the object.

When set, specifies that the sales document must be of the specified enterprise company. [Filter(multi eq)]

Extended properties contain temporary (not persisted) values in the object instance.

Gets a value indicating whether this instance has product condition.

The unique Id of the entity object

Returns true when the object is a ghost object

Gets a value indicating whether the associated data for this domain object is loaded.

Gets or sets the value of a data attribute

Gets or sets the value of a data attribute

The name of the bonus program. [Required] [Filter(eq;like)]

Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.

Gets the state of the domain object.

Priority (1-5) of the bonus program comparative to the other bonus programs. 1 is the lowest priority. [Required] [Default(2)] [Filter(multi eq)]

List of BonusProgramProduct child objects, based on the Crm.Marketing.BonusProgramProduct.BonusProgram back reference

Provides access to BonusProgramsRepository repository methods

The EnterpriseOne transaction to which this object is attached.

Deletes the domain object.

Creates a copy of the object.

Determines whether the specified Object, is equal to this instance.

Indicates whether the current object is equal to another object of the same type.

Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event.

Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null.

Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object.

Gets the condition products.

Returns a hash code for this instance.

Gets the related objects which would need validation upon validation of this object.

Invalidates the cached condition products.

Determines whether this bonus program is applicable to the specified product.

Issues a warning with the specified message.

Issues a warning with the specified message. The message can contain standard string placeholders.

Returns true if this entity object matches the specified filter.

Matches the filter against the specified row and returns the result of the match.

Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed.

Returns a String that represents this instance.

Returns a String that represents this instance.

Tries to get the specified attribute and returns it or null, when it is not found.

Recalculates the default values for all objects in the aggregate.

Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default.

Converts the object to string based on the format specified.

Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist.

Returns an ExtensibleDataObject related to the entity object. If such object doesn't exist the object is created in the same transaction.

Recalculates the values of a master attributes in a master-detail relationship.

Recalculates the missing values using the first reactive expression of the attributes.