Record agreed base compensation
Compensation stores the agreed base amount and pay terms. It is not a payslip, payroll calculation, payment instruction or tax engine. Access needs EMPLOYEE_COMPENSATION and the separate compensation read/manage rights.
Field reference
| Field | Rule | Example |
|---|---|---|
| Employment Id | Required employment of the same employee | Employment #401 |
| Effective From / To | Required start, optional end; contained and non-overlapping | 1 October onward |
| Base Amount | Required, zero or greater; max 15 integer and 4 fractional digits | 2400.0000 |
| Currency Code | Required three uppercase letters; use approved actual currency | GBP |
| Pay Basis | HOURLY, DAILY, WEEKLY, MONTHLY or ANNUAL | MONTHLY |
| Pay Frequency | WEEKLY, FORTNIGHTLY, FOUR_WEEKLY, SEMIMONTHLY or MONTHLY | MONTHLY |
| Salary Grade / Salary Step | Optional text references, max 50 each | G2 / S1 |
| Overtime Eligible | Required explicit Yes/No | No |
| Bonus Target Percent | Optional 0–1000; up to four decimals | 5.0000 |
| Review Date | Optional administrative review date | 2027-04-01 |
| Change Reason | Required, max 500 | Initial approved agreement |
The broad accepted numeric range is a validation limit, not a recommendation or policy default. The currency field validates the three-letter format; do not infer that Employee performs FX or complete downstream currency validation.
Create and inspect
- Open Compensation → Add compensation.
- Select employment, dates and the approved amount.
- Review both Pay Basis and Pay Frequency explicitly.
- Complete required overtime eligibility and other approved terms.
- Enter the reason, save and reload the record.
- Confirm unit-scope access to the linked employer and the resulting period.
Meaning examples
GBP 2,400 with MONTHLY basis means an agreed amount per month. GBP 28,800 with ANNUAL basis and MONTHLY frequency remains an annual-basis agreement here; Employee does not divide it by 12. GBP 15.50 HOURLY does not multiply itself by weekly hours or FTE.
Overtime Eligible records eligibility, not approved overtime hours or an overtime rate. Bonus Target Percent records a target, not an automatic earned bonus. Benefit enrolment does not create a compensation deduction.
If a pay period overlaps, close its predecessor before adding the next. If a salary tab is hidden, check feature and read rights; master/status permissions alone do not open it. See Pay changes and Payroll handoff before changing an agreement used downstream.