Create Contribution Plan for Pension Scheme

Request

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

Path parameters

Parameter name Value Description Additional
schemeId int32 Required
businessId string Required

Request body

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

{
    "calculateOnQualifyingEarnings": "boolean",
    "collectionSourceId": "string",
    "contributionGroupId": "string",
    "contributionGroupName": "string",
    "contributionPlanName": "string",
    "employeeContribution": "double",
    "employerContribution": "double",
    "id": "int32",
    "isAutoEnrolmentScheme": "boolean",
    "lowerDefaultEarningsDisregardType": "string",
    "lowerEarningsDisregard": "double",
    "maxEarningsThreshold": "double",
    "minEarningsThreshold": "double",
    "nicSavingRebate": "double",
    "pensionSchemeContributionPlanPostponementRules": [
        {
            "name": "string",
            "pensionSchemeContributionPlanId": "int32",
            "postponementPeriod": "int32",
            "postponementRuleOptionType": "string",
            "postponementRuleType": "string"
        }
    ],
    "pensionSchemeId": "int32",
    "pensionType": "string",
    "reportingFrequency": "string",
    "salarySacrifice": "double",
    "salarySacrificeDeductionCategoryId": "int32",
    "upperDefaultEarningsCapType": "string",
    "upperEarningsCap": "double"
}

Properties

Name Type Description
calculateOnQualifyingEarnings boolean Boolean
collectionSourceId string String
contributionGroupId string String
contributionGroupName string String
contributionPlanName string String
employeeContribution double Decimal
employerContribution double Decimal
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
pensionSchemeContributionPlanPostponementRules[] array
pensionSchemeContributionPlanPostponementRules[].name string String
pensionSchemeContributionPlanPostponementRules[].pensionSchemeContributionPlanId int32 Int32
pensionSchemeContributionPlanPostponementRules[].postponementPeriod int32 Int32
pensionSchemeContributionPlanPostponementRules[].postponementRuleOptionType string PostponementRuleOptionTypeEnum

Possible values are:

  • PostponeWeeks
  • PostponeMonths
  • PostponePayPeriods
  • PostponeSixthFollowingMonths
pensionSchemeContributionPlanPostponementRules[].postponementRuleType string PostponementRuleTypeEnum

Possible values are:

  • ReachesDutiesStartDate
  • JoinsACompany
  • ReachesAgeOf22
  • EligibleAfterInitialAssessment
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
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