BonusProgram Properties |
The BonusProgram type exposes the following members.
| Name | Description | |
|---|---|---|
| Active | General condition if the bonus is active. The other conditions are verified only for active bonus programs. [Default(true)] [Filter(eq)] | |
| BonusAction | Bonus action: P-Add product to the order, A-Add amount, D-Give discount. [Required] [Default("D")] [Filter(multi eq)] | |
| BonusDocumentAmountPercent | The percent of the document amount that is rewarded. Should be null if and only if the bonus document amount is null. | |
| BonusDocumentAmountType | 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)] | |
| BonusLineDiscountPercent | The percent discount to be applied to bonus lines. Used only for bonus programs with Action = D (Discount). [Required] [Default(0)] | |
| BonusProduct | The product that is rewarded if the bonus conditions are met. null means that the bonus reward is not product. [Filter(multi eq)] | |
| BonusProductQuantity | The quantity rewarded of the bonus product. Should be not null if and only when the bonus product is not null. [Unit: BonusProductQuantityUnit] | |
| BonusProductQuantityMultiplierForEachLotSize | 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] | |
| BonusProductQuantityUnit | 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)] | |
| ChangingAttributes |
Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.
(Inherited from EditableDomainObject.) | |
| CompanyLocation | When set, specifies that the sales document must be of the specified enterprise company location. [Filter(multi eq)] | |
| ConditionCustomer | When not null, specifies that the bonus should be applied only to the specified customer. [Filter(multi eq)] | |
| ConditionCustomerFilterXML | When not null, specifies that the bonus should be applied only to customers who meet the specified criteria. The criteria could include custom properties. | |
| ConditionDistributionChannel | When not null, specifies that the bonus should be applied only when the specified channel is used. [Filter(multi eq)] | |
| ConditionDistributionChannelFilterXML | When not null, specifies that the bonus should be applied only when the distribution channel of the sales order has the specified characteristics. | |
| ConditionDocumentCurrency | Condition for the document amount. Should be not null if any of the amount conditions are not null. [Filter(multi eq)] | |
| ConditionFromDate | Starting date of the bonus. null means that there is no starting date restriction. [Filter(eq;ge;le)] | |
| ConditionMaxAmount | 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)] | |
| ConditionMaxQuantity | 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)] | |
| ConditionMinAmount | 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)] | |
| ConditionMinQuantity | 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)] | |
| ConditionPriceList | 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)] | |
| ConditionProduct | 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)] | |
| ConditionProductGroup | When not null, specifies that the bonus should be applied only to products from the specified product group or its subgroups. [Filter(multi eq)] | |
| ConditionShipToCustomer | When not null, specifies that the bonus should be applied only when shipping to the specified customer. [Filter(multi eq)] | |
| ConditionShipToCustomerFilterXML | When not null, specifies that the bonus should be applied only when shipping to customer with the specified characteristics. | |
| ConditionTargetGroup | When not null, specifies that the bonus should be applied only to the specified target customer group. [Filter(multi eq)] | |
| ConditionToDate | Ending date (inclusive) of the bonus. null means that there is no ending date restriction. [Filter(eq;ge;le)] | |
| CustomProperties |
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.) | |
| EnterpriseCompany | When set, specifies that the sales document must be of the specified enterprise company. [Filter(multi eq)] | |
| ExtendedProperties |
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.) | |
| HasProductCondition |
Gets a value indicating whether this instance has product condition.
| |
| Id |
The unique Id of the entity object
(Inherited from EntityObject.) | |
| IsGhost |
Returns true when the object is a ghost object
(Inherited from EntityObject.) | |
| IsLoaded | Gets a value indicating whether the associated data for this domain object is loaded. (Overrides EntityObjectIsLoaded.) | |
| ItemString |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) | |
| ItemIDataAttribute |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) | |
| Name | The name of the bonus program. [Required] [Filter(eq;like)] | |
| NoEvents |
Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.
(Inherited from DomainObject.) | |
| ObjectState | Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.) | |
| Priority | Priority (1-5) of the bonus program comparative to the other bonus programs. 1 is the lowest priority. [Required] [Default(2)] [Filter(multi eq)] | |
| Products | List of BonusProgramProduct child objects, based on the Crm.Marketing.BonusProgramProduct.BonusProgram back reference | |
| Repository | Provides access to BonusProgramsRepository repository methods | |
| Transaction |
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.) |