Maintain benefit enrolments
Benefits record participation in a tenant-described plan during an employment period. They do not create insurance cover with a provider, calculate deductions or infer eligibility from dependant flags automatically.
Fields
| Field | Rule |
|---|---|
| Employment Id | Required employment belonging to the same employee |
| Plan Code | Required text, max 50 |
| Benefit Type | Required text, max 50 |
| Provider Name | Optional, max 150 |
| Membership Reference | Optional private reference, max 100 |
| Effective From / To | Required start, optional end; contained in employment |
| Coverage Level | Optional text, max 50 |
| Status | ENROLLED, SUSPENDED or ENDED |
| Notes | Optional, max 1000 |
You need EMPLOYEE_BENEFITS and benefit view/manage rights. Compensation access alone does not open Benefits. Benefit plan/type/coverage are text references, not lookups against a complete plan master.
Add or maintain
- Open Benefits → Add benefits.
- Select the correct employment and approved plan code.
- Enter dates, coverage/provider/reference where needed and the truthful status.
- Save and reload to verify period and status.
- To end, use Edit / close, set ENDED and supply Effective To.
Period rules
Same-plan enrolments cannot overlap, including shared boundary days. Different plan codes can coexist where appropriate. Changing only status to SUSPENDED does not free the period for an overlapping duplicate of the same plan. ENDED requires an end date, and the full period must fit the parent employment.
Example: HEALTH-A ends 30 November; its successor under the same code can start 1 December. Saving ENDED with no Effective To is refused. Closing employment first is also refused if the benefit still extends past the proposed employment end.
Recovery and Payroll connection
If a plan overlap occurs, inspect all same-plan periods and exact codes before creating another. The backend compares the entered plan code; maintain consistent tenant naming rather than using spelling/case variations to evade overlap checks.
Payroll can include overlapping benefit source records in its snapshot when the feature is enabled. That does not automatically value them, exclude all suspended records or create a deduction. The Payroll preparer must use its own approved component and amount workflow. If the feature is disabled, absence from a snapshot does not mean historical benefit records were deleted.