Contract.AeAssessmentResponse

Schema

Name / Description Type / Format Example
id
The unique id of the object
 string uuid "string"
employeeState 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 string "No" "Yes" "Ordinarily"
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal
The PaySchedule ordinal for the Employee at the time of the assessment
 integer int32 0
earningsInPeriod number double 0.0
qualifyingEarningsInPeriod number double 0.0
aeExclusionCode string "NotKnown" "NotAWorker" "NotWorkingInUk" "NoOrdinarilyWorkingInUk" "OutsideOfAgeRange" "SingleEmployee" "CeasedActiveMembershipInPast12Mo" "CeasedActiveMembership" "ReceivedWulsInPast12Mo" "ReceivedWuls" "Leaving" "TaxProtection" "CisSubContractor"
status string "Eligible" "NonEligible" "Entitled" "NoDuties"
reason
The reason for determining the Status given.
 string "string"
action Contract.AeAssessmentAction {Contract.AeAssessmentAction}
employee Contract.EmployeeItem {Contract.EmployeeItem}
assessmentDate string date "2024-11-21"

JSON Example 

{
  "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"
}

References

Contained in Models
Contract.AutoEnrolmentResponse
Consumed by Operations

- none -

Returned by Operations

- none -