Class NiYtdHistory

Namespace

Payetools.NationalInsurance.Model

Assembly

Payetools.NationalInsurance.dll

Represents an employee's year to date National Insurance history.

public record NiYtdHistory : IEquatable<NiYtdHistory>

Inheritance

object

NiYtdHistory

Implements

IEquatable<NiYtdHistory>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NiYtdHistory(in INiCalculationResult)

Initialises a new instance of NiYtdHistory with the supplied NI calculation result. This constructor is intended to be used for the first time a payrun is run during the tax year.

public NiYtdHistory(in INiCalculationResult initialNiCalculationResult)

Parameters

initialNiCalculationResult INiCalculationResult

NI calculation result for the first payrun of the tax year for a given employee.

NiYtdHistory(in ImmutableList<IEmployeeNiHistoryEntry>)

Initialises a new instance of NiYtdHistory.

public NiYtdHistory(in ImmutableList<IEmployeeNiHistoryEntry> entries)

Parameters

entries ImmutableList<IEmployeeNiHistoryEntry>

NI history entries for the tax year to date.

Methods

Add(in INiCalculationResult)

Returns a new instance of NiYtdHistory with the previous history updated by the latest payrun result. Where the most recent entry in the history matches the current NI category, that entry is updated, but otherwise a new history entry is created and appended.

public NiYtdHistory Add(in INiCalculationResult latestNiCalculationResult)

Parameters

latestNiCalculationResult INiCalculationResult

Result of this payrun's NI calculation.

Returns

NiYtdHistory

A new instance of NiYtdHistory with the previous history updated by the latest payrun result.

GetNiYtdTotals()

Gets the totals of employee and employer NI contributions paid to date across all entries.

public (decimal employeeTotal, decimal employerTotal) GetNiYtdTotals()

Returns

(decimal employeeTotal, decimal employerTotal)

Totals of employee and employer NI contributions paid tear to date.