ProgramRebateType

Provide the rebate types that are part of this program. For example, volume rebate, revenue rebate, or rebate on every transaction. 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

AccrualRate

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The rate you want to accrue at for the rebate program member. This rate is in the same units as the specified measure type, for example percent or amount. This field is available in API version 52.0 and later.

AggregateObjectName

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Name of the custom aggregation entity. For example, RebateMemberProductAggregate.

BenefitQualifierField

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Represents an attribute in the aggregate object whose value will be used, in conjunction with Aggregate Field and Rebate Type Benefit Field attributes from the PgmRebateTypBnftMapping entity, to determine the Benefit Value from the ProgramRebateTypeBenefit entity.
Possible values:
- GrowthAmount—Rebate Member Product Aggregate:Growth Amount.
- GrowthAmountPercent—Rebate Member Product Aggregate:Growth Amount Percent.
- GrowthQuantity—Rebate Member Product Aggregate:Growth Quantity.
- GrowthQuantityPercent—Rebate Member Product Aggregate:Growth Quantity Percent.
- PriorTotalQuantity—Rebate Member Product Aggregate:Prior Total Quantity.
- PriorTotalTransactionAmount—Rebate Member Product Aggregate:Prior Total Transaction Amount.
- TotalQuantity—Rebate Member Product Aggregate:Total Quantity.
- TotalTransactionAmount—Rebate Member Product Aggregate:Total Transaction Amount.

CalcObjectId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the data processing engine definition used for the calculation. Only active data processing engine definitions can be used.
Possible values:
- Aggregate By Member
- Aggregate By Product
- Account Hierarchy Member Aggregate
- Process Per Transaction
- Ship and Debit Member Aggregate
- Year on Year Growth

CalculationBasis

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specify the basis for rebate amount calculation. This field is available in API version 52.0 and later.
Default value: Payout
Possible values:
- Accrual: Accrual rate, if provided, or the benefit setup is used to calculate the rebate amount.
- Payout: Benefit setup is used to calculate the rebate amount.
- PayoutAndAccrual—Payout and Accrual: Benefit setup is used for payout , and accrual rate for accrual amount.

CalculationMethod

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the rule for calculating rebate benefits.
Possible values:
- Retrospective
- Stepped

CalculationType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Type of calculation for the rebate type.
Possible values:
- AggregateBased
- Custom
- GrowthBased
- PerTransaction
- Hierarchical Aggregation Based

FilterCriteria

Type: textarea
Properties: Nillable
Description: Stores the rebate type filter definition in JSON format, which will be consumed by the Calc object.

FilterLogic

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Contains the filter criteria options that are offered - AND, OR, Custom.

IsInTransitQtyApplicable

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Determine eligibility to include or exclude in-transit quantities
Default value: false

IsIntegratable

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: This field determines if the rebate type record is of type template or not, based on which the record can be associated with an opportunity,contract, quote, or any other eligible object.
Default value: false

MeasureField

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Stores the reference to the aggregate object that will be used for rebate amount calculations based on the measure type selected and the benefit value fetched.
Possible values:
- GrowthAmount—Rebate Member Product Aggregate:Growth Amount.
- GrowthAmountPercent—Rebate Member Product Aggregate:Growth Amount Percent.
- GrowthQuantity—Rebate Member Product Aggregate:Growth Quantity.
- GrowthQuantityPercent—Rebate Member Product Aggregate:Growth Quantity Percent.
- PriorTotalQuantity—Rebate Member Product Aggregate:Prior Total Quantity.
- PriorTotalTransactionAmount—Rebate Member Product Aggregate:Prior Total Transaction Amount.
- TotalQuantity—Rebate Member Product Aggregate:Total Quantity.
- TotalTransactionAmount—Rebate Member Product Aggregate:Total Transaction Amount.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the program rebate type.

ProductFilterType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The criteria to be applied for the products present in the Included or Excluded Products list.
Possible values:
- ExcludeProducts—Exclude Products
- IncludeProducts—Include Products

RebateMeasureType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Type of rebate.
Possible values:
- AmountperUnit
- Custom
- FixedAmount
- PercentageOfRevenue

RebateProgramId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: Reference to the rebate program.

Status

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

UnitOfMeasureId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measure associated with the program rebate type. This field is available in API version 52.0 and later.

This is a relationship field.
Relationship Name: UnitOfMeasure
Relationship Type: Lookup
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/Duration of inventory eligibility for price protection

ValidityDurationType

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The unit of measure for the validity duration.
Default value: Years
Possible values:
- Days
- Months
- Years

SourceMatchingField

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The criteria used to find the related rebate program member for a transaction journal record.
Possible values:
- AccountId—Account
- DestinationLocationId—Destination Location
- JournalTypeId—Journal Type
- MemberId—Program Member
- OrderId—Order
- OrderItemId—Order Product
- ProductCategoryId—Product Category
- ProductId—Product
- QuantityUnitOfMeasureId—Quantity Unit
- RelatedJournalId—Related Journal
- ShipToAccountId—Ship To Account
- SourceLocationId—Source Location
- UserRecordAccessId—Object Access Level

AccrualCalculationMethod

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the calculation method for accrual amount. If not specified, the payout calculation method will be used.
Possible values:
- Retroactive
- Stepped

AggregationCriteria

Type: textarea
Properties: Nillable
Description: Stores the PoS aggregation criteria in JSON format, which will be consumed in the batch transform.

ExecutionType

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Specifies the execution platform used to calculate payout and accrual amounts.
Possible values:
- Classic
- NextGen

AggCriteriaLastCalcDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date and time when the aggregation criteria for the rebate type were last calculated.

This field is a calculated field.

Usage

Each program can have multiple rebate types. For example, buy 100 units and get 2% revenue back, buy 10 units of petrol engines and get 1% rebate, and so on. If you want to give tiered benefits, select the Benefit Qualifier Field. For example, to give a tiered benefit of $5 for 0–100 units and $10 for 101–500 units, select Total Quantity in the Benefit Qualifier Field when the Measure Type is Total Quantity.