workerGroupId
| Synopsis | An identifier used to link employees to their worker group. |
| Where used | /accounts/{accountId} response /contributions request |
A Worker Group is a group of employees who have the same pension contribution level.
The set of available worker groups is returned as part of the /accounts/{accountId} response.
Each employee should be assigned to a worker group. Within a payroll system there may already be a similar entity that groups employees together. Some employers consider aligning these groups when setting up a worker group.
The worker group id is then included in the /contributions request for each employee. We use the worker group id to identify the expected contribution levels for members within the scheme. These levels are included in the joiner information we send to them.
| Data type | String |
| Constraints/format | maxLength: 40 May contain any alphanumeric character, and non-alphanumeric characters other than '+'. The value provided in the contributions request must be a case-sensitive match with one of the existing worker groups on the account. |
| Example | ... |
| Related errors |
D/U01 – worker group id exceeds 40 characters D/U02 – worker group id does not exist D/U03 – worker group id is missing D/U05 – account has no worker groups |
| See also |