com.xero.models.payrolluk

Class Payslip

java.lang.Object

com.xero.models.payrolluk.Payslip

public class Payslip
extends Object

Payslip

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Payslip.PaymentMethodEnum The payment method code

Constructor Summary

Constructors

Constructor and Description
Payslip()

Method Summary

Modifier and Type	Method and Description
Payslip	addBenefitLinesItem(BenefitLine benefitLinesItem)
Payslip	addCourtOrderLinesItem(CourtOrderLine courtOrderLinesItem)
Payslip	addDeductionLinesItem(DeductionLine deductionLinesItem)
Payslip	addEarningsLinesItem(EarningsLine earningsLinesItem)
Payslip	addEmployeeTaxLinesItem(TaxLine employeeTaxLinesItem)
Payslip	addLeaveAccrualLinesItem(LeaveAccrualLine leaveAccrualLinesItem)
Payslip	addLeaveEarningsLinesItem(LeaveEarningsLine leaveEarningsLinesItem)
Payslip	addPaymentLinesItem(PaymentLine paymentLinesItem)
Payslip	addReimbursementLinesItem(ReimbursementLine reimbursementLinesItem)
Payslip	addTimesheetEarningsLinesItem(TimesheetEarningsLine timesheetEarningsLinesItem)
Payslip	bacsHash(String bacsHash)
Payslip	benefitLines(List<BenefitLine> benefitLines)
Payslip	courtOrderLines(List<CourtOrderLine> courtOrderLines)
Payslip	deductionLines(List<DeductionLine> deductionLines)
Payslip	earningsLines(List<EarningsLine> earningsLines)
Payslip	employeeID(UUID employeeID)
Payslip	employeeTaxLines(List<TaxLine> employeeTaxLines)
boolean	equals(Object o)
Payslip	firstName(String firstName)
String	getBacsHash() BACS Service User Number
List<BenefitLine>	getBenefitLines() Get benefitLines
List<CourtOrderLine>	getCourtOrderLines() Get courtOrderLines
List<DeductionLine>	getDeductionLines() Get deductionLines
List<EarningsLine>	getEarningsLines() Get earningsLines
UUID	getEmployeeID() The Xero identifier for payroll employee
List<TaxLine>	getEmployeeTaxLines() Get employeeTaxLines
String	getFirstName() Employee first name
Double	getGrossEarnings() Total earnings before any deductions.
org.threeten.bp.LocalDateTime	getLastEdited() The date payslip was last updated
String	getLastName() Employee last name
List<LeaveAccrualLine>	getLeaveAccrualLines() Get leaveAccrualLines
List<LeaveEarningsLine>	getLeaveEarningsLines() Get leaveEarningsLines
List<PaymentLine>	getPaymentLines() Get paymentLines
Payslip.PaymentMethodEnum	getPaymentMethod() The payment method code
UUID	getPayRunID() The Xero identifier for the associated payrun
UUID	getPaySlipID() The Xero identifier for a Payslip
List<ReimbursementLine>	getReimbursementLines() Get reimbursementLines
List<TimesheetEarningsLine>	getTimesheetEarningsLines() Get timesheetEarningsLines
Double	getTotalBenefits() Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries
Double	getTotalCourtOrders() Total amounts required by law to subtract from the employee's earnings
Double	getTotalDeductions() Total amount subtracted from an employee's earnings to reach total pay
Double	getTotalEarnings() Total earnings before any deductions.
Double	getTotalEmployeeTaxes() The part of an employee's earnings that is deducted for tax purposes
Double	getTotalEmployerTaxes() The employer's tax obligation
Double	getTotalPay() The employee net pay
Double	getTotalReimbursements() Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment
Payslip	grossEarnings(Double grossEarnings)
int	hashCode()
Payslip	lastEdited(org.threeten.bp.LocalDateTime lastEdited)
Payslip	lastName(String lastName)
Payslip	leaveAccrualLines(List<LeaveAccrualLine> leaveAccrualLines)
Payslip	leaveEarningsLines(List<LeaveEarningsLine> leaveEarningsLines)
Payslip	paymentLines(List<PaymentLine> paymentLines)
Payslip	paymentMethod(Payslip.PaymentMethodEnum paymentMethod)
Payslip	payRunID(UUID payRunID)
Payslip	paySlipID(UUID paySlipID)
Payslip	reimbursementLines(List<ReimbursementLine> reimbursementLines)
void	setBacsHash(String bacsHash)
void	setBenefitLines(List<BenefitLine> benefitLines)
void	setCourtOrderLines(List<CourtOrderLine> courtOrderLines)
void	setDeductionLines(List<DeductionLine> deductionLines)
void	setEarningsLines(List<EarningsLine> earningsLines)
void	setEmployeeID(UUID employeeID)
void	setEmployeeTaxLines(List<TaxLine> employeeTaxLines)
void	setFirstName(String firstName)
void	setGrossEarnings(Double grossEarnings)
void	setLastEdited(org.threeten.bp.LocalDateTime lastEdited)
void	setLastName(String lastName)
void	setLeaveAccrualLines(List<LeaveAccrualLine> leaveAccrualLines)
void	setLeaveEarningsLines(List<LeaveEarningsLine> leaveEarningsLines)
void	setPaymentLines(List<PaymentLine> paymentLines)
void	setPaymentMethod(Payslip.PaymentMethodEnum paymentMethod)
void	setPayRunID(UUID payRunID)
void	setPaySlipID(UUID paySlipID)
void	setReimbursementLines(List<ReimbursementLine> reimbursementLines)
void	setTimesheetEarningsLines(List<TimesheetEarningsLine> timesheetEarningsLines)
void	setTotalBenefits(Double totalBenefits)
void	setTotalCourtOrders(Double totalCourtOrders)
void	setTotalDeductions(Double totalDeductions)
void	setTotalEarnings(Double totalEarnings)
void	setTotalEmployeeTaxes(Double totalEmployeeTaxes)
void	setTotalEmployerTaxes(Double totalEmployerTaxes)
void	setTotalPay(Double totalPay)
void	setTotalReimbursements(Double totalReimbursements)
Payslip	timesheetEarningsLines(List<TimesheetEarningsLine> timesheetEarningsLines)
String	toString()
Payslip	totalBenefits(Double totalBenefits)
Payslip	totalCourtOrders(Double totalCourtOrders)
Payslip	totalDeductions(Double totalDeductions)
Payslip	totalEarnings(Double totalEarnings)
Payslip	totalEmployeeTaxes(Double totalEmployeeTaxes)
Payslip	totalEmployerTaxes(Double totalEmployerTaxes)
Payslip	totalPay(Double totalPay)
Payslip	totalReimbursements(Double totalReimbursements)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Payslip

public Payslip()

Method Detail

paySlipID

public Payslip paySlipID(UUID paySlipID)

getPaySlipID

public UUID getPaySlipID()

The Xero identifier for a Payslip

Returns:

paySlipID

setPaySlipID

public void setPaySlipID(UUID paySlipID)

employeeID

public Payslip employeeID(UUID employeeID)

getEmployeeID

public UUID getEmployeeID()

The Xero identifier for payroll employee

Returns:

employeeID

setEmployeeID

public void setEmployeeID(UUID employeeID)

payRunID

public Payslip payRunID(UUID payRunID)

getPayRunID

public UUID getPayRunID()

The Xero identifier for the associated payrun

Returns:

payRunID

setPayRunID

public void setPayRunID(UUID payRunID)

lastEdited

public Payslip lastEdited(org.threeten.bp.LocalDateTime lastEdited)

getLastEdited

public org.threeten.bp.LocalDateTime getLastEdited()

The date payslip was last updated

Returns:

lastEdited

setLastEdited

public void setLastEdited(org.threeten.bp.LocalDateTime lastEdited)

firstName

public Payslip firstName(String firstName)

getFirstName

public String getFirstName()

Employee first name

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

lastName

public Payslip lastName(String lastName)

getLastName

public String getLastName()

Employee last name

Returns:

lastName

setLastName

public void setLastName(String lastName)

totalEarnings

public Payslip totalEarnings(Double totalEarnings)

getTotalEarnings

public Double getTotalEarnings()

Total earnings before any deductions. Same as gross earnings for UK.

Returns:

totalEarnings

setTotalEarnings

public void setTotalEarnings(Double totalEarnings)

grossEarnings

public Payslip grossEarnings(Double grossEarnings)

getGrossEarnings

public Double getGrossEarnings()

Total earnings before any deductions. Same as total earnings for UK.

Returns:

grossEarnings

setGrossEarnings

public void setGrossEarnings(Double grossEarnings)

totalPay

public Payslip totalPay(Double totalPay)

getTotalPay

public Double getTotalPay()

The employee net pay

Returns:

totalPay

setTotalPay

public void setTotalPay(Double totalPay)

totalEmployerTaxes

public Payslip totalEmployerTaxes(Double totalEmployerTaxes)

getTotalEmployerTaxes

public Double getTotalEmployerTaxes()

The employer's tax obligation

Returns:

totalEmployerTaxes

setTotalEmployerTaxes

public void setTotalEmployerTaxes(Double totalEmployerTaxes)

totalEmployeeTaxes

public Payslip totalEmployeeTaxes(Double totalEmployeeTaxes)

getTotalEmployeeTaxes

public Double getTotalEmployeeTaxes()

The part of an employee's earnings that is deducted for tax purposes

Returns:

totalEmployeeTaxes

setTotalEmployeeTaxes

public void setTotalEmployeeTaxes(Double totalEmployeeTaxes)

totalDeductions

public Payslip totalDeductions(Double totalDeductions)

getTotalDeductions

public Double getTotalDeductions()

Total amount subtracted from an employee's earnings to reach total pay

Returns:

totalDeductions

setTotalDeductions

public void setTotalDeductions(Double totalDeductions)

totalReimbursements

public Payslip totalReimbursements(Double totalReimbursements)

getTotalReimbursements

public Double getTotalReimbursements()

Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment

Returns:

totalReimbursements

setTotalReimbursements

public void setTotalReimbursements(Double totalReimbursements)

totalCourtOrders

public Payslip totalCourtOrders(Double totalCourtOrders)

getTotalCourtOrders

public Double getTotalCourtOrders()

Total amounts required by law to subtract from the employee's earnings

Returns:

totalCourtOrders

setTotalCourtOrders

public void setTotalCourtOrders(Double totalCourtOrders)

totalBenefits

public Payslip totalBenefits(Double totalBenefits)

getTotalBenefits

public Double getTotalBenefits()

Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries

Returns:

totalBenefits

setTotalBenefits

public void setTotalBenefits(Double totalBenefits)

bacsHash

public Payslip bacsHash(String bacsHash)

getBacsHash

public String getBacsHash()

BACS Service User Number

Returns:

bacsHash

setBacsHash

public void setBacsHash(String bacsHash)

paymentMethod

public Payslip paymentMethod(Payslip.PaymentMethodEnum paymentMethod)

getPaymentMethod

public Payslip.PaymentMethodEnum getPaymentMethod()

The payment method code

Returns:

paymentMethod

setPaymentMethod

public void setPaymentMethod(Payslip.PaymentMethodEnum paymentMethod)

earningsLines

public Payslip earningsLines(List<EarningsLine> earningsLines)

addEarningsLinesItem

public Payslip addEarningsLinesItem(EarningsLine earningsLinesItem)

getEarningsLines

public List<EarningsLine> getEarningsLines()

Get earningsLines

Returns:

earningsLines

setEarningsLines

public void setEarningsLines(List<EarningsLine> earningsLines)

leaveEarningsLines

public Payslip leaveEarningsLines(List<LeaveEarningsLine> leaveEarningsLines)

addLeaveEarningsLinesItem

public Payslip addLeaveEarningsLinesItem(LeaveEarningsLine leaveEarningsLinesItem)

getLeaveEarningsLines

public List<LeaveEarningsLine> getLeaveEarningsLines()

Get leaveEarningsLines

Returns:

leaveEarningsLines

setLeaveEarningsLines

public void setLeaveEarningsLines(List<LeaveEarningsLine> leaveEarningsLines)

timesheetEarningsLines

public Payslip timesheetEarningsLines(List<TimesheetEarningsLine> timesheetEarningsLines)

addTimesheetEarningsLinesItem

public Payslip addTimesheetEarningsLinesItem(TimesheetEarningsLine timesheetEarningsLinesItem)

getTimesheetEarningsLines

public List<TimesheetEarningsLine> getTimesheetEarningsLines()

Get timesheetEarningsLines

Returns:

timesheetEarningsLines

setTimesheetEarningsLines

public void setTimesheetEarningsLines(List<TimesheetEarningsLine> timesheetEarningsLines)

deductionLines

public Payslip deductionLines(List<DeductionLine> deductionLines)

addDeductionLinesItem

public Payslip addDeductionLinesItem(DeductionLine deductionLinesItem)

getDeductionLines

public List<DeductionLine> getDeductionLines()

Get deductionLines

Returns:

deductionLines

setDeductionLines

public void setDeductionLines(List<DeductionLine> deductionLines)

reimbursementLines

public Payslip reimbursementLines(List<ReimbursementLine> reimbursementLines)

addReimbursementLinesItem

public Payslip addReimbursementLinesItem(ReimbursementLine reimbursementLinesItem)

getReimbursementLines

public List<ReimbursementLine> getReimbursementLines()

Get reimbursementLines

Returns:

reimbursementLines

setReimbursementLines

public void setReimbursementLines(List<ReimbursementLine> reimbursementLines)

leaveAccrualLines

public Payslip leaveAccrualLines(List<LeaveAccrualLine> leaveAccrualLines)

addLeaveAccrualLinesItem

public Payslip addLeaveAccrualLinesItem(LeaveAccrualLine leaveAccrualLinesItem)

getLeaveAccrualLines

public List<LeaveAccrualLine> getLeaveAccrualLines()

Get leaveAccrualLines

Returns:

leaveAccrualLines

setLeaveAccrualLines

public void setLeaveAccrualLines(List<LeaveAccrualLine> leaveAccrualLines)

benefitLines

public Payslip benefitLines(List<BenefitLine> benefitLines)

addBenefitLinesItem

public Payslip addBenefitLinesItem(BenefitLine benefitLinesItem)

getBenefitLines

public List<BenefitLine> getBenefitLines()

Get benefitLines

Returns:

benefitLines

setBenefitLines

public void setBenefitLines(List<BenefitLine> benefitLines)

paymentLines

public Payslip paymentLines(List<PaymentLine> paymentLines)

addPaymentLinesItem

public Payslip addPaymentLinesItem(PaymentLine paymentLinesItem)

getPaymentLines

public List<PaymentLine> getPaymentLines()

Get paymentLines

Returns:

paymentLines

setPaymentLines

public void setPaymentLines(List<PaymentLine> paymentLines)

employeeTaxLines

public Payslip employeeTaxLines(List<TaxLine> employeeTaxLines)

addEmployeeTaxLinesItem

public Payslip addEmployeeTaxLinesItem(TaxLine employeeTaxLinesItem)

getEmployeeTaxLines

public List<TaxLine> getEmployeeTaxLines()

Get employeeTaxLines

Returns:

employeeTaxLines

setEmployeeTaxLines

public void setEmployeeTaxLines(List<TaxLine> employeeTaxLines)

courtOrderLines

public Payslip courtOrderLines(List<CourtOrderLine> courtOrderLines)

addCourtOrderLinesItem

public Payslip addCourtOrderLinesItem(CourtOrderLine courtOrderLinesItem)

getCourtOrderLines

public List<CourtOrderLine> getCourtOrderLines()

Get courtOrderLines

Returns:

courtOrderLines

setCourtOrderLines

public void setCourtOrderLines(List<CourtOrderLine> courtOrderLines)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object