| Name / Description | Type / Format | Example | |
|---|---|---|---|
employeeId
The employee ID associated with this assessment
|
string
uuid
|
"string"
|
|
employeeRoleId
Employee role ID associated with this assessment, if applicable
|
string
uuid
|
"string"
|
|
payRunId
The pay run ID that triggered this assessment (optional)
|
string
uuid
|
"string"
|
|
assessmentDate
Assessment date
|
string
date
|
"2025-06-28"
|
|
startDate
Start date of assessment period
|
string
date
|
"2025-06-28"
|
|
endDate
End date of assessment period
|
string
date
|
"2025-06-28"
|
|
age
Employee's age at the time of assessment
|
integer
int32
|
0
|
|
lowerEarningsThreshold
Lower earnings threshold for the assessment period
|
number
double
|
0.0
|
|
qualifyingThreshold
Qualifying threshold for the assessment period
|
number
double
|
0.0
|
|
action
|
string
|
"NoChange"
"Enrol"
"Exit"
"Inconclusive"
"Postpone"
"ReEnrol"
"UndoEnrol"
"AddToPension"
|
|
actionDate
The date when the action was created
|
string
date
|
"2025-06-28"
|
|
status
|
string
|
"Eligible"
"NonEligible"
"Entitled"
"NoDuties"
|
|
statutoryLetter
|
string
|
"B1"
"B2"
"B3"
"B4"
|
|
letterSentDate
The Date the letter was sent, if applicable
|
string
date
|
"2025-06-28"
|
|
pensionSchemeId
The pension scheme ID associated with this assessment
|
string
uuid
|
"string"
|
|
workerGroupId
The worker group ID associated with this assessment
|
string
uuid
|
"string"
|
|
isNewPension
Is this assessment for a new pension scheme
|
boolean
|
true
|
{
"employeeId": "string",
"employeeRoleId": "string",
"payRunId": "string",
"assessmentDate": "2025-06-28",
"startDate": "2025-06-28",
"endDate": "2025-06-28",
"age": 0,
"lowerEarningsThreshold": 0.0,
"qualifyingThreshold": 0.0,
"action": "NoChange",
"actionDate": "2025-06-28",
"status": "Eligible",
"statutoryLetter": "B1",
"letterSentDate": "2025-06-28",
"pensionSchemeId": "string",
"workerGroupId": "string",
"isNewPension": true
}- none -
- none -