Struct StudentLoanCalculationResult

Namespace

Payetools.StudentLoans.Model

Assembly

Payetools.StudentLoans.dll

Represents the result of a student loan calculation.

public readonly struct StudentLoanCalculationResult : IStudentLoanCalculationResult

Implements

IStudentLoanCalculationResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

HasPostGradLoan

Gets a value indicating whether post-graduate loan deductions were applied.

public bool HasPostGradLoan { get; init; }

Property Value

bool

NoStudentLoanApplicable

Gets an empty StudentLoanCalculationResult that indicates that no pension is applicable.

public static StudentLoanCalculationResult NoStudentLoanApplicable { get; }

Property Value

StudentLoanCalculationResult

PostGradLoanThresholdUsed

Gets the post-graduate loan threshold for the period used in calculating student loan (but not student loan) deductions.

public decimal? PostGradLoanThresholdUsed { get; init; }

Property Value

decimal?

PostGraduateLoanDeduction

Gets the post-graduate loan deduction applied. amounts.

public decimal PostGraduateLoanDeduction { get; init; }

Property Value

decimal

StudentLoanDeduction

Gets the student loan deduction applied (excluding post-grad loan deductions). amounts.

public decimal StudentLoanDeduction { get; init; }

Property Value

decimal

StudentLoanThresholdUsed

Gets the student loan threshold for the period used in calculating student loan (but not post-graduate loan) deductions.

public decimal? StudentLoanThresholdUsed { get; init; }

Property Value

decimal?

StudentLoanType

Gets the optional student loan type. Null if no student loan applied. (Post-graduate loans are treated separately via HasPostGradLoan.

public StudentLoanType? StudentLoanType { get; init; }

Property Value

StudentLoanType?

TotalDeduction

Gets the total deduction to be made, the sum of any student and post-graduate loan deduction amounts.

public decimal TotalDeduction { get; init; }

Property Value

decimal