Struct TaxCalculationResult

Namespace

Payetools.IncomeTax.Model

Assembly

Payetools.IncomeTax.dll

Represents the result of an income tax calculation for an individual, providing the tax due plus a rich set of information about how the result was achieved.

public readonly struct TaxCalculationResult : ITaxCalculationResult

Implements

ITaxCalculationResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TaxCalculationResult(ITaxCalculator, TaxCode, decimal, decimal, decimal, decimal, int, decimal, decimal, decimal, decimal, decimal)

Initialises a new instance of TaxCalculationResult using the supplied parameters.

public TaxCalculationResult(ITaxCalculator calculator, TaxCode taxCode, decimal taxFreePayToEndOfPeriod, decimal taxableSalary, decimal previousPeriodSalaryYearToDate, decimal previousPeriodTaxPaidYearToDate, int highestApplicableTaxBandIndex, decimal incomeAtHighestApplicableBand, decimal taxAtHighestApplicableBand, decimal taxUnpaidDueToRegulatoryLimit, decimal taxDueBeforeRegulatoryLimitEffects, decimal finalTaxDue)

Parameters

calculator ITaxCalculator

Calculator (implementation of ITaxCalculator) used to perform this calculation.

taxCode TaxCode

TaxCode used in this calculation.

taxFreePayToEndOfPeriod decimal

Tax-free pay applicable to the end of the period, derived from the specified tax code.

taxableSalary decimal

Taxable salary used in this calculation.

previousPeriodSalaryYearToDate decimal

Year to date taxable salary paid up to and including the end of the previous period.

previousPeriodTaxPaidYearToDate decimal

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

highestApplicableTaxBandIndex int

Numeric index of the highest tax band (TaxPeriodBandwidthEntry) used in the calculation.

incomeAtHighestApplicableBand decimal

Total income to date that falls within the highest tax band used in the calculation.

taxAtHighestApplicableBand decimal

Total tax due for income to date that falls within the highest tax band used in the calculation.

taxUnpaidDueToRegulatoryLimit decimal

Previous period tax unpaid due to regulatory limit.

taxDueBeforeRegulatoryLimitEffects decimal

Tax due before considering the effects of regulatory limits.

finalTaxDue decimal

Tax due at the end of the period, based on the taxable earnings to the end of the period and accounting for any tax-free pay up to the end of the period, accounting for the effects of regulatory limits, both from this period and any prior periods.

Properties

Calculator

Gets the calculator (implementation of ITaxCalculator) used to perform this calculation.

public ITaxCalculator Calculator { get; }

Property Value

ITaxCalculator

FinalTaxDue

Gets the tax due at the end of the period, based on the taxable earnings to the end of the period and accounting for any tax-free pay up to the end of the period. This figure takes account of both the effect of the regulatory limit and the effect of any unpaid taxes due to the effect of the regulatory limit in previous periods.

public decimal FinalTaxDue { get; }

Property Value

decimal

HighestApplicableTaxBandIndex

Gets the numberic index of the highest tax band used in the calculation.

public int HighestApplicableTaxBandIndex { get; }

Property Value

int

IncomeAtHighestApplicableBand

Gets the total income to date that falls within the highest tax band used in the calculation.

public decimal IncomeAtHighestApplicableBand { get; }

Property Value

decimal

PreviousPeriodSalaryYearToDate

Gets the year to date taxable salary paid up to and including the end of the previous period.

public decimal PreviousPeriodSalaryYearToDate { get; }

Property Value

decimal

PreviousPeriodTaxPaidYearToDate

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

public decimal PreviousPeriodTaxPaidYearToDate { get; }

Property Value

decimal

TaxAtHighestApplicableBand

Gets the total tax due for income to date that falls within the highest tax band used in the calculation.

public decimal TaxAtHighestApplicableBand { get; }

Property Value

decimal

TaxCode

Gets the TaxCode used in this calculation.

public TaxCode TaxCode { get; }

Property Value

TaxCode

TaxDueBeforeApplicationOfRegulatoryLimit

Gets the tax due at the end of the period, based on the taxable earnings to the end of the period and accounting for any tax-free pay up to the end of the period. This is before considering the effect of regulatory limits.

public decimal TaxDueBeforeApplicationOfRegulatoryLimit { get; }

Property Value

decimal

TaxFreePayToEndOfPeriod

Gets the tax-free pay applicable to the end of the period, as given by the specified tax code. May be negative in the case of K tax codes.

public decimal TaxFreePayToEndOfPeriod { get; }

Property Value

decimal

TaxUnpaidDueToRegulatoryLimit

Gets any unpaid tax due to the regulatory limit. TODO: implement this properly.

public decimal TaxUnpaidDueToRegulatoryLimit { get; }

Property Value

decimal

TaxableSalaryAfterTaxFreePay

Gets the taxable salary used in this calculation. This is the gross salary less any tax-free pay (or plus any additional notional pay in the case of K tax codes).

public decimal TaxableSalaryAfterTaxFreePay { get; }

Property Value

decimal