ProgramRebateTypeBenefit

Defines the benefit matrix for the rebate type. For example, 5% or $200. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

BenefitValue

Type: double
Properties: Create, Filter, Sort, Update
Description: Rebate benefit at a level. For example, 3%, $3000.

EffectiveEndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date until when the program rebate type benefit is effective. If the date does not match a payout period end date, it isn’t picked.

EffectiveStartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date from when the program rebate type benefit is effective. If the date does not match a payout period start date, it isn’t picked.

MaximumMeasureFieldValue

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Cap the measure value at a certain figure. For example, pay 1% on $100,000 even when the members do more than that.

MaximumQualifyingValue

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Upper limit of quantity or revenue at a level.

MinimumQualifyingValue

Type: double
Properties: Create, Filter, Sort, Update
Description: Minimum quantity or revenue required to qualify to a level.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the qualification. For example, Tier 1/2/3, Gold/Silver.

ProductId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Use this if the benefits vary by products. For example, Product A has a tier from 1- 100 units for $20 and Product B has 1-100 units at $19.

To use product or any dimension to the benefits, add that field in benefit mapping

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: Status of the program rebate type benefit.
Possible values:
- Active
- Inactive
- Closed

BenefitType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of tier assigned to this benefit.
Possible values:
- Accrual
- Payout
- PayoutAndAccrual—Payout And Accrual

Usage

The benefit table can be extended with custom columns, for example, Region. The benefits can then be configured as: APAC 3%, USA 2%, and so on.