UpdateContribution Plan for Pension Scheme

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId}

Path parameters

Parameter name Value Description Additional
schemeId int32 Required
planId int32 Required
businessId string Required

Request body

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

{
    "calculateOnQualifyingEarnings": "boolean",
    "contributionGroupId": "string",
    "contributionGroupName": "string",
    "contributionPlanName": "string",
    "employeeContribution": "double",
    "employeeContributionPayCategoryIds": [
        "int32"
    ],
    "employerContribution": "double",
    "employerContributionPayCategoryIds": [
        "int32"
    ],
    "id": "int32",
    "isAutoEnrolmentScheme": "boolean",
    "lowerDefaultEarningsDisregardType": "string",
    "lowerEarningsDisregard": "double",
    "maxEarningsThreshold": "double",
    "minEarningsThreshold": "double",
    "nicSavingRebate": "double",
    "pensionSchemeId": "int32",
    "pensionType": "string",
    "reportingFrequency": "string",
    "salarySacrifice": "double",
    "salarySacrificeDeductionCategoryId": "int32",
    "salarySacrificePayCategoryIds": [
        "int32"
    ],
    "upperDefaultEarningsCapType": "string",
    "upperEarningsCap": "double"
}

Properties

Name Type Description
calculateOnQualifyingEarnings boolean Boolean
contributionGroupId string String
contributionGroupName string String
contributionPlanName string String
employeeContribution double Decimal
employeeContributionPayCategoryIds[] array of int32
employerContribution double Decimal
employerContributionPayCategoryIds[] array of int32
id int32 Nullable
isAutoEnrolmentScheme boolean Nullable
lowerDefaultEarningsDisregardType string Nullable

Possible values are:

  • NoOffset
  • LELOffset
  • LELOffsetMultiplied
lowerEarningsDisregard double Nullable
maxEarningsThreshold double Decimal
minEarningsThreshold double Decimal
nicSavingRebate double Decimal
pensionSchemeId int32 Int32
pensionType string PensionTypeEnum

Possible values are:

  • NetPay
  • ReliefAtSource
reportingFrequency string PensionReportingFrequencyEnum

Possible values are:

  • W1
  • W2
  • W4
  • M1
  • M3
  • M6
  • MA
  • TW
  • TM
salarySacrifice double Decimal
salarySacrificeDeductionCategoryId int32 Nullable
salarySacrificePayCategoryIds[] array of int32
upperDefaultEarningsCapType string Nullable

Possible values are:

  • NoOffset
  • UETOffset
upperEarningsCap double Nullable

Response

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

Status code Description Resource
200 OK

OK

PensionSchemeContributionPlanApiModel