AeAssessment

As part of AutoEnrolment we assess your Employees to see if they need to be auto-enroled in a Pension.
This model shows the result of an assessment.

Name / Description Type / Format Example
assessmentDate string date-time "2019-11-19T10:47:40"
employeeState
The Auto Enrolment State of the Employee
string "Automatic" "OptOut" "OptIn" "VoluntaryJoiner" "ContractualPension" "CeasedMembership" "Leaver" "Excluded" "Enrol"
age
The age of the Employee at the time of the assessment
integer int32 0
ukWorker
Employee status at the time of the assessment
string "No" "Yes" "Ordinarily"
payPeriod
The PayPeriod for the Employee at the time of the assessment
string "Monthly" "FourWeekly" "Fortnightly" "Weekly"
earningsInPeriod number double 0.0
qualifyingEarningsInPeriod number double 0.0
aeExclusionCode
If we determine that the employee is excluded from Auto Enrolment then this field will give you the reason that they are excluded.
string "NotKnown" "NotAWorker" "NotWorkingInUk" "NoOrdinarilyWorkingInUk" "OutsideOfAgeRange" "SingleEmployee" "CeasedActiveMembershipInPast12Mo" "CeasedActiveMembership" "ReceivedWulsInPast12Mo" "ReceivedWuls" "Leaving" "TaxProtection" "CisSubContractor"
status
The resulting status of the employee from the assessment
string "Eligible" "NonEligible" "Entitled" "NoDuties"
reason
The reason for determining the Status given.
string "string"
action
Details of any actions required/taken as a result of this assessment
AeAssessmentAction {AeAssessmentAction}
employee
A representation of the Employee this object relates to
Item {Item}
id
The unique id of the object
string uuid "string"
{
  "assessmentDate": "2019-11-19T10:47:40",
  "employeeState": "Automatic",
  "age": 0,
  "ukWorker": "No",
  "payPeriod": "Monthly",
  "earningsInPeriod": 0.0,
  "qualifyingEarningsInPeriod": 0.0,
  "aeExclusionCode": "NotKnown",
  "status": "Eligible",
  "reason": "string",
  "action": {
    "action": "NoChange",
    "employeeState": "Automatic",
    "actionCompleted": true,
    "actionCompletedMessage": "string",
    "requiredLetter": "B1",
    "pensionSchemeId": "string",
    "workerGroupId": "string",
    "letterNotYetSent": true
  },
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "id": "string"
}
Contained in Models
AutoEnrolment
Consumed by Operations

- none -