Class HmrcReferenceDataProvider

Namespace

Payetools.ReferenceData

Assembly

Payetools.ReferenceData.dll

Provider of HMRC reference data. Should be instantiated via the HmrcReferenceDataProviderFactory.

public class HmrcReferenceDataProvider : IHmrcReferenceDataProvider, ITaxReferenceDataProvider, INiReferenceDataProvider, IPensionsReferenceDataProvider, INmwReferenceDataProvider, IStudentLoanReferenceDataProvider

Inheritance

object

HmrcReferenceDataProvider

Implements

IHmrcReferenceDataProvider

ITaxReferenceDataProvider

INiReferenceDataProvider

IPensionsReferenceDataProvider

INmwReferenceDataProvider

IStudentLoanReferenceDataProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

HmrcReferenceDataProvider(IEnumerable<HmrcTaxYearReferenceDataSet>)

Initialised a new instance of HmrcReferenceDataProvider using the supplied data sets.

public HmrcReferenceDataProvider(IEnumerable<HmrcTaxYearReferenceDataSet> dataSets)

Parameters

dataSets IEnumerable<HmrcTaxYearReferenceDataSet>

IEnumerable of HmrcTaxYearReferenceDataSets to initialise this provider with.

Remarks

Although this constructor is public, it is recommended that instances of this class be initialised through a HmrcReferenceDataProviderFactory.

Properties

Health

Gets the health of this reference data provider as human-readable string.

public string Health { get; }

Property Value

string

Methods

GetBasicRateOfTaxForTaxRelief(TaxYear, PayFrequency, int)

Gets the basic rate of tax applicable across all tax regimes for relief at source pension contributions, for the specified tax year. (As at the time of writing, one basic rate of tax is used across all jurisdictions in spite of the fact that some have a lower basic rate of tax.)

public decimal GetBasicRateOfTaxForTaxRelief(TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

taxYear TaxYear

Applicable tax year.

payFrequency PayFrequency

Applicable pay frequency. Only used if there has been an in-year change.

taxPeriod int

Applicable tax period. Only used if there has been an in-year change.

Returns

decimal

Basic rate of tax applicable for the tax year.

GetDirectorsNiRatesForPayDate(PayDate)

Gets a read-only dictionary that maps NiCategory values to the set of rates to be applied for the specified pay date, for directors. (For most tax years, this method returns null, but if there have been in-year changes, specific directors' rates may apply.)

public ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry> GetDirectorsNiRatesForPayDate(PayDate payDate)

Parameters

payDate PayDate

Applicable pay date.

Returns

ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry>

Read-only dictionary that maps NiCategory values to the appropriate set of rates for the specified point in time. If specific rates apply for directors, theses are returned, otherwise the regular employee/employer rates are returned.

GetNiRatesForPayDate(PayDate)

Gets a read-only dictionary that maps NiCategory values to the set of rates to be applied for the specified pay date.

public ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry> GetNiRatesForPayDate(PayDate payDate)

Parameters

payDate PayDate

Applicable pay date.

Returns

ReadOnlyDictionary<NiCategory, INiCategoryRatesEntry>

Read-only dictionary that maps NiCategory values to the appropriate set of rates for the specified point in time.

GetNiThresholdsForPayDate(PayDate)

Gets the NI thresholds for the specified pay date.

public INiThresholdSet GetNiThresholdsForPayDate(PayDate payDate)

Parameters

payDate PayDate

Applicable pay date.

Returns

INiThresholdSet

An instance of INiThresholdSet containing the thresholds for the specified point in time.

GetNmwLevelsForTaxYearAndPeriod(TaxYear, PayFrequency, int)

Gets the NMW/NLW levels for the specified tax year and tax period, as denoted by the supplied pay frequency and pay period.

public INmwLevelSet GetNmwLevelsForTaxYearAndPeriod(TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

taxYear TaxYear

Applicable tax year.

payFrequency PayFrequency

Applicable pay frequency.

taxPeriod int

Applicable tax period.

Returns

INmwLevelSet

An instance of INmwLevelSet containing the levels for the specified point in time.

GetStudentLoanRatesForTaxYearAndPeriod(TaxYear, PayFrequency, int)

Gets the student and post graduate deduction rates for the specified tax year and tax period, as denoted by the supplied pay frequency. and pay period.

public IStudentLoanRateSet GetStudentLoanRatesForTaxYearAndPeriod(TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

taxYear TaxYear

Applicable tax year.

payFrequency PayFrequency

Applicable pay frequency.

taxPeriod int

Applicable tax period.

Returns

IStudentLoanRateSet

An instance of IStudentLoanRateSet containing the rates for the specified point in time.

GetStudentLoanThresholdsForTaxYearAndPeriod(TaxYear, PayFrequency, int)

Gets the set of annual thresholds to be applied for a given tax year and tax period.

public IStudentLoanThresholdSet GetStudentLoanThresholdsForTaxYearAndPeriod(TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

taxYear TaxYear

Applicable tax year.

payFrequency PayFrequency

Applicable pay frequency.

taxPeriod int

Applicable tax period.

Returns

IStudentLoanThresholdSet

An implementation of IStudentLoanThresholdSet that provides the appropriate set of annual thresholds for the specified point.

GetTaxBandsForTaxYearAndPeriod(TaxYear, PayFrequency, int)

Retrieves the tax bands for a given tax year in the form of a dictionary (ReadOnlyDictionary<TKey, TValue>) keyed on tax regime, i.e., CountriesForTaxPurposes.

public ReadOnlyDictionary<CountriesForTaxPurposes, TaxBandwidthSet> GetTaxBandsForTaxYearAndPeriod(TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

taxYear TaxYear

Desired tax year.

payFrequency PayFrequency

Pay frequency pertaining. Used in conjunction with the taxPeriod parameter to determine the applicable date (in case of in-year tax changes).

taxPeriod int

Tax period, e.g., 1 for month 1. Currently ignored on the assumption that in-year tax changes are not anticipated but provided for future .

Returns

ReadOnlyDictionary<CountriesForTaxPurposes, TaxBandwidthSet>

ReadOnlyDictionary of TaxBandwidthSet's keyed on tax regime.

Remarks

Although ReadOnlyDictionary is not guaranteed to be thread-safe, in the current implementation the underlying Dictionary is guaranteed not to change, so thread-safety can be assumed.

GetThresholdsForQualifyingEarnings(TaxYear, PayFrequency, int)

Gets the thresholds for Qualifying Earnings for the specified tax year and tax period, as denoted by the supplied pay frequency and pay period.

public (decimal LowerLimit, decimal UpperLimit) GetThresholdsForQualifyingEarnings(TaxYear taxYear, PayFrequency payFrequency, int taxPeriod)

Parameters

taxYear TaxYear

Applicable tax year.

payFrequency PayFrequency

Applicable pay frequency.

taxPeriod int

Applicable tax period.

Returns

(decimal employeeTotal, decimal employerTotal)

A tuple containing the lower and upper thresholds for the specified pay frequency and point in time.