Employees belong to a payroll - technically, an employee is recorded under a payroll via that payroll's divisionId. They're the subject of Employee Case Changes - entry, salary, personal details, absences, and more.
The Employee object itself only holds identifier, firstName and lastName, kept deliberately separate from case data - so a platform can build employee-centric features beyond payroll (e.g. an employee directory) without needing to read through case history. For everything else about an employee - missing data, self-service, documents - see the Employee Data incl. Documents and New CaseChanges pages; it works the same way as at company level, just scoped to the individual employee.
FAQ
Is an employee scoped to a tenant or a payroll?
A payroll - technically via the payroll's divisionId. "List all employees" returns everyone in the tenant, "List employees of a payroll" scopes to one payroll.
How do I see what's missing for an employee?
How do I create a new employee?
POST /tenants/{orgId}/employees with just identifier/name/division first, then add their personal and salary data as regular case changes afterward.
Can I adjust a created employee's name/identifier? From when does that apply?
Yes, via PUT .../employees/{employeeId} - these are direct record fields, applied immediately, not time-versioned case values like most other employee data.
Can I delete an employee that's only a "shell" record (no personal data yet)? What about one with data already?
The API supports deleting an employee either way (DELETE /employees/{employeeId}), but this isn't exposed in the standard product frontend at any stage - it would need to go through the API directly or support.
Which employees show up in the list?
Currently employed ones, by default.
Can I show former employees?
Yes - there's a "Hide former employees" filter on the employee list; turn it off to see them too.
Can I add employees during onboarding, even if company onboarding isn't finished yet?
Yes - adding employees isn't gated on company onboarding being complete; the two are independent. Nevertheless, it is strongly recommended that you complete the company details first before entering employee details.
API Endpoints
| What | Call |
|---|---|
| List all employees | GET /tenants/{orgId}/employees |
| List employees of a payroll | GET /tenants/{orgId}/payrolls/{payrollId}/employees |
| Get an employee | GET /tenants/{orgId}/payrolls/{payrollId}/employees/{employeeId} |
| Create an employee | POST /tenants/{orgId}/employees |
| Update an employee | PUT /tenants/{orgId}/employees/{employeeId} |