Class NiCalculator

Namespace

Payetools.NationalInsurance

Assembly

Payetools.NationalInsurance.dll

Represents a National Insurance calculator that implements INiCalculator.

public class NiCalculator : INiCalculator

Inheritance

object

NiCalculator

Implements

INiCalculator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NiCalculator(INiThresholdSet, INiPeriodThresholdSet, ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry>, ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry>, bool)

Initialises a new NiCalculator with the supplied thresholds and rates for the period.

public NiCalculator(INiThresholdSet niAnnualThresholds, INiPeriodThresholdSet niPeriodThresholds, ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry> niRateEntriesForRegularEmployees, ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry> niDirectorsRateEntries, bool isLastPayPeriodInTaxYear = false)

Parameters

niAnnualThresholds INiThresholdSet

NI threshold set for the full tax year applicable to this NI calculator.

niPeriodThresholds INiPeriodThresholdSet

NI threshold set for the tax period applicable to this NI calculator.

niRateEntriesForRegularEmployees ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry>

NI rates for the tax period applicable to non-directors for this NI calculator.

niDirectorsRateEntries ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry>

NI rates for the tax period applicable to directors for this NI calculator.

isLastPayPeriodInTaxYear bool

Flag indicating whether this calculator is being used to calculate NI for the last pay period of the tax year, which is required for directors' NI. Optional, defaulted to false.

Methods

Calculate(NiCategory, decimal, out INiCalculationResult)

Calculates the National Insurance contributions required for an employee for a given pay period, based on their NI-able salary and their allocated National Insurance category letter.

public void Calculate(NiCategory niCategory, decimal nicableEarningsInPeriod, out INiCalculationResult result)

Parameters

niCategory NiCategory

National Insurance category.

nicableEarningsInPeriod decimal

NI-able salary for the period.

result INiCalculationResult

The NI contributions due via an instance of a type that implements INiCalculationResult.

CalculateDirectors(DirectorsNiCalculationMethod, NiCategory, decimal, decimal, decimal, decimal, decimal?, out INiCalculationResult)

Calculates the National Insurance contributions required for a company director for a given pay period, based on their NI-able salary and their allocated National Insurance category letter.

public void CalculateDirectors(DirectorsNiCalculationMethod calculationMethod, NiCategory niCategory, decimal nicableEarningsInPeriod, decimal nicableEarningsYearToDate, decimal employeesNiPaidYearToDate, decimal employersNiPaidYearToDate, decimal? proRataFactor, out INiCalculationResult result)

Parameters

calculationMethod DirectorsNiCalculationMethod

Calculation method to use.

niCategory NiCategory

National Insurance category.

nicableEarningsInPeriod decimal

Ni-able earnings in this period.

nicableEarningsYearToDate decimal

NI-able salary for the period.

employeesNiPaidYearToDate decimal

Total employees NI paid so far this tax year up to and including the end of the previous period.

employersNiPaidYearToDate decimal

Total employers NI paid so far this tax year up to and including the end of the previous period.

proRataFactor decimal?

Factor to apply to annual thresholds when the employee starts being a director part way through the tax year. Null if not applicable.

result INiCalculationResult

The NI contributions due via an instance of a type that implements INiCalculationResult.