Class NiThresholdSet

Namespace

Payetools.NationalInsurance.ReferenceData

Assembly

Payetools.NationalInsurance.dll

Represents a set of National Insurance thresholds as defined by HMRC for a given tax year or portion of a tax year.

public class NiThresholdSet : INiThresholdSet, IEnumerable<INiThresholdEntry>, IEnumerable

Inheritance

object

NiThresholdSet

Implements

INiThresholdSet

IEnumerable<INiThresholdEntry>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

IEnumerableExtensions.WithIndex<T>(IEnumerable<T>)

Constructors

NiThresholdSet(INiThresholdSet, decimal)

Initialises a new instance of NiThresholdSet adjusted by the supplied prorata factor. Used in director's NI calculation when an employee is a director for part of the year.

public NiThresholdSet(INiThresholdSet originalAnnualNiThresholds, decimal proRataFactor)

Parameters

originalAnnualNiThresholds INiThresholdSet

Original set of thresholds.

proRataFactor decimal

Pro-rata factor to apply to each threshold.

NiThresholdSet(ImmutableList<INiThresholdEntry>)

Initialises a new instance of NiThresholdSet.

public NiThresholdSet(ImmutableList<INiThresholdEntry> niThresholds)

Parameters

niThresholds ImmutableList<INiThresholdEntry>

Immutable input list of thresholds.

Exceptions

ArgumentException

Thrown if the number of thresholds supplied does not match the expected number of possible thresholds.

Properties

Count

Gets the number of threshold value this threshold set contains.

public int Count { get; }

Property Value

int

this[int]

Gets the INiThresholdEntry at the specified index.

public INiThresholdEntry this[int index] { get; }

Parameters

index int

Zero-based index into list.

Property Value

INiThresholdEntry

The INiThresholdEntry for the specified index.

Methods

GetEnumerator()

Returns an enumerator that iterates through the thresholds (of type INiThresholdEntry).

public IEnumerator<INiThresholdEntry> GetEnumerator()

Returns

IEnumerator<INiThresholdEntry>

An enumerator that can be used to iterate through the collection of thresholds.

Exceptions

InvalidOperationException

Throw if the enumerator cannot be obtained. (Should never be thrown).

GetThreshold(NiThresholdType)

Gets the annual threshold for the period for the specified threshold type.

public decimal GetThreshold(NiThresholdType thresholdType)

Parameters

thresholdType NiThresholdType

Applicable threshold (e.g., LEL, UEL, PT).

Returns

decimal

Annual threshold value applicable to threshold type.

ToString()

Gets a string representation of this NiPeriodThresholdSet.

public override string ToString()

Returns

string

String representation of this instance.