Employees

Employees belong to a payroll (recorded via that payroll's divisionId) and are the subject of Employee Case Changes - entry, salary, personal details, absences, and more.

• Employee object holds only: identifier, firstName, lastName - kept separate from case data, so a platform can build employee-centric features (e.g. a directory) without reading through case history
• Creating a new employee: via POST /tenants/{orgId}/employees with identifier, name and division - then add further data (salary, personal details, etc.) as case changes
• Adding employees before onboarding is finished: possible any time - the two are independent, though completing company details first is recommended
• Adjusting name/identifier: possible any time via PUT /tenants/{orgId}/employees/{employeeId} - these are direct record fields, applied immediately, not time-versioned case values like most other employee data
• Deleting an employee: not currently supported by the API, even for an empty record
• Employees shown in the list: currently employed ones, by default
• Showing former employees: a "Hide former employees" filter exists on the list - turn it off to see them too
• Everything else (missing data, documents): see Employee Data and Case Data - same as company level, just scoped to the employee
• Seeing what's missing for an employee: see the missing-data endpoints under Case Data
• Self-service ideas: see Ideas for Employee Experience / Self Service Portal below

API Endpoints

Employee Self Service (ESS) Portal

ESS is the portal where employees access their own payroll data directly, without going through HR for every small change. It reuses the regular case-change, missing-data and document endpoints above, scoped to the logged-in employee's own record - there is no separate ESS-only API surface.

• Report data: certain Employee Case Changes - e.g. address or bank account changes
• Complete missing data: via the missing-data endpoints under Case Data - when something required is outstanding
• View documents: payslips, salary certificates, contracts
• Access: employees use their existing account if you've connected your IAM - see User / Authentication for the two ways to set that up; no separate ESS login needed
• Scope: strictly limited to their own employee record - no visibility into other employees' or company data
• Which cases: the ESS and ECT clusters - e.g. address, partner details or personal data. Wage-relevant data is not included.

to Feature Map