Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/pensionsettings

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete EmployeePensionContributionPlanSettingsModel resource, containing the following writable properties:

{
    "aeOptOutDate": "date-time",
    "aeOptOutReference": "string",
    "assessmentDate": "date-time",
    "assessmentStatus": "string",
    "calculateOnQualifyingEarnings": "boolean",
    "defaultMaxEarningsThreshold": "double",
    "defaultMinEarningsThreshold": "double",
    "deferralDate": "date-time",
    "employeeContribution": "double",
    "employerContribution": "double",
    "enrolled": "boolean",
    "maxEarningsThreshold": "double",
    "minEarningsThreshold": "double",
    "optIn": "boolean",
    "optInDate": "date-time",
    "overrideEmployeeContribution": "boolean",
    "overrideEmployerContribution": "boolean",
    "overrideMaxEarningsThreshold": "boolean",
    "overrideMinEarningsThreshold": "boolean",
    "overrideSalarySacrifice": "boolean",
    "payRunDefaultReportingFrequency": "string",
    "pensionAssessmentOption": "string",
    "pensionContributionPlanId": "int32",
    "pensionType": "string",
    "postponementOption": "string",
    "processOptOutRefunds": "boolean",
    "reportingFrequency": "string",
    "salarySacrifice": "double",
    "savedPensionContributionPlanId": "string"
}

Properties

Name Type Description
aeOptOutDate date-time Nullable
aeOptOutReference string String
assessmentDate date-time Nullable
assessmentStatus string Nullable

Possible values are:

  • NotAssessed
  • EligibleJobHolder
  • NonEligibleJobHolder
  • EntitledWorker
  • Postponed
calculateOnQualifyingEarnings boolean Nullable
defaultMaxEarningsThreshold double Nullable
defaultMinEarningsThreshold double Nullable
deferralDate date-time Nullable
employeeContribution double Decimal
employerContribution double Decimal
enrolled boolean Boolean
maxEarningsThreshold double Decimal
minEarningsThreshold double Decimal
optIn boolean Nullable
optInDate date-time Nullable
overrideEmployeeContribution boolean Boolean
overrideEmployerContribution boolean Boolean
overrideMaxEarningsThreshold boolean Boolean
overrideMinEarningsThreshold boolean Boolean
overrideSalarySacrifice boolean Boolean
payRunDefaultReportingFrequency string PensionReportingFrequencyEnum

Possible values are:

  • W1
  • W2
  • W4
  • M1
  • M3
  • M6
  • MA
  • TW
  • TM
pensionAssessmentOption string Nullable

Possible values are:

  • Automatic
  • Manual
  • None
pensionContributionPlanId int32 Nullable
pensionType string Nullable

Possible values are:

  • NetPay
  • ReliefAtSource
postponementOption string Nullable

Possible values are:

  • DoNotPostpone
  • PostponeUsingPensionSchemePostponementRules
  • PostponeToFollowingDate
processOptOutRefunds boolean Boolean
reportingFrequency string Nullable

Possible values are:

  • W1
  • W2
  • W4
  • M1
  • M3
  • M6
  • MA
  • TW
  • TM
salarySacrifice double Decimal
savedPensionContributionPlanId string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

EmployeePensionContributionPlanSettingsModel