The payout header for one incentive period of an incentive plan in the Rewards app. Process Compensation on the incentive period creates it once per period with Status Draft, copies the plan's account, branch and currency, adds one Compensation Line per plan member and sets Total Incentive Amount to the sum of the current members' lines (Override Incentive Amount first, then Incentive Amount). Later runs reuse the period's oldest record. New records are numbered from the COMP series. The header creates no journal, payment, payroll adjustment or claim, and no claim process marks it; payout is recorded on each line with Is Compensation Received. Deleting a header does not delete its lines.
Fields
| Field | Label | Type | Required | What it does |
|---|
BranchId | Branch | Lookup → Branch | | The branch the plan is scoped to. Copied from the plan when Process Compensation creates the record and never refreshed. Informational; nothing reads it. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
CurrencyIsoCode | Currency ISO Code | Text | | The plan's currency code, copied when Process Compensation creates the record. Not on the seeded forms. |
Id | Id | Guid | Yes | |
IncentivePeriodId | Incentive Period | Lookup → IncentivePeriod | | The period this record covers. Process Compensation finds a period's record by this field alone and uses the oldest one. The picker is not filtered by plan. |
IncentivePlanId | Incentive Plan | Lookup → IncentivePlan | | The plan this record pays out. Set by Process Compensation from the period's plan. Informational: the incentive engine scores each line against the plan stored on the line. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | The record number, set automatically from the COMP numbering series on create, including for records Process Compensation creates, so it never carries the period's name. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Account | Lookup → Account | | The partner account the plan is scoped to. Copied from the plan when Process Compensation creates the record and never refreshed. Informational; nothing reads it. |
RecordTypeId | Record Type | Guid, hidden | | |
Status | Status | PickList | | The review state of the record. Process Compensation writes Draft when it creates the record; nothing else reads or changes it. The picklist ships with no values, so an administrator adds the review states (and Draft). The Incentives & Targets dashboard groups totals by it. |
TotalIncentiveAmount | Total Incentive Amount | Calculated | | What the period pays in total. Written by every Process Compensation run as the sum of the current members' lines, using Override Incentive Amount where set and Incentive Amount otherwise; paid lines are included and lines of former members are left out. Saving a line does not update it. Editable through Edit, but the next run replaces it. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete |
Edit | Edit | Edit | Edit |
New | New | New | New |
