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
|
"2024-12-22T03:01:25"
|
|
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
|
AeAssessmentAction
|
{AeAssessmentAction}
|
|
startReportingType
|
string
|
"UsePayRun"
"UseAssessment"
"AlreadyReported"
"UseExisting"
|
|
endReportingType
|
string
|
"UsePayRun"
"UseAssessment"
"AlreadyReported"
"UseExisting"
|
|
startPayRunEntryId
|
integer
int32
|
0
|
|
endPayRunEntryId
|
integer
int32
|
0
|
|
employee
|
Item
|
{Item}
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"assessmentDate": "2024-12-22T03:01:25",
"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
},
"startReportingType": "UsePayRun",
"endReportingType": "UsePayRun",
"startPayRunEntryId": 0,
"endPayRunEntryId": 0,
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"id": "string"
}- none -