Struct NiCalculationResult

Namespace

Payetools.NationalInsurance.Model

Assembly

Payetools.NationalInsurance.dll

Represents a National Insurance calculation result.

public readonly struct NiCalculationResult : INiCalculationResult

Implements

INiCalculationResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

NiCalculationResult(NiCategory, decimal, INiCategoryRatesEntry, INiThresholdSet, NiEarningsBreakdown, decimal, decimal, decimal?)

Initialises a new instance of NiCalculationResult with the supplied values.

public NiCalculationResult(NiCategory category, decimal nicablePay, INiCategoryRatesEntry ratesUsed, INiThresholdSet thresholdsUsed, NiEarningsBreakdown earningsBreakdown, decimal employeeContribution, decimal employerContribution, decimal? totalContribution = null)

Parameters

category NiCategory

NI category used for this calculation.

nicablePay decimal

Gross pay for NI purposes ("Nicable pay") used in this calculation.

ratesUsed INiCategoryRatesEntry

Rates used for this calculation.

thresholdsUsed INiThresholdSet

Thresholds used for this calculation.

earningsBreakdown NiEarningsBreakdown

Breakdown of earnings across each of the different National Insurance thresholds.

employeeContribution decimal

Total employee contribution due as a result of this calculation.

employerContribution decimal

Total employer contribution due as a result of this calculation.

totalContribution decimal?

Total contribution due (employee + employer) as a result of this calculation.

Properties

EarningsBreakdown

Gets the breakdown of earnings across each of the different National Insurance thresholds.

public NiEarningsBreakdown EarningsBreakdown { get; }

Property Value

NiEarningsBreakdown

EmployeeContribution

Gets the total employee contribution due as a result of this calculation.

public decimal EmployeeContribution { get; }

Property Value

decimal

EmployerContribution

Gets the total employer contribution due as a result of this calculation.

public decimal EmployerContribution { get; }

Property Value

decimal

NiCategory

Gets the NI category used for this calculation.

public NiCategory NiCategory { get; }

Property Value

NiCategory

NicablePay

Gets the gross pay for NI purposes ("Nicable pay") used in this calculation.

public decimal NicablePay { get; }

Property Value

decimal

NoRecordingRequired

Gets a static value representing an empty result with the NoRecordingRequiredIndicator set to true.

public static NiCalculationResult NoRecordingRequired { get; }

Property Value

NiCalculationResult

NoRecordingRequiredIndicator

Gets a value indicating whether the results of this calculation need to be reported to HMRC.

public bool NoRecordingRequiredIndicator { get; init; }

Property Value

bool

RatesUsed

Gets the rates used for this calculation.

public INiCategoryRatesEntry RatesUsed { get; }

Property Value

INiCategoryRatesEntry

ThresholdsUsed

Gets the set of thresholds used for this calculation. These thresholds are adjusted to match the length of the pay period.

public INiThresholdSet ThresholdsUsed { get; }

Property Value

INiThresholdSet

TotalContribution

Gets the total contribution due (employee + employer) as a result of this calculation.

public decimal TotalContribution { get; }

Property Value

decimal

Methods

ToString()

Gets the string representation of this calculation result.

public override string ToString()

Returns

string

String representation of this calculation result.