Update Pension Contribution Plan

Update Pension Contribution Plan settings for Employee

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/pension

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "assessmentDate": "date-time",
    "assessmentStatus": "string",
    "autoEnrolOptOutDate": "date-time",
    "autoEnrolOptOutReference": "string",
    "deferralDate": "date-time",
    "enrolled": "boolean",
    "optIn": "boolean",
    "optInDate": "date-time",
    "overrideEmployeeContribution": "double",
    "overrideEmployerContribution": "double",
    "overrideMaxEarningsThreshold": "double",
    "overrideMinEarningsThreshold": "double",
    "overrideSalarySacrifice": "double",
    "pensionAssessmentOption": "string",
    "pensionContributionPlanId": "int32",
    "postponementOption": "string",
    "processOptOutRefunds": "boolean"
}

Properties

Name Type Description
assessmentDate date-time Nullable
assessmentStatus string Nullable

Possible values are:

  • NotAssessed
  • EligibleJobHolder
  • NonEligibleJobHolder
  • EntitledWorker
  • Postponed
autoEnrolOptOutDate date-time Nullable
autoEnrolOptOutReference string String
deferralDate date-time Nullable
enrolled boolean Boolean
optIn boolean Nullable
optInDate date-time Nullable
overrideEmployeeContribution double Nullable
overrideEmployerContribution double Nullable
overrideMaxEarningsThreshold double Nullable
overrideMinEarningsThreshold double Nullable
overrideSalarySacrifice double Nullable
pensionAssessmentOption string Nullable

Possible values are:

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

Possible values are:

  • DoNotPostpone
  • PostponeUsingPensionSchemePostponementRules
  • PostponeToFollowingDate
processOptOutRefunds boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

 EmployeePensionContributionPlanSettingsApiModel