| Name / Description | Type / Format | Example | |
|---|---|---|---|
roleId
The unique identifier of role associated with this assessment.
|
integer
int32
|
0
|
|
payRunId
Optional: The Id of the PayRun that this assessment is associated with.
|
integer
int32
|
0
|
|
assessmentDate
The actual date the assessment was performed.
|
string
date
|
"2025-06-28"
|
|
periodStartDate
The start date of the pay reference period for which this assessment applies.
|
string
date
|
"2025-06-28"
|
|
periodEndDate
The end date of the pay reference period for which this assessment applies.
|
string
date
|
"2025-06-28"
|
|
age
The employee's age at the time of assessment.
|
integer
int32
|
0
|
|
lowerEarningsThreshold
The Lower Earnings Threshold applicable for the assessment period.
|
number
double
|
0.0
|
|
qualifyingThreshold
The Qualifying Earnings Threshold (or Auto-Enrolment Trigger) applicable for the assessment period.
|
number
double
|
0.0
|
|
action
|
string
|
"NoChange"
"Enrol"
"Exit"
"Inconclusive"
"Postpone"
"ReEnrol"
"UndoEnrol"
"AddToPension"
|
|
actionDate
The date when the actiont was applied, if applicable.
|
string
date
|
"2025-06-28"
|
|
status
|
string
|
"Eligible"
"NonEligible"
"Entitled"
"NoDuties"
|
|
letter
|
AeLetter
|
{AeLetter}
|
|
pensionId
The unique identifier of the pension scheme associated with this assessment.
|
string
uuid
|
"string"
|
|
isNewPension
Indicates whether this assessment is for a new pension scheme.
|
boolean
|
true
|
{
"roleId": 0,
"payRunId": 0,
"assessmentDate": "2025-06-28",
"periodStartDate": "2025-06-28",
"periodEndDate": "2025-06-28",
"age": 0,
"lowerEarningsThreshold": 0.0,
"qualifyingThreshold": 0.0,
"action": "NoChange",
"actionDate": "2025-06-28",
"status": "Eligible",
"letter": {
"id": 0,
"statutoryLetter": "B1",
"issueDate": "2025-06-28",
"sentDate": "2025-06-28"
},
"pensionId": "string",
"isNewPension": true
}- none -
- none -