PensionSelection

Name / Description Type / Format Example
id
The unique id of the object
string uuid "string"
pensionSchemeId string uuid "string"
pensionScheme PensionScheme {PensionScheme}
workerGroupId string uuid "string"
{
  "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",
        "foreignCountry": "string"
      },
      "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",
        "foreignCountry": "string"
      },
      "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",
      "buildingSocietyRollNumber": "string"
    },
    "useCustomPayCodes": true,
    "useCustomPayCodesForTierablePay": true,
    "customPayCodes": [
      "string"
    ],
    "tierablePayCustomPayCodes": [
      "string"
    ],
    "workerGroups": [
      {
        "name": "string",
        "contributionLevelType": "UserDefined",
        "employeeContribution": 0.0,
        "employeeContributionIsPercentage": true,
        "employerContribution": 0.0,
        "employerContributionIsPercentage": true,
        "employerContributionTopUpPercentage": 0.0,
        "employerContributionIncludesNiSaving": true,
        "employerContributionNiSavingPercentage": 0.0,
        "isAvc": true,
        "additionalVoluntaryContribution": 0.0,
        "avcIsPercentage": true,
        "employerContributionNiSaving": 0.0,
        "customThreshold": true,
        "lowerLimit": 0.0,
        "upperLimit": 0.0,
        "papdisGroup": "string",
        "papdisSubGroup": "string",
        "localAuthorityNumber": "string",
        "schoolEmployerType": "string",
        "matIdentifier": "string",
        "matUniqueNumber": "string",
        "employerReference": "string",
        "lgpsFund": "Avon",
        "workerGroupId": "string",
        "assumedPensionablePay": "AssumedPensionablePay",
        "pensionablePayDefinition": "NotApplicable",
        "payslipDescription": "string",
        "id": "string"
      }
    ],
    "externalDataProviderId": "SmartPension_Employer",
    "externalDataCompany": {
      "id": "string",
      "name": "string",
      "schemeName": "string"
    },
    "payCodeType": "Default",
    "tierablePayPayCodeType": "Default",
    "payCodeSetUniqueId": "string",
    "tierablePayPayCodeSetUniqueId": "string",
    "paymentDateRule": "OnPayDate",
    "paymentDateDayOfWeek": "Sunday",
    "paymentDateDayOfMonth": 0,
    "reportOptionsLgpsIConnect": {
      "fileType": "SingleFile",
      "payrollReference1": "Empty",
      "payrollReference2": "Empty",
      "payrollReference3": "Empty",
      "populateEmailAddress": true,
      "populateTelephoneNumber": true,
      "populateMobileNumber": true,
      "populateWorksPlaceName": true,
      "populateWorksAddress": true,
      "populateWorksEmailAddress": true,
      "includeEmploymentBreaks": true,
      "breakReasonSmpIndicatorOnly": true,
      "populateMaritalStatus": true,
      "includeAeQualifyingEarnings": true,
      "proRatePtHoursByTermTimeWeeks": true,
      "ignoreTermTimeWeeksForFteFinalPay": true,
      "showFteAnnualSalaryForFteFinalPay": true,
      "casualStaffHoursAsOne": true,
      "casualStaffIndicatorAsY": true,
      "ignoreHours": true,
      "forceUpperCase": true,
      "salaryType": "PayOnJoining",
      "customText": "string"
    },
    "reportOptionsLgpsCivicaUpm": {
      "payrollNumber": "PayrollCode",
      "casualHours": "ReportAsZero",
      "omitHeaderLine": true,
      "includeFolderNo": true,
      "excludeSchoolEmployerName": true,
      "addressesForNewJoinersOnly": true,
      "proRatePtHoursWeeksWorked": true,
      "fullTimeHoursAsOneHundred": true,
      "includeWeeksWorkedColumns": true
    },
    "deficitValueOrdinal": 0,
    "deficitValue": 0.0,
    "includeDeficitValue": true,
    "deficitValuePayPeriod": "Custom",
    "nominalCodeMappings": [
      {
        "nominalCode": "string",
        "nominalName": "string",
        "journalNarrative": "string",
        "payCode": "string"
      }
    ],
    "id": "string"
  },
  "workerGroupId": "string"
}
Contained in Models
AutoEnrolmentSettings
Employer
Consumed by Operations

- none -

Returned by Operations

- none -