AutoEnrolment

Name / Description Type / Format Example
state string "Automatic" "OptOut" "OptIn" "VoluntaryJoiner" "ContractualPension" "CeasedMembership" "Leaver" "Excluded" "Enrol"
stateDate string date "2020-07-10"
ukWorker string "No" "Yes" "Ordinarily"
daysToDeferAssessment
The number of days, if any, to defer assessment of this employee.
You're allowed to defer assessment of new employees by up to 3 months.
integer int32 0
exempt boolean true
aeExclusionCode string "NotKnown" "NotAWorker" "NotWorkingInUk" "NoOrdinarilyWorkingInUk" "OutsideOfAgeRange" "SingleEmployee" "CeasedActiveMembershipInPast12Mo" "CeasedActiveMembership" "ReceivedWulsInPast12Mo" "ReceivedWuls" "Leaving" "TaxProtection" "CisSubContractor"
lastAssessment
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.
AeAssessment {AeAssessment}
{
  "state": "Automatic",
  "stateDate": "2020-07-10",
  "ukWorker": "No",
  "daysToDeferAssessment": 0,
  "exempt": true,
  "aeExclusionCode": "NotKnown",
  "lastAssessment": {
    "assessmentDate": "2020-07-10T07:22:29",
    "employeeState": "Automatic",
    "age": 0,
    "ukWorker": "No",
    "payPeriod": "Monthly",
    "ordinal": 0,
    "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
Employee
Consumed by Operations

- none -

Returned by Operations

- none -