Contract.AutoEnrolmentResponse

Schema

Name / Description Type / Format Example
state string "Automatic" "OptOut" "OptIn" "VoluntaryJoiner" "ContractualPension" "CeasedMembership" "Leaver" "Excluded" "Enrol"
stateDate string date "2024-11-21"
postponementDate
If a value is present, then employee wont be enrolled on an AE Pension until after this date.
This is automatically set to a date if the employee is deemed to be an EligibleJobHolder, but the employer has set a Postponement period and this value is currently null
This is automatically set to null if it already has a value and the employee is deemed NOT to be an EligibleJobHolder - ie, they previously qualified but now do not.
 string date "2024-11-21"
lastAssessment Contract.AeAssessmentResponse {Contract.AeAssessmentResponse}
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
deferByMonthsNotDays
If set to true then the value in DaysToDeferAssessment will be treated as a number of months, not a number of days
 boolean true
exempt boolean true
aeExclusionCode string "NotKnown" "NotAWorker" "NotWorkingInUk" "NoOrdinarilyWorkingInUk" "OutsideOfAgeRange" "SingleEmployee" "CeasedActiveMembershipInPast12Mo" "CeasedActiveMembership" "ReceivedWulsInPast12Mo" "ReceivedWuls" "Leaving" "TaxProtection" "CisSubContractor"
aePostponementLetterSent boolean true

JSON Example 

{
  "state": "Automatic",
  "stateDate": "2024-11-21",
  "postponementDate": "2024-11-21",
  "lastAssessment": {
    "id": "string",
    "employeeState": "Automatic",
    "age": 0,
    "ukWorker": "No",
    "payPeriod": "Custom",
    "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"
    },
    "assessmentDate": "2024-11-21"
  },
  "ukWorker": "No",
  "daysToDeferAssessment": 0,
  "deferByMonthsNotDays": true,
  "exempt": true,
  "aeExclusionCode": "NotKnown",
  "aePostponementLetterSent": true
}

References

Contained in Models
Contract.EmployeeResponse
Consumed by Operations

- none -

Returned by Operations

- none -