Guides

Name / Description	Type / Format	Example
`employee`	`AeEmployee`	`{AeEmployee}`
`period`	`AePeriod`	`{AePeriod}`
`pensionSchemes` The pension schemes for the employer	`AePensionScheme[]`	`{AePensionScheme}`
`assessments` The previous assessments for the employee	`AeEmployeeAssessmentResponse[]`	`{AeEmployeeAssessmentResponse}`
`explanation` If an explanation is required	`boolean`	`true`

JSON Example

{
  "employee": {
    "id": "string",
    "birthDate": "2025-11-28",
    "age": 0,
    "startDate": "2025-11-28",
    "leaveDate": "2025-11-28",
    "isExempt": true,
    "roles": [
      {
        "id": "string",
        "startDate": "2025-11-28",
        "endDate": "2025-11-28",
        "earnings": 0.0,
        "defaultPensionSchemeId": "string",
        "defaultWorkerGroupId": "string"
      }
    ],
    "pensions": [
      {
        "id": "string",
        "pensionSchemeId": "string",
        "workerGroupId": "string",
        "roleIds": [
          "string"
        ],
        "startDate": "2025-11-28",
        "endDate": "2025-11-28",
        "endReason": "OptOut",
        "revertedRoleIds": [
          "string"
        ],
        "isNew": true
      }
    ],
    "statePensionAge": 0,
    "postponementDate": "2025-11-28",
    "defaultPensionSchemeId": "string",
    "defaultWorkerGroupId": "string"
  },
  "period": {
    "payPeriod": "Custom",
    "payDate": "2025-11-28",
    "startDate": "2025-11-28",
    "endDate": "2025-11-28",
    "lowerEarningsThreshold": 0.0,
    "qualifyingThreshold": 0.0,
    "upperEarningsThreshold": 0.0,
    "minimumAge": 0,
    "deferalPeriodType": "Days",
    "deferalPeriods": 0,
    "enrolmentDeferalPeriodType": "Days",
    "enrolmentDeferalPeriods": 0,
    "cyclicalReenrolmentDate": "2025-11-28",
    "cyclicalReenrolmentIsDue": true
  },
  "pensionSchemes": [
    {
      "id": "string",
      "isDefaultScheme": true,
      "isQualifying": true,
      "disableLetters": true,
      "useSerRule": true,
      "initialEnrolmentType": "Auto",
      "workerGroupIds": [
        "string"
      ]
    }
  ],
  "assessments": [
    {
      "assessmentDate": "2025-11-28",
      "earnings": 0.0,
      "qualifyingEarnings": 0.0,
      "reason": "NoEmployee",
      "action": "NoChange",
      "actionDate": "2025-11-28",
      "status": "Eligible",
      "letter": "Entitled",
      "letterSentDate": "2025-11-28",
      "letterExternalDataProviderId": "SmartPension_Employer",
      "pensionId": "string",
      "pensionSchemeId": "string",
      "workerGroupId": "string",
      "isNewPension": true,
      "roleId": "string",
      "explanation": "string",
      "isCurrentPayRun": true,
      "isJointAssessment": true,
      "reenrolmentDate": "2025-11-28",
      "version": 0
    }
  ],
  "explanation": true
}

References

Contained in Models

- none -

Consumed by Operations
Assess an employee

Returned by Operations

- none -