RebateProgramPayoutPeriod

The period of the payout calculation. For example, 1st to 31st Jan, or 1st Dec to 14th Dec. 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

Field Details
EndDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
End date of the period. The system picks transactions between start date and end date of the period for rebate calculations.
LastCalculationDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Last date on which the rebate amount calculation for that period for all the relevant aggregate records was completed successfully.
MemberPayoutCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Used to track total number of payouts that happened in a period for a particular rebate program.
PayoutCalculationDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Date on or after which the payout calculation for this period is set to Closed.
RebateProgramId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Rebate program identifier.
StartDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Start date of the period.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Used to track if a payout period is active or inactive.
Possible values are:
  • Active
  • Closed
  • Inactive
TotalApprovedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total approved member payout amount.
TotalRejectedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total rejected amount.
TransactionGracePeriodDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Cut-off date before which the transactions are accepted for the period.