Table of Contents

Namespace Payetools.Payroll.Model

Namespaces Classes

DeductionEntry

Represents a deduction from payroll.

EarningsEntry

Represents an element of an employee's pay.

EarningsHistoryYtd

Represents an employee's earnings history for the tax year to date.

Employee

Represents an employee for payroll purposes.

EmployeePayRunInputEntry

Represents an employee payrun entry, i.e., all the information needed to prepare the payroll record for the employee for the pay period in question.

EmployeePayRunResult

Represents a payrun entry for one employee for a specific payrun.

EmployeePayrollHistoryYtd

Represents the historical set of information for an employee's payroll for the current tax year.

Employer

Represents an employer for payroll purposes.

Employment

Represents an employee's employment for payroll purposes.

GenericDeduction

Represents the various types of deduction that can be made from payroll.

GenericEarnings

Represents a generic pay component (e.g., salary, bonus, sick pay, etc.).

HourlyPaidPayStructure

Represents the pay structure for hourly paid employees.

NmwHourlyPaidPayStructure

Represents an hourly paid pay structure that tracks National Minimum/Living Wage levels.

P45FromPreviousEmployment

Represents the information from a P45 provided from previous employment.

PayRunResult

Represents the output of a payrun.

PayrolledBenefitForPeriod

Represents a payrolled benefit as applicable to one payroll period.

PensionContributionLevels

Defines the levels to be applied for contributions into an employee's pension.

SalariedPayStructure

Represents the pay structure for salaried (i.e., annually paid) employees.

Namespaces Structs

StudentLoanInfo

Struct that holds student loan status information for an employee.

Namespaces Interfaces

IDeductionDetails

Interface that represents the various types of deduction that can be made from payroll.

IDeductionEntry

Interface that represents a deduction from payroll.

IDeductionHistoryYtd

Interface that represents an employee's deductions history for the tax year to date.

IEarningsDetails

Interface that represents a pay component (e.g., salary, bonus, sick pay, etc.).

IEarningsEntry

Represents an element of an employee's pay.

IEarningsHistoryYtd

Interface that represents an employee's earnings history for the tax year to date.

IEmployee

Interface that represents an employee for payroll purposes.

IEmployeePayRunInputEntry

Represents an employee payrun entry, i.e., all the information needed to prepare the payroll record for the employee for the pay period in question.

IEmployeePayRunResult

Interface that represents a payrun entry for one employee for a specific payrun.

IEmployeePayStructure

Interface that represents an employee's pay structure.

IEmployeePayrollHistoryYtd

Interface for types that represent the historical set of information for an employee's payroll for the current tax year.

IEmployer

Interface that represents an employer for payroll purposes.

IEmployment

Interface that represents an employee's employment for payroll purposes. The PayrollId provides a handle to the employee that this employment refers to.

INewStarter

Interface that represents a new starter for employment purposes.

IPayRunDetails

Interface that represents key details about a given payrun.

IPayRunResult

Interface that represents the output of a given pay run.

IPayrollAmount

Interface that types should implement to communicate an amount that is either fixed or calculated as a product of quantity in units and per unit rate.

IPayrolledBenefit

Represents a payrolled benefit.

IPayrolledBenefitForPeriod

Interface that represents the effect of a payrolled on a given pay reference period.

IRecurringDeduction

Interface that represents a recurring deduction for an employee.

IRecurringEarnings

Interface that represents a recurring earnings for an employee.

Namespaces Enums

PayRateType

Enum representing different pay types, i.e., salaried, hourly paid, etc.

PayRateUnits

Enum representing different pay units, i.e., per annum, per hour, etc.

StarterDeclaration

Represents a new employee's starter declaration, if provided. In the case of high earners, the starter declaration may be omitted and the employee put on a 0T tax code rather than a BR or "emergency tax code", in order to avoid paying insufficient tax.