Class TaxYear

Namespace

Payetools.Common.Model

Assembly

Payetools.Common.dll

Represents a given UK tax year, running from 6th April of a given year through to 5th April the following year.

public record TaxYear : IEquatable<TaxYear>

Inheritance

object

TaxYear

Implements

IEquatable<TaxYear>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

TaxYear provides utility methods to access the relevant tax regimes (i.e., sub-countries within the UK) which have changed over the period 2018 to date. TaxYear also provides conversions from dates to tax periods, based on payment frequency.

Constructors

TaxYear(TaxYearEnding)

Initialises a new instance of TaxYear based on the supplied TaxYearEnding value.

public TaxYear(TaxYearEnding taxYearEnding)

Parameters

taxYearEnding TaxYearEnding

TaxYearEnding enum value for this tax year.

TaxYear(DateOnly)

Initialises a new instance of TaxYear based on the supplied date.

public TaxYear(DateOnly taxDate)

Parameters

taxDate DateOnly

Date to create TaxYear for.

Properties

Current

Gets the TaxYearEnding for the "current" tax year (based on today's date).

public static TaxYearEnding Current { get; }

Property Value

TaxYearEnding

EndOfTaxYear

Gets the date of the end of this tax year.

public DateOnly EndOfTaxYear { get; init; }

Property Value

DateOnly

StartOfTaxYear

Gets the date of the start of this tax year.

public DateOnly StartOfTaxYear { get; init; }

Property Value

DateOnly

TaxYearEnding

Gets the TaxYearEnding enumeration value for this TaxYear.

public TaxYearEnding TaxYearEnding { get; init; }

Property Value

TaxYearEnding

Methods

GetCountriesForYear()

Gets the list (as an array) of the country groupings that are applicable for a given tax year.

public CountriesForTaxPurposes[] GetCountriesForYear()

Returns

CountriesForTaxPurposes[]

Array of CountriesForTaxPurposes values listing the tax regime groupings for this tax year.

Exceptions

InvalidOperationException

Thrown if an invalid/unspecified tax year is provided.

GetDefaultCountriesForYear()

Gets the 'default' tax regime for this tax year as an CountriesForTaxPurposes value. This is the regime that all other tax treatments fall into if they are not in a specific regime, e.g., Scotland.

public CountriesForTaxPurposes GetDefaultCountriesForYear()

Returns

CountriesForTaxPurposes

Default tax regime for this tax year.

Exceptions

InvalidOperationException

Thrown if the tax year is invalid or has not been specified.

GetLastDayOfTaxPeriod(PayFrequency, int)

Gets the very last day of the specified tax period based on the applicable pay frequency.

public DateOnly GetLastDayOfTaxPeriod(PayFrequency payFrequency, int taxPeriod)

Parameters

payFrequency PayFrequency

Applicable pay frequency.

taxPeriod int

Applicable tax period.

Returns

DateOnly

Last day of the tax period.

Exceptions

ArgumentException

Thrown if the supplied pay frequency is not supported.

GetMonthNumber(DateOnly, PayFrequency)

Gets the tax month number from the supplied pay date. Where the pay frequency is other than monthly, the pay period duration is taken into account, meaning, for example, that a quarterly payment made on 5th July will have a month number of 3, but so would a similar payment roughly one month earlier, on say 5th June.

public int GetMonthNumber(DateOnly payDate, PayFrequency payFrequency = PayFrequency.Monthly)

Parameters

payDate DateOnly

Pay date.

payFrequency PayFrequency

Applicable pay frequency. Defaults to monthly.

Returns

int

Tax month number.

GetTaxPeriod(DateOnly, PayFrequency)

Gets the tax period for the supplied pay date and payment frequencey. For example, if the pay frequency is monthly and the pay date is, say, 20th May, then the tax pariod is 2, as in "Month 2".

public int GetTaxPeriod(DateOnly payDate, PayFrequency payFrequency)

Parameters

payDate DateOnly

Pay date to determine tax period for.

payFrequency PayFrequency

Payment frequency applicable.

Returns

int

Relevant tax period.

Exceptions

ArgumentException

Thrown if the pay date falls outside this tax year.

GetWeekNumber(DateOnly, PayFrequency)

Gets the tax week number from the supplied pay date. Where the pay frequency is other than weekly, the pay period duration is taken into account, meaning, for example, that a 4-weekly payment made on 3rd March will have a week number of 4, but so would a similar payment roughly one week earlier, on say 25th February.

public int GetWeekNumber(DateOnly payDate, PayFrequency payFrequency = PayFrequency.Weekly)

Parameters

payDate DateOnly

Pay date.

payFrequency PayFrequency

Applicable pay frequency. Defaults to weekly.

Returns

int

Tax week number for the supplied pay date and (optional) pay frequency.

IsValidForYear(CountriesForTaxPurposes)

Determines whether the supplied country groupings is valid for this tax year.

public bool IsValidForYear(CountriesForTaxPurposes countries)

Parameters

countries CountriesForTaxPurposes

One or more CountriesForTaxPurposes values.

Returns

bool

True if the supplied countries parameter is valid for this tax year; false otherwise.