Package com.xero.models.payrolluk

Class Payslip

java.lang.Object
com.xero.models.payrolluk.Payslip
public class Payslip
extends Object
Payslip

  • Constructor Details

    • Payslip

      public Payslip()

  • Method Details

    • 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