Interface IEmployment
Interface that represents an employee's employment for payroll purposes. The PayrollId provides a handle to the employee that this employment refers to.
public interface IEmploymentProperties
DefaultPensionContributionLevels
Gets the default pension contributions to apply in each pay period, unless overridden by employee or employer instruction for that pay period.
IPensionContributionLevels DefaultPensionContributionLevels { get; }Property Value
DirectorsNiCalculationMethod
Gets the method for calculating National Insurance contributions. Applicable only for directors; null otherwise.
DirectorsNiCalculationMethod? DirectorsNiCalculationMethod { get; }Property Value
EmploymentEndDate
Gets the employee's official employment termination date, i.e., their last working day. Null if the employee is still employed.
DateOnly? EmploymentEndDate { get; }Property Value
EmploymentStartDate
Gets the employee's official employment start date.
DateOnly EmploymentStartDate { get; }Property Value
IsDirector
Gets a value indicating whether the employee is a company director.
bool IsDirector { get; }Property Value
NiCategory
Gets the employee's NI category.
NiCategory NiCategory { get; }Property Value
NormalHoursWorkedBand
Gets the normal hours worked by the employee in one of several bands established by HMRC.
NormalHoursWorkedBand NormalHoursWorkedBand { get; }Property Value
PayrollHistoryYtd
Gets the key figures from the employee's payroll history for the tax year to date.
ref IEmployeePayrollHistoryYtd PayrollHistoryYtd { get; }Property Value
PayrollId
Gets the employee's payroll ID, as reported to HMRC. Sometimes known as "works number".
PayrollId PayrollId { get; }Property Value
PayrolledBenefits
Gets the list of payrolled benefits that apply to this employment.
ImmutableArray<IPayrolledBenefit> PayrolledBenefits { get; }Property Value
PensionScheme
Gets the pension scheme that the employee is a member of. Null if they are not a member of any scheme.
IPensionScheme? PensionScheme { get; }Property Value
PrimaryPayStructure
Gets the employee's primary pay structure.
IEmployeePayStructure PrimaryPayStructure { get; }Property Value
RecurringDeductions
Gets the list of recurring deductions for an employee.
ImmutableArray<IRecurringDeduction> RecurringDeductions { get; }Property Value
RecurringEarnings
Gets the list of recurring earnings elements for an employee.
ImmutableArray<IRecurringEarnings> RecurringEarnings { get; }Property Value
StudentLoanInfo
Gets the employee's current student loan status.
StudentLoanInfo? StudentLoanInfo { get; }Property Value
TaxCode
Gets the employee's tax code.
TaxCode TaxCode { get; }