| Name / Description | Type / Format | Example | |
|---|---|---|---|
roleId
The unique identifier of the Role associated with this assessment.
|
string
uuid
|
"string"
|
|
payRunId
The unique identifier of the Pay Run associated with this assessment.
|
string
uuid
|
"string"
|
|
reason
|
string
|
"NoEmployee"
"NoPeriod"
"NoDefaultPension"
"NoSer"
"IsExempt"
"IsPostponed"
"NonEligibleAge"
"PayBelowLowerEarningsThreshold"
"PayBelowQualifyingThreshold"
"HasQualifyingPension"
"HasOptedOut"
"IsLeaver"
"HasCeasedMembership"
"Contractual"
"IsEntitled"
"IsEligible"
"HasExistingSerPension"
|
|
assessmentDate
The actual date the assessment was performed.
|
string
date
|
"2025-11-29"
|
|
periodStartDate
The start date of the pay reference period for which this assessment applies.
|
string
date
|
"2025-11-29"
|
|
periodEndDate
The end date of the pay reference period for which this assessment applies.
|
string
date
|
"2025-11-29"
|
|
age
The employee's age at the time of assessment.
|
integer
int32
|
0
|
|
lowerEarningsThreshold
The Lower Earnings Threshold applicable for the assessment period.
|
number
double
|
0.0
|
|
qualifyingThreshold
The Qualifying Earnings Threshold (or Auto-Enrolment Trigger) applicable for the assessment period.
|
number
double
|
0.0
|
|
action
|
string
|
"NoChange"
"Enrol"
"Exit"
"Inconclusive"
"Postpone"
"Reenrol"
"AddToPension"
"OptOut"
"CeaseMembership"
|
|
actionDate
The date when the action was applied, if applicable.
|
string
date
|
"2025-11-29"
|
|
status
|
string
|
"Eligible"
"NonEligible"
"Entitled"
"NoDuties"
|
|
letter
|
string
|
"Entitled"
"NonEligible"
"Postponed"
"Enrolled"
"Reenrolled"
|
|
letterSentDate
The date the letter was sent to employee, if applicable.
|
string
date
|
"2025-11-29"
|
|
letterSentType
|
string
|
"Email"
"Manual"
"ExternalDataProvider"
|
|
letterExternalDataProviderId
|
string
|
"SmartPension_Employer"
"SmartPension_Adviser"
"PeoplesPension"
"Xero"
"Qbo"
"Sage"
"Nest"
"Cashplus"
"BreatheHr"
"KashFlow"
"FreeAgent"
"FreeAgentPm"
"Modulr"
"Square"
"Cezanne"
"Ciphr"
"Telleroo"
"WeWorked"
"RotaCloud"
"Quinyx"
"Csod"
"Planday"
"Starling"
"Deputy"
"Bottomline"
"Twinfield"
"MyePayWindow"
"IFinance"
"AccountsIQ"
"EPaySlips"
"NetSuite"
"StackOne"
|
|
pensionId
The unique identifier of the pension associated with this assessment, if applicable.
|
string
uuid
|
"string"
|
|
pensionSchemeId
The unique identifier of the pension scheme associated with this assessment, if applicable.
|
string
uuid
|
"string"
|
|
workerGroupId
The unique identifier of the worker group with this assessment, if applicable.
|
string
uuid
|
"string"
|
|
isNewPension
Is this assessment resulting in a new pension
|
boolean
|
true
|
|
isJointAssessment
Is this a joint assessment with another role
|
boolean
|
true
|
|
reenrolmentDate
Re-enrolment date if assessment occurs during re-enrolment period
|
string
date
|
"2025-11-29"
|
|
version
The version of this assessment in the current pay run
|
integer
int32
|
0
|
|
isLatestVersion
Is the latest version of this assessment
|
boolean
|
true
|
{
"roleId": "string",
"payRunId": "string",
"reason": "NoEmployee",
"assessmentDate": "2025-11-29",
"periodStartDate": "2025-11-29",
"periodEndDate": "2025-11-29",
"age": 0,
"lowerEarningsThreshold": 0.0,
"qualifyingThreshold": 0.0,
"action": "NoChange",
"actionDate": "2025-11-29",
"status": "Eligible",
"letter": "Entitled",
"letterSentDate": "2025-11-29",
"letterSentType": "Email",
"letterExternalDataProviderId": "SmartPension_Employer",
"pensionId": "string",
"pensionSchemeId": "string",
"workerGroupId": "string",
"isNewPension": true,
"isJointAssessment": true,
"reenrolmentDate": "2025-11-29",
"version": 0,
"isLatestVersion": true
}- none -
- none -