YtdValue

Schema

Name / Description Type / Format Example
pensionId
The Id of the Pension.
 string uuid "string"
name
The name of the PensionScheme to which contributions have been made.
 string "string"
pensionSchemeId
The Id of the PensionScheme.
 string uuid "string"
startDate
Pension Start Date
 string date "2024-12-22"
endDate
Pension End Date
 string date "2024-12-22"
workerGroupId
The Id of the WorkerGroup.
 string uuid "string"
pensionRule string "ReliefAtSource" "SalarySacrifice" "NetPayArrangement"
subtractedBasicRateTax
The SubtractedBasicRateTax applied from the PensionScheme SubtractBasicRateTax.
 boolean true
papdisPensionProviderId
Papdis information from the PensionScheme
 string "string"
papdisEmployerId
Papdis information from the PensionScheme
 string "string"
employeePensionContributionMultiplier
If the PensionScheme is set to SubtractBasicRateTax then this value is used to reduce the contribution amount.
Otherwise it is set as 1.
 number double 0.0
additionalVoluntaryContribution
Any Additional Voluntary Contribution the Employee has chosen to make
Otherwise it is set as 1.
 number double 0.0
avcIsPercentage
Determines whether the Value of the Additional Voluntary Contribution is a fixed amount or a percentage,
 boolean true
autoEnrolled
Any Additional Voluntary Contribution the Employee has chosen to make
Otherwise it is set as 1.
 boolean true
workerGroup WorkerGroup {WorkerGroup}
forcedTier
If the WorkerGroup ContributionLevelType is a Tiered Scheme then the name of the tier to force the employee on to may be specified.
If none is specified then the Tier is determined by the earnings in the period
 string "string"
tiers TieredPensionRate[] {TieredPensionRate}
assumedPensionablePay
Assumed Pensionable Pay. If the employee is receiving any Statutory Leave that has an AssumedPensionablePay value set
then it'll be shown here.
 number double 0.0
pensionablePayCodes
If the pension scheme is set to override the Pensionale PayCodes, then this is what they've been set to.
 string[]
tierablePayPayCodes
If the pension scheme is set to override the TierablePay PayCodes, then this is what they've been set to.
 string[]
isHalfContributionMember
if an employee as a member of the 50/50 LGPS scheme, they can enable contribution to 50% of the normal contributions.
 boolean true
pensionableEarnings
The amount of the Gross that is subject to Pension Deductions.
If the Pension Scheme uses Qualifying Earnings (upper and lower limits) then this value is before those are applied
Applied only if an employee has more than one pension assigned to them
 number double 0.0
pensionablePay
The amount of the Gross that pension calculations are based on after taking into account Upper and Lower Limits for the WorkerGroup.
Applied only if an employee has more than one pension assigned to them
 number double 0.0
nonTierablePay
The value of any pay that shouldn't count towards determining a pension tier.
 number double 0.0
employeePensionContribution
The value of the Pension Contribution being made by this Employee, excluding any Additional Voluntary Contributions
 number double 0.0
employeePensionContributionAvc
The value of the Pension Contribution being made by this Employee as an Additional Voluntary Contribution
 number double 0.0
employerPensionContribution
The value of the Pension Contribution being made by the Employer for this Employee
 number double 0.0
isForEndedPension
Determines whether the pension summary is related to a pension that has ended or not
 boolean true
associatedEmployeeRoles Item[] {Item}
notionalPay
Pay value based on regular pay lines and the pension's associated roles
Set before any adjustments for things like stat payments
 number double 0.0
pensionableEarningsBfd
The brought forward Year to Date amount of the Gross that is subject to Pension Deductions.
Applied only if an employee has more than one pension assigned to them
 number double 0.0
pensionablePayBfd
The brought forward Year to Date amount of the Gross that pension calculations are based on after taking into account Upper and Lower Limits for the WorkerGroup.
Applied only if an employee has more than one pension assigned to them
 number double 0.0
employeePensionContributionBfd
The brought forward Year to Date value of the Pension Contribution being made by this Employee, excluding any Additional Voluntary Contributions
 number double 0.0
assumedPensionablePayBfd
The brought forward Year to Date value of Assumed Pensionable Pay. If the employee is receiving any Statutory Leave that has an AssumedPensionablePay value set
then it'll be shown here.
 number double 0.0
employerPensionContributionBfd
The brought forward Year to Date value of the Pension Contribution being made by the Employer for this Employee
 number double 0.0
employeePensionContributionAvcBfd
The brought forward Year to Date value of the Pension Contribution being made by this Employee as an Additional Voluntary Contribution
 number double 0.0
whenEarnedPensionSummaries
The list of pension summaries created on the base of when earned additions' and deductions' pension calculations for back paid periods
 PensionSummary[] {PensionSummary}
periodFrom
Nullable DateTime property "PeriodFrom" to store the start date of the PayPeriod the current PensionSummary is attributable to.
Applicable only for when the pension summary is created on the base of when earned additions' and deductions' pension calculations for back paid periods
 string date "2024-12-22"
periodTo
Nullable DateTime property "PeriodTo" to store the start date of the PayPeriod the current PensionSummary is attributable to.
Applicable only for when the pension summary is created on the base of when earned additions' and deductions' pension calculations for back paid periods
 string date "2024-12-22"
whenEarnedPensionableEarningsCorrection
The when earned amount correction to the Gross that is subject to Pension Deductions.
 number double 0.0
whenEarnedPensionablePayCorrection
The when earned amount correction to the Gross that pension calculations are based on after taking into account Upper and Lower Limits for the WorkerGroup.
 number double 0.0
whenEarnedEmployeePensionContributionCorrection
The when earned amount correction to the Pension Contribution being made by this Employee, excluding any Additional Voluntary Contributions
 number double 0.0
whenEarnedEmployerPensionContributionCorrection
The when earned amount correction to the Pension Contribution being made by the Employer for this Employee
 number double 0.0
whenEarnedEmployeePensionContributionAvcCorrection
The when earned amount correction to Pension Contribution being made by this Employee as an Additional Voluntary Contribution
 number double 0.0
whenEarnedPensionableEarningsCorrectionBfd
The brought forward Year to Date when earned amount correction to the Gross that is subject to Pension Deductions.
 number double 0.0
whenEarnedPensionablePayCorrectionBfd
The brought forward Year to Date when earned amount correction to the Gross that pension calculations are based on after taking into account Upper and Lower Limits for the WorkerGroup.
 number double 0.0
whenEarnedEmployeePensionContributionCorrectionBfd
The brought forward Year to Date when earned amount correction to the Pension Contribution being made by this Employee, excluding any Additional Voluntary Contributions
 number double 0.0
whenEarnedEmployerPensionContributionCorrectionBfd
The brought forward Year to Date when earned amount correction to the Pension Contribution being made by the Employer for this Employee
 number double 0.0
whenEarnedEmployeePensionContributionAvcCorrectionBfd
The brought forward Year to Date when earned amount correction to Pension Contribution being made by this Employee as an Additional Voluntary Contribution
 number double 0.0
nominalCodeMappings
List of Nominal Code Mappings of the Pension
 PensionSchemeNominalCodeMapping[] {PensionSchemeNominalCodeMapping}

JSON Example 

{
  "pensionId": "string",
  "name": "string",
  "pensionSchemeId": "string",
  "startDate": "2024-12-22",
  "endDate": "2024-12-22",
  "workerGroupId": "string",
  "pensionRule": "ReliefAtSource",
  "subtractedBasicRateTax": true,
  "papdisPensionProviderId": "string",
  "papdisEmployerId": "string",
  "employeePensionContributionMultiplier": 0.0,
  "additionalVoluntaryContribution": 0.0,
  "avcIsPercentage": true,
  "autoEnrolled": true,
  "workerGroup": {
    "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"
  },
  "forcedTier": "string",
  "tiers": [
    {
      "name": "string",
      "description": "string",
      "rangeStart": 0.0,
      "rate": 0.0
    }
  ],
  "assumedPensionablePay": 0.0,
  "pensionablePayCodes": [
    "string"
  ],
  "tierablePayPayCodes": [
    "string"
  ],
  "isHalfContributionMember": true,
  "pensionableEarnings": 0.0,
  "pensionablePay": 0.0,
  "nonTierablePay": 0.0,
  "employeePensionContribution": 0.0,
  "employeePensionContributionAvc": 0.0,
  "employerPensionContribution": 0.0,
  "isForEndedPension": true,
  "associatedEmployeeRoles": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "notionalPay": 0.0,
  "pensionableEarningsBfd": 0.0,
  "pensionablePayBfd": 0.0,
  "employeePensionContributionBfd": 0.0,
  "assumedPensionablePayBfd": 0.0,
  "employerPensionContributionBfd": 0.0,
  "employeePensionContributionAvcBfd": 0.0,
  "whenEarnedPensionSummaries": [
    {
      "pensionId": "string",
      "name": "string",
      "pensionSchemeId": "string",
      "startDate": "2024-12-22",
      "endDate": "2024-12-22",
      "workerGroupId": "string",
      "pensionRule": "ReliefAtSource",
      "subtractedBasicRateTax": true,
      "papdisPensionProviderId": "string",
      "papdisEmployerId": "string",
      "employeePensionContributionMultiplier": 0.0,
      "additionalVoluntaryContribution": 0.0,
      "avcIsPercentage": true,
      "autoEnrolled": true,
      "workerGroup": {
        "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"
      },
      "forcedTier": "string",
      "tiers": [
        {
          "name": "string",
          "description": "string",
          "rangeStart": 0.0,
          "rate": 0.0
        }
      ],
      "assumedPensionablePay": 0.0,
      "pensionablePayCodes": [
        "string"
      ],
      "tierablePayPayCodes": [
        "string"
      ],
      "isHalfContributionMember": true,
      "pensionableEarnings": 0.0,
      "pensionablePay": 0.0,
      "nonTierablePay": 0.0,
      "employeePensionContribution": 0.0,
      "employeePensionContributionAvc": 0.0,
      "employerPensionContribution": 0.0,
      "isForEndedPension": true,
      "associatedEmployeeRoles": [
        {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        }
      ],
      "notionalPay": 0.0,
      "pensionableEarningsBfd": 0.0,
      "pensionablePayBfd": 0.0,
      "employeePensionContributionBfd": 0.0,
      "assumedPensionablePayBfd": 0.0,
      "employerPensionContributionBfd": 0.0,
      "employeePensionContributionAvcBfd": 0.0,
      "whenEarnedPensionSummaries": [
        {
          "pensionId": "string",
          "name": "string",
          "pensionSchemeId": "string",
          "startDate": "2024-12-22",
          "endDate": "2024-12-22",
          "workerGroupId": "string",
          "pensionRule": "ReliefAtSource",
          "subtractedBasicRateTax": true,
          "papdisPensionProviderId": "string",
          "papdisEmployerId": "string",
          "employeePensionContributionMultiplier": 0.0,
          "additionalVoluntaryContribution": 0.0,
          "avcIsPercentage": true,
          "autoEnrolled": true,
          "workerGroup": {
            "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"
          },
          "forcedTier": "string",
          "tiers": [
            {
              "name": "string",
              "description": "string",
              "rangeStart": 0.0,
              "rate": 0.0
            }
          ],
          "assumedPensionablePay": 0.0,
          "pensionablePayCodes": [
            "string"
          ],
          "tierablePayPayCodes": [
            "string"
          ],
          "isHalfContributionMember": true,
          "pensionableEarnings": 0.0,
          "pensionablePay": 0.0,
          "nonTierablePay": 0.0,
          "employeePensionContribution": 0.0,
          "employeePensionContributionAvc": 0.0,
          "employerPensionContribution": 0.0,
          "isForEndedPension": true,
          "associatedEmployeeRoles": [
            {
              "id": "string",
              "name": "string",
              "metadata": {},
              "url": "string"
            }
          ],
          "notionalPay": 0.0,
          "pensionableEarningsBfd": 0.0,
          "pensionablePayBfd": 0.0,
          "employeePensionContributionBfd": 0.0,
          "assumedPensionablePayBfd": 0.0,
          "employerPensionContributionBfd": 0.0,
          "employeePensionContributionAvcBfd": 0.0,
          "whenEarnedPensionSummaries": [
            {
              "pensionId": "string",
              "name": "string",
              "pensionSchemeId": "string",
              "startDate": "2024-12-22",
              "endDate": "2024-12-22",
              "workerGroupId": "string",
              "pensionRule": "ReliefAtSource",
              "subtractedBasicRateTax": true,
              "papdisPensionProviderId": "string",
              "papdisEmployerId": "string",
              "employeePensionContributionMultiplier": 0.0,
              "additionalVoluntaryContribution": 0.0,
              "avcIsPercentage": true,
              "autoEnrolled": true,
              "workerGroup": "error too many levels",
              "forcedTier": "string",
              "tiers": "error too many levels",
              "assumedPensionablePay": 0.0,
              "pensionablePayCodes": [
                "string"
              ],
              "tierablePayPayCodes": [
                "string"
              ],
              "isHalfContributionMember": true,
              "pensionableEarnings": 0.0,
              "pensionablePay": 0.0,
              "nonTierablePay": 0.0,
              "employeePensionContribution": 0.0,
              "employeePensionContributionAvc": 0.0,
              "employerPensionContribution": 0.0,
              "isForEndedPension": true,
              "associatedEmployeeRoles": "error too many levels",
              "notionalPay": 0.0,
              "pensionableEarningsBfd": 0.0,
              "pensionablePayBfd": 0.0,
              "employeePensionContributionBfd": 0.0,
              "assumedPensionablePayBfd": 0.0,
              "employerPensionContributionBfd": 0.0,
              "employeePensionContributionAvcBfd": 0.0,
              "whenEarnedPensionSummaries": "error too many levels",
              "periodFrom": "2024-12-22",
              "periodTo": "2024-12-22",
              "whenEarnedPensionableEarningsCorrection": 0.0,
              "whenEarnedPensionablePayCorrection": 0.0,
              "whenEarnedEmployeePensionContributionCorrection": 0.0,
              "whenEarnedEmployerPensionContributionCorrection": 0.0,
              "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
              "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
              "whenEarnedPensionablePayCorrectionBfd": 0.0,
              "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
              "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
              "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
              "nominalCodeMappings": "error too many levels"
            }
          ],
          "periodFrom": "2024-12-22",
          "periodTo": "2024-12-22",
          "whenEarnedPensionableEarningsCorrection": 0.0,
          "whenEarnedPensionablePayCorrection": 0.0,
          "whenEarnedEmployeePensionContributionCorrection": 0.0,
          "whenEarnedEmployerPensionContributionCorrection": 0.0,
          "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
          "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
          "whenEarnedPensionablePayCorrectionBfd": 0.0,
          "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
          "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
          "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
          "nominalCodeMappings": [
            {
              "nominalCode": "string",
              "nominalName": "string",
              "journalNarrative": "string",
              "payCode": "string"
            }
          ]
        }
      ],
      "periodFrom": "2024-12-22",
      "periodTo": "2024-12-22",
      "whenEarnedPensionableEarningsCorrection": 0.0,
      "whenEarnedPensionablePayCorrection": 0.0,
      "whenEarnedEmployeePensionContributionCorrection": 0.0,
      "whenEarnedEmployerPensionContributionCorrection": 0.0,
      "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
      "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
      "whenEarnedPensionablePayCorrectionBfd": 0.0,
      "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
      "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
      "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
      "nominalCodeMappings": [
        {
          "nominalCode": "string",
          "nominalName": "string",
          "journalNarrative": "string",
          "payCode": "string"
        }
      ]
    }
  ],
  "periodFrom": "2024-12-22",
  "periodTo": "2024-12-22",
  "whenEarnedPensionableEarningsCorrection": 0.0,
  "whenEarnedPensionablePayCorrection": 0.0,
  "whenEarnedEmployeePensionContributionCorrection": 0.0,
  "whenEarnedEmployerPensionContributionCorrection": 0.0,
  "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
  "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
  "whenEarnedPensionablePayCorrectionBfd": 0.0,
  "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
  "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
  "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
  "nominalCodeMappings": [
    {
      "nominalCode": "string",
      "nominalName": "string",
      "journalNarrative": "string",
      "payCode": "string"
    }
  ]
}

References

Contained in Models
PayRunEntry
PensionSummary
Consumed by Operations

- none -

Returned by Operations

- none -