Class Employment

Namespace

Payetools.Payroll.Model

Assembly

Payetools.Payroll.dll

Represents an employee's employment for payroll purposes.

public record Employment : IEmployment, IEquatable<Employment>

Inheritance

object

Employment

Implements

IEmployment

IEquatable<Employment>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Employment(in IEmployeePayrollHistoryYtd)

Initialises a new instance of Employment.

public Employment(in IEmployeePayrollHistoryYtd payrollHistoryYtd)

Parameters

payrollHistoryYtd IEmployeePayrollHistoryYtd

Employee's year-to-date payroll history.

Properties

DefaultPensionContributionLevels

Gets the default pension contributions to apply in each pay period, unless overridden by employee or employer instruction for that pay period.

public IPensionContributionLevels DefaultPensionContributionLevels { get; init; }

Property Value

IPensionContributionLevels

DirectorsNiCalculationMethod

Gets the method for calculating National Insurance contributions. Applicable only for directors; null otherwise.

public DirectorsNiCalculationMethod? DirectorsNiCalculationMethod { get; init; }

Property Value

DirectorsNiCalculationMethod?

EmploymentEndDate

Gets the employee's official employment termination date, i.e., their last working day. Null if the employee is still employed.

public DateOnly? EmploymentEndDate { get; init; }

Property Value

DateOnly?

EmploymentStartDate

Gets the employee's official employment start date.

public DateOnly EmploymentStartDate { get; init; }

Property Value

DateOnly

IsDirector

Gets a value indicating whether the employee is a company director.

public bool IsDirector { get; init; }

Property Value

bool

NiCategory

Gets the employee's NI category.

public NiCategory NiCategory { get; init; }

Property Value

NiCategory

NormalHoursWorkedBand

Gets the normal hours worked by the employee in one of several bands established by HMRC.

public NormalHoursWorkedBand NormalHoursWorkedBand { get; }

Property Value

NormalHoursWorkedBand

PayrollHistoryYtd

Gets the key figures from the employee's payroll history for the tax year to date.

public ref IEmployeePayrollHistoryYtd PayrollHistoryYtd { get; }

Property Value

IEmployeePayrollHistoryYtd

PayrollId

Gets the employee's payroll ID, as reported to HMRC. Sometimes known as "works number".

public PayrollId PayrollId { get; init; }

Property Value

PayrollId

PayrolledBenefits

Gets the list of payrolled benefits that apply to this employment.

public ImmutableArray<IPayrolledBenefit> PayrolledBenefits { get; init; }

Property Value

ImmutableArray<IPayrolledBenefit>

PensionScheme

Gets the pension scheme that the employee is a member of. Null if they are not a member of any scheme.

public IPensionScheme? PensionScheme { get; init; }

Property Value

IPensionScheme

PrimaryPayStructure

Gets the employee's primary pay structure.

public IEmployeePayStructure PrimaryPayStructure { get; init; }

Property Value

IEmployeePayStructure

RecurringDeductions

Gets the list of recurring deductions for an employee.

public ImmutableArray<IRecurringDeduction> RecurringDeductions { get; init; }

Property Value

ImmutableArray<IRecurringDeduction>

RecurringEarnings

Gets the list of recurring earnings elements for an employee.

public ImmutableArray<IRecurringEarnings> RecurringEarnings { get; init; }

Property Value

ImmutableArray<IRecurringEarnings>

StudentLoanInfo

Gets the employee's current student loan status.

public StudentLoanInfo? StudentLoanInfo { get; init; }

Property Value

StudentLoanInfo?

TaxCode

Gets the employee's tax code.

public TaxCode TaxCode { get; init; }

Property Value

TaxCode