| Name / Description | Type / Format | Example | |
|---|---|---|---|
id
The pension unique id
|
string
uuid
|
"string"
|
|
pensionSchemeId
The pension scheme unique id
|
string
uuid
|
"string"
|
|
workerGroupId
The worker group unique id
|
string
uuid
|
"string"
|
|
roleIds
The role unique ids associated with the pension
|
string[]
|
|
|
startDate
The start date of the pension
|
string
date
|
"2025-11-30"
|
|
endDate
The end date of the pension, if applicable
|
string
date
|
"2025-11-30"
|
|
endReason
|
string
|
"OptOut"
"CeasedMembership"
"Leaver"
|
|
revertedRoleIds
The role unique ids associated with the pension which need to be removed
|
string[]
|
|
|
isNew
If the pension is created this period by Ae
|
boolean
|
true
|
{
"id": "string",
"pensionSchemeId": "string",
"workerGroupId": "string",
"roleIds": [
"string"
],
"startDate": "2025-11-30",
"endDate": "2025-11-30",
"endReason": "OptOut",
"revertedRoleIds": [
"string"
],
"isNew": true
}