Contract.AeEmployeeAssessmentHistoryResponse

Schema

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"
reason string "NoEmployee" "NoPeriod" "NoDefaultPension" "NoSer" "IsExempt" "IsPostponed" "NonEligibleAge" "PayBelowLowerEarningsThreshold" "PayBelowQualifyingThreshold" "HasQualifyingPension" "HasOptedOut" "IsLeaver" "HasCeasedMembership" "Contractual" "IsEntitled" "IsEligible" "HasExistingSerPension"
assessmentDate
Assessment date
 string date "2025-08-30"
startDate
Start date of assessment period
 string date "2025-08-30"
endDate
End date of assessment period
 string date "2025-08-30"
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" "OptOut" "CeaseMembership"
actionDate
The date when the action was created
 string date "2025-08-30"
status string "Eligible" "NonEligible" "Entitled" "NoDuties"
letter string "Entitled" "NonEligible" "Postponed" "Enrolled" "Reenrolled"
letterSentDate
The Date the letter was sent, if applicable
 string date "2025-08-30"
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

JSON Example 

{
  "employeeId": "string",
  "employeeRoleId": "string",
  "payRunId": "string",
  "reason": "NoEmployee",
  "assessmentDate": "2025-08-30",
  "startDate": "2025-08-30",
  "endDate": "2025-08-30",
  "age": 0,
  "lowerEarningsThreshold": 0.0,
  "qualifyingThreshold": 0.0,
  "action": "NoChange",
  "actionDate": "2025-08-30",
  "status": "Eligible",
  "letter": "Entitled",
  "letterSentDate": "2025-08-30",
  "pensionSchemeId": "string",
  "workerGroupId": "string",
  "isNewPension": true
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations

- none -