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 are:
-
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 are:
- 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.
- Possible values are:
-
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.
- The default value is 'Payout'.
|
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 are:
|
CalculationType |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Type of calculation for the rebate type.
- Possible values are:
- AggregateBased
- Custom
- GrowthBased
- PerTransaction
|
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.
|
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.
- The default value is '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 are:
-
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 are:
-
ExcludeProducts—Exclude
Products
-
IncludeProducts—Include
Products
|
RebateMeasureType |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Type of rebate.
- Possible values are:
- 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 are:
|
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
|