Struct EmployeeNiHistoryEntry

Namespace

Payetools.NationalInsurance.Model

Assembly

Payetools.NationalInsurance.dll

Represents once element of the employee's NI history during the current tax year. For employees that have only have one NI category throughout the tax year, they will have just one instance of EmployeeNiHistoryEntry applicable. But it is of course possible for an employee's NI category to change throughout the tax year (for example because they turned 21 years of age), and in this case, multiple records must be held.

public readonly struct EmployeeNiHistoryEntry : IEmployeeNiHistoryEntry

Implements

IEmployeeNiHistoryEntry

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

EmployeeNiHistoryEntry(NiCategory, NiEarningsBreakdown, decimal, decimal, decimal, decimal)

Initialises a new instance of EmployeeNiHistoryEntry.

public EmployeeNiHistoryEntry(NiCategory niCategoryPertaining, NiEarningsBreakdown niEarningsBreakdown, decimal grossNicableEarnings, decimal employeeContribution, decimal employerContribution, decimal totalContribution)

Parameters

niCategoryPertaining NiCategory

NI category for this record.

niEarningsBreakdown NiEarningsBreakdown

NI earnings breakdown for this record.

grossNicableEarnings decimal

Gross Nicable earnings for this record.

employeeContribution decimal

Employee contribution for this record.

employerContribution decimal

Employer contribution for this record.

totalContribution decimal

Total (i.e., employee + employer) contribution for this record.

EmployeeNiHistoryEntry(in INiCalculationResult)

Initialises a new EmployeeNiHistoryEntry from the supplied calculation result.

public EmployeeNiHistoryEntry(in INiCalculationResult result)

Parameters

result INiCalculationResult

NI calculation result.

Properties

EarningsAboveFUSTUpToAndIncludingUEL

Gets the earnings up above the Freeport Upper Secondary Threshold and up to and including the Upper Earnings Limit for this record.

public decimal EarningsAboveFUSTUpToAndIncludingUEL { get; }

Property Value

decimal

EarningsAboveLELUpToAndIncludingST

Gets the earnings up above the Lower Earnings Limit and up to and including the Secondary Threshold for this record.

public decimal EarningsAboveLELUpToAndIncludingST { get; }

Property Value

decimal

EarningsAbovePTUpToAndIncludingFUST

Gets the earnings up above the Primary Threshold and up to and including the Freeport Upper Secondary Threshold for this record.

public decimal EarningsAbovePTUpToAndIncludingFUST { get; }

Property Value

decimal

EarningsAboveSTUpToAndIncludingPT

Gets the earnings up above the Secondary Threshold and up to and including the Primary Threshold for this record.

public decimal EarningsAboveSTUpToAndIncludingPT { get; }

Property Value

decimal

EarningsAboveSTUpToAndIncludingUEL

Gets the earnings up above the Secondary Threshold and up to and including the Upper Earnings Limit for this record.

public decimal EarningsAboveSTUpToAndIncludingUEL { get; }

Property Value

decimal

EarningsAboveUEL

Gets the earnings up above the Upper Earnings Limit for this record.

public decimal EarningsAboveUEL { get; }

Property Value

decimal

EarningsUpToAndIncludingLEL

Gets the earnings up to and including the Lower Earnings Limit for this record.

public decimal EarningsUpToAndIncludingLEL { get; }

Property Value

decimal

EmployeeContribution

Gets the total employee contribution made during the duration of this record.

public decimal EmployeeContribution { get; }

Property Value

decimal

EmployerContribution

Gets the total employer contribution made during the duration of this record.

public decimal EmployerContribution { get; }

Property Value

decimal

GrossNicableEarnings

Gets the gross NI-able earnings applicable for the duration of this record.

public decimal GrossNicableEarnings { get; }

Property Value

decimal

NiCategoryPertaining

Gets the National Insurance category letter pertaining to this record.

public NiCategory NiCategoryPertaining { get; }

Property Value

NiCategory

TotalContribution

Gets the total contribution (employee + employer) made during the duration of this record.

public decimal TotalContribution { get; }

Property Value

decimal

Methods

Add(in INiCalculationResult)

Adds the results of an NI calculation to the current history and returns a new instance of IEmployeeNiHistoryEntry with the results applied.

public IEmployeeNiHistoryEntry Add(in INiCalculationResult result)

Parameters

result INiCalculationResult

NI calculation results to add to this history entry.

Returns

IEmployeeNiHistoryEntry

New instance of IEmployeeNiHistoryEntry with the NI calculation result applied.