AutoEnrolment

Name / Description Type / Format Example
state
Shows the Auto Enrolment state of the Employee.
Unless the user has opted in/out or similar then this should have the value Automatic.
This can only be changed by the AutoEnrolment SetStatus end point of the API
string "Automatic" "OptOut" "OptIn" "VoluntaryJoiner" "ContractualPension" "CeasedMembership" "Leaver" "Excluded" "Enrol"
stateDate string date-time "2019-11-12T04:05:45"
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 AeAssessment {AeAssessment}
{
  "state": "Automatic",
  "stateDate": "2019-11-12T04:05:45",
  "ukWorker": "No",
  "daysToDeferAssessment": 0,
  "exempt": true,
  "aeExclusionCode": "NotKnown",
  "lastAssessment": {
    "assessmentDate": "2019-11-12T04:05:45",
    "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
Employee
Consumed by Operations

- none -

Returned by Operations

- none -