Class TaxCalculator

Namespace

Payetools.IncomeTax

Assembly

Payetools.IncomeTax.dll

Represents a calculator for calculating income tax based on tax code, taxable income and tax paid to date. TaxCalculator implements ITaxCalculator; access to tax calculators is through the TaxCalculatorFactory; in normal use, TaxCalculators are not be created directly. A TaxCalculator is specific to a given pay frequency and tax period, which corresponds to an instance of a given PayDate.

public class TaxCalculator : ITaxCalculator

Inheritance

object

TaxCalculator

Implements

ITaxCalculator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

PayFrequency

Gets the pay frequency for this calculator.

public PayFrequency PayFrequency { get; }

Property Value

PayFrequency

TaxBandwidths

Gets the set of pro-rata tax bandwidths in use for a given tax year, tax regime and tax period.

public TaxPeriodBandwidthSet TaxBandwidths { get; }

Property Value

TaxPeriodBandwidthSet

TaxPeriod

Gets the relevant tax period for this calculator.

public int TaxPeriod { get; }

Property Value

int

TaxPeriodCount

Gets the number of tax periods within a given tax year, based on the supplied pay frequency.

public int TaxPeriodCount { get; }

Property Value

int

TaxYear

Gets the tax year that this calculator pertains to.

public TaxYear TaxYear { get; }

Property Value

TaxYear

Methods

Calculate(decimal, decimal, TaxCode, decimal, decimal, decimal, out ITaxCalculationResult)

Calculates the tax due based on tax code, total taxable salary and total tax paid to date.

public void Calculate(decimal totalTaxableSalaryInPeriod, decimal benefitsInKind, TaxCode taxCode, decimal taxableSalaryYearToDate, decimal taxPaidYearToDate, decimal taxUnpaidDueToRegulatoryLimit, out ITaxCalculationResult result)

Parameters

totalTaxableSalaryInPeriod decimal

Taxable pay in period (i.e., gross less pre-tax deductions but including benefits in kind).

benefitsInKind decimal

Benefits in kind element of the taxable pay for the period.

taxCode TaxCode

Individual's tax code. This is required in order to 1) determine the tax-free pay and 2) determine the appropriate calculation to perform. Note that an income tax calculator is specify to a given tax regime; an ArgumentException is thrown if the tax code is inconsistent with the tax regime for this calculator.

taxableSalaryYearToDate decimal

Total year to date taxable salary up to and including the end of the previous tax period.

taxPaidYearToDate decimal

Total year to date tax paid up to and including the end of the previous tax period.

taxUnpaidDueToRegulatoryLimit decimal

Any tax outstanding due to the effect of the regulatory limit.

result ITaxCalculationResult

An ITaxCalculationResult containing the tax now due plus related information from the tax calculation.

Exceptions

ArgumentException

Thrown if the tax code supplied is not consistent with the tax regime for this tax calculator.

InvalidReferenceDataException

Thrown if it is not possible to find an appropriate tax bandwidth in the reference data for this tax regime.