Struct PensionContributionCalculationResult

Namespace

Payetools.Pensions.Model

Assembly

Payetools.Pensions.dll

Represents a pension contribution calculation result.

public readonly struct PensionContributionCalculationResult : IPensionContributionCalculationResult

Implements

IPensionContributionCalculationResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

BandedEarnings

Gets the portion of earnings used to calculate the employee and employer contributions under Qualifying Earnings. Null for pensionable pay.

public decimal? BandedEarnings { get; init; }

Property Value

decimal?

CalculatedEmployeeContributionAmount

Gets the employee contribution amount resulting from the calculation. Will be zero if SalaryExchangeApplied is true.

public decimal CalculatedEmployeeContributionAmount { get; init; }

Property Value

decimal

CalculatedEmployerContributionAmount

Gets the employer contribution amount resulting from the calculation. IfSalaryExchangeApplied is true, includes both calculated amounts for employer and employee contributions and any NI reinvestment to be applied (based on the value of EmployersNiReinvestmentPercentage).

public decimal CalculatedEmployerContributionAmount { get; init; }

Property Value

decimal

EarningsBasis

Gets the earnings basis for the pension calculation (e.g., Qualifying Earnings).

public PensionsEarningsBasis EarningsBasis { get; init; }

Property Value

PensionsEarningsBasis

EmployeeAvcAmount

Gets any Additional Voluntary Contribution (AVC) made by the employee.

public decimal? EmployeeAvcAmount { get; init; }

Property Value

decimal?

EmployeeContributionFixedAmount

Gets the employee's fixed contribution amount, if applicable. If supplied, overrides EmployeeContributionPercentage.

public decimal? EmployeeContributionFixedAmount { get; init; }

Property Value

decimal?

EmployeeContributionPercentage

Gets the employee contribution percentage, expressed in percentage points, i.e., 5% = 5.0m.

public decimal? EmployeeContributionPercentage { get; init; }

Property Value

decimal?

EmployerContributionAmountBeforeSalaryExchange

Gets the portion of the total employer-only contribution made under salary exchange that pertains to the employer's contribution.

public decimal? EmployerContributionAmountBeforeSalaryExchange { get; init; }

Property Value

decimal?

EmployerContributionPercentage

Gets the employer contribution percentage, expressed in percentage points, i.e., 3% = 3.0m.

public decimal EmployerContributionPercentage { get; init; }

Property Value

decimal

EmployerNiSavingsToReinvest

Gets the amount of any employer NI savings that are to be re-invested in the employee's pension, adjusted by the value of EmployersNiReinvestmentPercentage. Only applies under salary exchange.

public decimal? EmployerNiSavingsToReinvest { get; init; }

Property Value

decimal?

EmployersNiReinvestmentPercentage

Gets the percentage of employer's NI saving to be re-invested into the employee's pension as an employer-only contribution, expressed in percentage points, i.e., 50% = 50.0m. Only applies under salary exchange.

public decimal? EmployersNiReinvestmentPercentage { get; init; }

Property Value

decimal?

NoPensionApplicable

Gets an empty PensionContributionCalculationResult that indicates that no pension is applicable.

public static IPensionContributionCalculationResult NoPensionApplicable { get; }

Property Value

IPensionContributionCalculationResult

PensionableSalaryInPeriod

Gets the pensionable salary for the period.

public decimal PensionableSalaryInPeriod { get; init; }

Property Value

decimal

SalaryExchangeApplied

Gets a value indicating whether salary exchange has been applied.

public bool SalaryExchangeApplied { get; init; }

Property Value

bool

SalaryExchangedAmount

Gets the amount the employee's gross salary exchanged under a salary exchange arrangement.

public decimal? SalaryExchangedAmount { get; init; }

Property Value

decimal?

TaxTreatment

Gets the pension tax treatment to be applied, i.e., relief at source vs net pay arrangement.

public PensionTaxTreatment TaxTreatment { get; init; }

Property Value

PensionTaxTreatment