| Name / Description | Type / Format | Example | |
|---|---|---|---|
id
The employee unique id
|
string
uuid
|
"string"
|
|
birthDate
The employees date of birth
|
string
date
|
"2025-12-01"
|
|
age
The employees age at assessment
|
integer
int32
|
0
|
|
startDate
The employees start date
|
string
date
|
"2025-12-01"
|
|
leaveDate
The employees leave date, if applicable
|
string
date
|
"2025-12-01"
|
|
isExempt
The employee is exempt
|
boolean
|
true
|
|
roles
The roles for the employee
|
AeRole[]
|
{AeRole}
|
|
pensions
The pensions for the employee
|
AePension[]
|
{AePension}
|
|
statePensionAge
The state pension age date for the employee
|
integer
int32
|
0
|
|
postponementDate
The postponement date for the employee, if applicable
|
string
date
|
"2025-12-01"
|
|
defaultPensionSchemeId
The default pension scheme for the employee, if applicable
|
string
uuid
|
"string"
|
|
defaultWorkerGroupId
The default worker group for the employee, if applicable
|
string
uuid
|
"string"
|
{
"id": "string",
"birthDate": "2025-12-01",
"age": 0,
"startDate": "2025-12-01",
"leaveDate": "2025-12-01",
"isExempt": true,
"roles": [
{
"id": "string",
"startDate": "2025-12-01",
"endDate": "2025-12-01",
"earnings": 0.0,
"defaultPensionSchemeId": "string",
"defaultWorkerGroupId": "string"
}
],
"pensions": [
{
"id": "string",
"pensionSchemeId": "string",
"workerGroupId": "string",
"roleIds": [
"string"
],
"startDate": "2025-12-01",
"endDate": "2025-12-01",
"endReason": "OptOut",
"revertedRoleIds": [
"string"
],
"isNew": true
}
],
"statePensionAge": 0,
"postponementDate": "2025-12-01",
"defaultPensionSchemeId": "string",
"defaultWorkerGroupId": "string"
}- none -
- none -