General purpose points allocation rule that computes points as a sales record's amount, optionally multiplied and/or added to by fixed configured values, and optionally restricted to a group, an organisation type, or a matching custom field value. Registered as a built-in PointsRuleType (id "simple-rule") that account admins can select when configuring a points allocation source; it is the platform's default rule type.

Implements: PointsRuleType


Properties

PropertyReturnsDescription
fieldsList<ExtraField>The configuration fields presented for this rule type: the group and organisation type to restrict to, a multiplier and an amount to add to the sale value, and an optional custom field name and values to match sales records against.
idStringThe unique identifier used to select this rule type when configuring a points allocation source.
titleStringThe display title shown for this rule type in the points allocation source configuration UI.

Methods

getId()

Returns: String

The unique identifier used to select this rule type when configuring a points allocation source.

getTitle()

Returns: String

The display title shown for this rule type in the points allocation source configuration UI.

getFields()

Returns: List<ExtraField>

The configuration fields presented for this rule type: the group and organisation type to restrict to, a multiplier and an amount to add to the sale value, and an optional custom field name and values to match sales records against.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.