ProgramRebateType

Represents a rebate structure associated with a Rebate Program. This object is available in API version 63.0 and later.

A ProgramRebateType record is created to define how benefits are calculated—such as accruals, payouts, or both—based on specified measure fields and logic.

Supported Calls

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

Fields

Field Details
AccrualRate
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description

The rate of accrual based on the value selected in the Measure Type field. For example, when the measure type is percent and you enter 10, the accrual rate is 10%.

AggregateObjectName
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description

The object that stores the aggregation results.

BenefitQualifierField
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description

The field on the aggregation object used to define thresholds for qualifying benefits (minimum or maximum).

CalcObjectId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Links to a calculation definition from the Data Processing Engine.
This field is a relationship field.
Relationship Name
CalcObject
Refers To
BatchCalcJobDefinition
CalculationBasis
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the method used to calculate the rebate amount.
Possible values are:
  • Accrual
  • Payout
  • PayoutAndAccrual—Payout and Accrual
The default value is Payout.
CalculationMethod
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Defines how tiered rebate benefits are calculated.
Possible values are:
  • Retrospective
  • Stepped
The default value is Retrospective.
CalculationType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of rebate calculation logic to use.
Possible values are:
  • AggregateBased—Aggregate Based
  • Custom
  • GrowthBased—Growth Based
  • PerTransaction—Per Transaction
ExecutionProcedureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Links to business rules that define custom execution logic.
This field is a relationship field.
Relationship Name
ExecutionProcedure
Refers To
ExpressionSet
FilterAction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Logical operator to apply between filter conditions.
Possible values are:
  • AllConditionsMet—All Conditions Are Met (AND)
  • AnyConditionMet—Any Condition Is Met (OR)
  • CustomLogic—Custom Condition Logic
  • NoConditionsMet—No Conditions Are Met
FilterCriteria
Type
textarea
Properties
Nillable
Description

Holds the filter conditions in textual format. Used to define eligibility criteria for rebate qualification.

FilterLogic
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

Logical formula used to combine filter conditions, typically using field references and logical operators.

IsIntegratable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
When selected, allows this rebate type to be applied on transactional records such as orders or opportunities.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and the timestamp when the record was last referenced by the user. Useful for user activity tracking.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and the timestamp when the record was last opened or viewed. Tracks user interaction history.
MeasureField
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description

The aggregation object field used with measure type and benefit value to calculate the rebate amount. This is required for the Amount per Unit and Percentage of Revenue measure types.

Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description

Unique name that identifies the rebate type configuration. Used as a reference label across related components.

OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Identifies the user or group that owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
ProductFilterType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether the rebate applies to included or excluded products.
Possible values are:
  • ExcludeProducts—Exclude Products
  • IncludeProducts—Include Products
RebateMeasureType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the method to measure benefit payout.
Possible values are:
  • AmountperUnit—Amount per Unit
  • Custom
  • FixedAmount—Fixed Amount
  • PercentageOfRevenue—Percentage of Revenue
RebateProgramId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Links this rebate type to its parent rebate program.
This field is a relationship field.
Relationship Name
RebateProgram
Relationship Type
Master-detail
Refers To
RebateProgram (the master object)
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies whether the rebate type is currently active.
Possible values are:
  • Active
  • Inactive
The default value is Inactive.
UnitOfMeasureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies the unit of measure associated with the rebate type.
This field is a relationship field.
Relationship Name
UnitOfMeasure
Refers To
UnitOfMeasure
ValidityDuration
Type
int
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Duration for which the inventory is eligible for price protection.
ValidityDurationType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Unit of time used to measure ValidityDuration.
Possible values are:
  • Days
  • Months
  • Years
The default value is Years.