RebateProgramMemberPayout

The payout calculated for a member for the period. For example, $1000 Jan’21 payout for ABC enterprises. 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 payout amount accrued by the rebate program member.

    This is a calculated field.

CalculatedRebateAmount 

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description: Total amount calculated.

    This is a calculated field.

CalculationDate 

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date on which the calculation happened.

MemberId 

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: Program member ID.

Name 

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

Status 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

  • Description: Status of payout.

  • Possible values:

    • Approved
    • Interim—Calculation In progress.
    • Pending—Under review.
    • Rejected
    • SystemCalculated—Calculated.

TotalApprovedAdjustmentAmount 

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description: Summarized payout adjustment amount.

    This is a calculated field.

TotalRebateAmount 

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description: Summarized payout amount.

    This is a calculated field.

ExternalReferenceNumber 

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

FinalPayoutAmount 

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description: The final payout amount, including the base calculation and all adjustments.

    This field is a calculated field.

TotalCalcPayoutAmt 

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description: The base payout amount as calculated, before any adjustments.

    This field is a calculated field.