ProgramRebateTypePayout

The payout given to a member for a particular rebate type. For example, volume rebate payout in Jan’19 for ABC enterprises is $560, petrol engine payout for ABC in Jan’19 is $440. 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

AccruedAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: The accrued amount for the program rebate type payout.

This is a calculated field.

Name

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

ProgramRebateTypeId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Unique identifier for the program rebate type.

RebateAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: Rebate amount.

This is a calculated field.

RebateProgramMemberPayoutId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Unique identifier of the rebate program member payout.

TotalBenefitQualifierValue

Type: double
Properties: Filter, Nillable, Sort
Description: Roll-up summary of the Benefit Qualifier Value from the Program Rebate Type Payout Source entity.

This is a calculated field.

TotalMeasureValue

Type: double
Properties: Filter, Nillable, Sort
Description: Roll-up summary for the Measure Value field from the Program Rebate Type Payout Source entity.

This is a calculated field.

ExternalReferenceNumber

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The reference number of an Member Accrual, used in a Data Processing Engine definition.

CalculatedPayoutAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: The rebate amount calculated for the rebate type.

This field is a calculated field.

TotalPayoutAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: The total rebate amount for this rebate type, including all approved rate adjustments.

This field is a calculated field.

TotalRateAdjustedAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: The total amount of adjustments due to rate changes applied to this rebate type payout.

This field is a calculated field.

TotalPriorPeriodAdjAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: The total amount of adjustments carried over from a previous payout period to be applied to this payout.

This field is a calculated field.