AutoEnrolmentSettings

Name / Description Type / Format Example
stagingDate string date "2021-10-16"
cyclicalReenrolmentDate string date "2021-10-16"
previousCyclicalReenrolmentDate string date "2021-10-16"
defaultPension PensionSelection {PensionSelection}
pensionSameAsDefault boolean true
daysToDeferAssessment
The number of days, if any, to defer assessment of new employees.
You're allowed to defer assessment of new employees by up to 3 months.
This is the default value used when you create a new employee. It can be changed on a per-employee basis.
integer int32 0
deferByMonthsNotDays
If set to true then the value in DaysToDeferAssessment will be treated as a number of months, not a number of days
boolean true
deferEnrolmentBy
The number of days )or weeks, or months), if any, to defer enrolment of employees that are Eligible Jobholders.
For example, if this is set to 30 days then if an employee meets the criteria for enrolment then they'll only be enrolled if they still meet the criteria 30 days later
integer int32 0
deferEnrolmentByPeriodType string "Days" "Weeks" "Months" "PayPeriods"
includeNonPensionedEmployeesInSubmission
Whether or not to include details of non-pensioned employees in your submissions to this provider
boolean true
id
The unique id of the object
string uuid "string"
{
  "stagingDate": "2021-10-16",
  "cyclicalReenrolmentDate": "2021-10-16",
  "previousCyclicalReenrolmentDate": "2021-10-16",
  "defaultPension": {
    "id": "string",
    "pensionSchemeId": "string",
    "pensionScheme": {
      "name": "string",
      "provider": {
        "name": "string",
        "accountNo": "string",
        "portal": "string",
        "website": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "line4": "string",
          "line5": "string",
          "postCode": "string",
          "country": "England"
        },
        "telephone": "string",
        "papdisVersion": "PAP10",
        "papdisProviderId": "string",
        "papdisEmployerId": "string",
        "csvFormat": "Papdis",
        "excludeNilPaidFromContributions": true,
        "payPeriodDateAdjustment": 0,
        "miscBoolean1": true,
        "miscBoolean2": true,
        "miscString1": "string",
        "miscString2": "string",
        "optOutWindow": 0,
        "optOutWindowIsMonths": true,
        "id": "string"
      },
      "administrator": {
        "name": "string",
        "email": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "line4": "string",
          "line5": "string",
          "postCode": "string",
          "country": "England"
        },
        "telephone": "string",
        "id": "string"
      },
      "pensionRule": "ReliefAtSource",
      "qualifyingScheme": true,
      "disableAeLetters": true,
      "subtractBasicRateTax": true,
      "payMethod": "Cash",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string"
      },
      "useCustomPayCodes": true,
      "customPayCodes": [
        "string"
      ],
      "workerGroups": [
        {
          "name": "string",
          "contributionLevelType": "UserDefined",
          "employeeContribution": 0.0,
          "employeeContributionIsPercentage": true,
          "employerContribution": 0.0,
          "employerContributionIsPercentage": true,
          "employerContributionTopUpPercentage": 0.0,
          "customThreshold": true,
          "lowerLimit": 0.0,
          "upperLimit": 0.0,
          "papdisGroup": "string",
          "papdisSubGroup": "string",
          "localAuthorityNumber": "string",
          "schoolEmployerType": "string",
          "workerGroupId": "string",
          "id": "string"
        }
      ],
      "externalDataProviderId": "SmartPension_Employer",
      "externalDataCompany": {
        "id": "string",
        "name": "string",
        "schemeName": "string"
      },
      "id": "string"
    },
    "workerGroupId": "string"
  },
  "pensionSameAsDefault": true,
  "daysToDeferAssessment": 0,
  "deferByMonthsNotDays": true,
  "deferEnrolmentBy": 0,
  "deferEnrolmentByPeriodType": "Days",
  "includeNonPensionedEmployeesInSubmission": true,
  "id": "string"
}
Contained in Models
Employer
Consumed by Operations

- none -

Returned by Operations

- none -