Package com.xero.models.payrolluk

Class Payslip

  • public class Payslip
extends Object
    Payslip

    • Constructor Detail

      • Payslip

        public Payslip()

    • Method Detail

      • paySlipID

        public Payslip paySlipID​(UUID paySlipID)
        The Xero identifier for a Payslip
        Parameters:
        paySlipID - UUID
        Returns:
        Payslip

      • getPaySlipID

        public UUID getPaySlipID()
        The Xero identifier for a Payslip
        Returns:
        paySlipID

      • setPaySlipID

        public void setPaySlipID​(UUID paySlipID)
        The Xero identifier for a Payslip
        Parameters:
        paySlipID - UUID

      • employeeID

        public Payslip employeeID​(UUID employeeID)
        The Xero identifier for payroll employee
        Parameters:
        employeeID - UUID
        Returns:
        Payslip

      • getEmployeeID

        public UUID getEmployeeID()
        The Xero identifier for payroll employee
        Returns:
        employeeID

      • setEmployeeID

        public void setEmployeeID​(UUID employeeID)
        The Xero identifier for payroll employee
        Parameters:
        employeeID - UUID

      • payRunID

        public Payslip payRunID​(UUID payRunID)
        The Xero identifier for the associated payrun
        Parameters:
        payRunID - UUID
        Returns:
        Payslip

      • getPayRunID

        public UUID getPayRunID()
        The Xero identifier for the associated payrun
        Returns:
        payRunID

      • setPayRunID

        public void setPayRunID​(UUID payRunID)
        The Xero identifier for the associated payrun
        Parameters:
        payRunID - UUID

      • lastEdited

        public Payslip lastEdited​(org.threeten.bp.LocalDateTime lastEdited)
        The date payslip was last updated
        Parameters:
        lastEdited - LocalDateTime
        Returns:
        Payslip

      • getLastEdited

        public org.threeten.bp.LocalDateTime getLastEdited()
        The date payslip was last updated
        Returns:
        lastEdited

      • setLastEdited

        public void setLastEdited​(org.threeten.bp.LocalDateTime lastEdited)
        The date payslip was last updated
        Parameters:
        lastEdited - LocalDateTime

      • firstName

        public Payslip firstName​(String firstName)
        Employee first name
        Parameters:
        firstName - String
        Returns:
        Payslip

      • getFirstName

        public String getFirstName()
        Employee first name
        Returns:
        firstName

      • setFirstName

        public void setFirstName​(String firstName)
        Employee first name
        Parameters:
        firstName - String

      • lastName

        public Payslip lastName​(String lastName)
        Employee last name
        Parameters:
        lastName - String
        Returns:
        Payslip

      • getLastName

        public String getLastName()
        Employee last name
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)
        Employee last name
        Parameters:
        lastName - String

      • totalEarnings

        public Payslip totalEarnings​(Double totalEarnings)
        Total earnings before any deductions. Same as gross earnings for UK.
        Parameters:
        totalEarnings - Double
        Returns:
        Payslip

      • getTotalEarnings

        public Double getTotalEarnings()
        Total earnings before any deductions. Same as gross earnings for UK.
        Returns:
        totalEarnings

      • setTotalEarnings

        public void setTotalEarnings​(Double totalEarnings)
        Total earnings before any deductions. Same as gross earnings for UK.
        Parameters:
        totalEarnings - Double

      • grossEarnings

        public Payslip grossEarnings​(Double grossEarnings)
        Total earnings before any deductions. Same as total earnings for UK.
        Parameters:
        grossEarnings - Double
        Returns:
        Payslip

      • getGrossEarnings

        public Double getGrossEarnings()
        Total earnings before any deductions. Same as total earnings for UK.
        Returns:
        grossEarnings

      • setGrossEarnings

        public void setGrossEarnings​(Double grossEarnings)
        Total earnings before any deductions. Same as total earnings for UK.
        Parameters:
        grossEarnings - Double

      • totalPay

        public Payslip totalPay​(Double totalPay)
        The employee net pay
        Parameters:
        totalPay - Double
        Returns:
        Payslip

      • getTotalPay

        public Double getTotalPay()
        The employee net pay
        Returns:
        totalPay

      • setTotalPay

        public void setTotalPay​(Double totalPay)
        The employee net pay
        Parameters:
        totalPay - Double

      • totalEmployerTaxes

        public Payslip totalEmployerTaxes​(Double totalEmployerTaxes)
        The employer's tax obligation
        Parameters:
        totalEmployerTaxes - Double
        Returns:
        Payslip

      • getTotalEmployerTaxes

        public Double getTotalEmployerTaxes()
        The employer's tax obligation
        Returns:
        totalEmployerTaxes

      • setTotalEmployerTaxes

        public void setTotalEmployerTaxes​(Double totalEmployerTaxes)
        The employer's tax obligation
        Parameters:
        totalEmployerTaxes - Double

      • totalEmployeeTaxes

        public Payslip totalEmployeeTaxes​(Double totalEmployeeTaxes)
        The part of an employee's earnings that is deducted for tax purposes
        Parameters:
        totalEmployeeTaxes - Double
        Returns:
        Payslip

      • 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)
        The part of an employee's earnings that is deducted for tax purposes
        Parameters:
        totalEmployeeTaxes - Double

      • totalDeductions

        public Payslip totalDeductions​(Double totalDeductions)
        Total amount subtracted from an employee's earnings to reach total pay
        Parameters:
        totalDeductions - Double
        Returns:
        Payslip

      • getTotalDeductions

        public Double getTotalDeductions()
        Total amount subtracted from an employee's earnings to reach total pay
        Returns:
        totalDeductions

      • setTotalDeductions

        public void setTotalDeductions​(Double totalDeductions)
        Total amount subtracted from an employee's earnings to reach total pay
        Parameters:
        totalDeductions - Double

      • totalReimbursements

        public Payslip totalReimbursements​(Double totalReimbursements)
        Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment
        Parameters:
        totalReimbursements - Double
        Returns:
        Payslip

      • 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)
        Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment
        Parameters:
        totalReimbursements - Double

      • totalCourtOrders

        public Payslip totalCourtOrders​(Double totalCourtOrders)
        Total amounts required by law to subtract from the employee's earnings
        Parameters:
        totalCourtOrders - Double
        Returns:
        Payslip

      • getTotalCourtOrders

        public Double getTotalCourtOrders()
        Total amounts required by law to subtract from the employee's earnings
        Returns:
        totalCourtOrders

      • setTotalCourtOrders

        public void setTotalCourtOrders​(Double totalCourtOrders)
        Total amounts required by law to subtract from the employee's earnings
        Parameters:
        totalCourtOrders - Double

      • totalBenefits

        public Payslip totalBenefits​(Double totalBenefits)
        Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries
        Parameters:
        totalBenefits - Double
        Returns:
        Payslip

      • 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)
        Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries
        Parameters:
        totalBenefits - Double

      • bacsHash

        public Payslip bacsHash​(String bacsHash)
        BACS Service User Number
        Parameters:
        bacsHash - String
        Returns:
        Payslip

      • getBacsHash

        public String getBacsHash()
        BACS Service User Number
        Returns:
        bacsHash

      • setBacsHash

        public void setBacsHash​(String bacsHash)
        BACS Service User Number
        Parameters:
        bacsHash - String

      • paymentMethod

        public Payslip paymentMethod​(Payslip.PaymentMethodEnum paymentMethod)
        The payment method code
        Parameters:
        paymentMethod - PaymentMethodEnum
        Returns:
        Payslip

      • setPaymentMethod

        public void setPaymentMethod​(Payslip.PaymentMethodEnum paymentMethod)
        The payment method code
        Parameters:
        paymentMethod - PaymentMethodEnum

      • earningsLines

        public Payslip earningsLines​(List<EarningsLine> earningsLines)
        earningsLines
        Parameters:
        earningsLines - List<EarningsLine>
        Returns:
        Payslip

      • addEarningsLinesItem

        public Payslip addEarningsLinesItem​(EarningsLine earningsLinesItem)
        earningsLines
        Parameters:
        earningsLinesItem - EarningsLine
        Returns:
        Payslip

      • getEarningsLines

        public List<EarningsLine> getEarningsLines()
        Get earningsLines
        Returns:
        earningsLines

      • setEarningsLines

        public void setEarningsLines​(List<EarningsLine> earningsLines)
        earningsLines
        Parameters:
        earningsLines - List<EarningsLine>

      • leaveEarningsLines

        public Payslip leaveEarningsLines​(List<LeaveEarningsLine> leaveEarningsLines)
        leaveEarningsLines
        Parameters:
        leaveEarningsLines - List<LeaveEarningsLine>
        Returns:
        Payslip

      • addLeaveEarningsLinesItem

        public Payslip addLeaveEarningsLinesItem​(LeaveEarningsLine leaveEarningsLinesItem)
        leaveEarningsLines
        Parameters:
        leaveEarningsLinesItem - LeaveEarningsLine
        Returns:
        Payslip

      • getLeaveEarningsLines

        public List<LeaveEarningsLine> getLeaveEarningsLines()
        Get leaveEarningsLines
        Returns:
        leaveEarningsLines

      • setLeaveEarningsLines

        public void setLeaveEarningsLines​(List<LeaveEarningsLine> leaveEarningsLines)
        leaveEarningsLines
        Parameters:
        leaveEarningsLines - List<LeaveEarningsLine>

      • timesheetEarningsLines

        public Payslip timesheetEarningsLines​(List<TimesheetEarningsLine> timesheetEarningsLines)
        timesheetEarningsLines
        Parameters:
        timesheetEarningsLines - List<TimesheetEarningsLine>
        Returns:
        Payslip

      • addTimesheetEarningsLinesItem

        public Payslip addTimesheetEarningsLinesItem​(TimesheetEarningsLine timesheetEarningsLinesItem)
        timesheetEarningsLines
        Parameters:
        timesheetEarningsLinesItem - TimesheetEarningsLine
        Returns:
        Payslip

      • getTimesheetEarningsLines

        public List<TimesheetEarningsLine> getTimesheetEarningsLines()
        Get timesheetEarningsLines
        Returns:
        timesheetEarningsLines

      • setTimesheetEarningsLines

        public void setTimesheetEarningsLines​(List<TimesheetEarningsLine> timesheetEarningsLines)
        timesheetEarningsLines
        Parameters:
        timesheetEarningsLines - List<TimesheetEarningsLine>

      • deductionLines

        public Payslip deductionLines​(List<DeductionLine> deductionLines)
        deductionLines
        Parameters:
        deductionLines - List<DeductionLine>
        Returns:
        Payslip

      • addDeductionLinesItem

        public Payslip addDeductionLinesItem​(DeductionLine deductionLinesItem)
        deductionLines
        Parameters:
        deductionLinesItem - DeductionLine
        Returns:
        Payslip

      • getDeductionLines

        public List<DeductionLine> getDeductionLines()
        Get deductionLines
        Returns:
        deductionLines

      • setDeductionLines

        public void setDeductionLines​(List<DeductionLine> deductionLines)
        deductionLines
        Parameters:
        deductionLines - List<DeductionLine>

      • reimbursementLines

        public Payslip reimbursementLines​(List<ReimbursementLine> reimbursementLines)
        reimbursementLines
        Parameters:
        reimbursementLines - List<ReimbursementLine>
        Returns:
        Payslip

      • addReimbursementLinesItem

        public Payslip addReimbursementLinesItem​(ReimbursementLine reimbursementLinesItem)
        reimbursementLines
        Parameters:
        reimbursementLinesItem - ReimbursementLine
        Returns:
        Payslip

      • getReimbursementLines

        public List<ReimbursementLine> getReimbursementLines()
        Get reimbursementLines
        Returns:
        reimbursementLines

      • setReimbursementLines

        public void setReimbursementLines​(List<ReimbursementLine> reimbursementLines)
        reimbursementLines
        Parameters:
        reimbursementLines - List<ReimbursementLine>

      • leaveAccrualLines

        public Payslip leaveAccrualLines​(List<LeaveAccrualLine> leaveAccrualLines)
        leaveAccrualLines
        Parameters:
        leaveAccrualLines - List<LeaveAccrualLine>
        Returns:
        Payslip

      • addLeaveAccrualLinesItem

        public Payslip addLeaveAccrualLinesItem​(LeaveAccrualLine leaveAccrualLinesItem)
        leaveAccrualLines
        Parameters:
        leaveAccrualLinesItem - LeaveAccrualLine
        Returns:
        Payslip

      • getLeaveAccrualLines

        public List<LeaveAccrualLine> getLeaveAccrualLines()
        Get leaveAccrualLines
        Returns:
        leaveAccrualLines

      • setLeaveAccrualLines

        public void setLeaveAccrualLines​(List<LeaveAccrualLine> leaveAccrualLines)
        leaveAccrualLines
        Parameters:
        leaveAccrualLines - List<LeaveAccrualLine>

      • benefitLines

        public Payslip benefitLines​(List<BenefitLine> benefitLines)
        benefitLines
        Parameters:
        benefitLines - List<BenefitLine>
        Returns:
        Payslip

      • addBenefitLinesItem

        public Payslip addBenefitLinesItem​(BenefitLine benefitLinesItem)
        benefitLines
        Parameters:
        benefitLinesItem - BenefitLine
        Returns:
        Payslip

      • getBenefitLines

        public List<BenefitLine> getBenefitLines()
        Get benefitLines
        Returns:
        benefitLines

      • setBenefitLines

        public void setBenefitLines​(List<BenefitLine> benefitLines)
        benefitLines
        Parameters:
        benefitLines - List<BenefitLine>

      • paymentLines

        public Payslip paymentLines​(List<PaymentLine> paymentLines)
        paymentLines
        Parameters:
        paymentLines - List<PaymentLine>
        Returns:
        Payslip

      • addPaymentLinesItem

        public Payslip addPaymentLinesItem​(PaymentLine paymentLinesItem)
        paymentLines
        Parameters:
        paymentLinesItem - PaymentLine
        Returns:
        Payslip

      • getPaymentLines

        public List<PaymentLine> getPaymentLines()
        Get paymentLines
        Returns:
        paymentLines

      • setPaymentLines

        public void setPaymentLines​(List<PaymentLine> paymentLines)
        paymentLines
        Parameters:
        paymentLines - List<PaymentLine>

      • employeeTaxLines

        public Payslip employeeTaxLines​(List<TaxLine> employeeTaxLines)
        employeeTaxLines
        Parameters:
        employeeTaxLines - List<TaxLine>
        Returns:
        Payslip

      • addEmployeeTaxLinesItem

        public Payslip addEmployeeTaxLinesItem​(TaxLine employeeTaxLinesItem)
        employeeTaxLines
        Parameters:
        employeeTaxLinesItem - TaxLine
        Returns:
        Payslip

      • getEmployeeTaxLines

        public List<TaxLine> getEmployeeTaxLines()
        Get employeeTaxLines
        Returns:
        employeeTaxLines

      • setEmployeeTaxLines

        public void setEmployeeTaxLines​(List<TaxLine> employeeTaxLines)
        employeeTaxLines
        Parameters:
        employeeTaxLines - List<TaxLine>

      • employerTaxLines

        public Payslip employerTaxLines​(List<TaxLine> employerTaxLines)
        employerTaxLines
        Parameters:
        employerTaxLines - List<TaxLine>
        Returns:
        Payslip

      • addEmployerTaxLinesItem

        public Payslip addEmployerTaxLinesItem​(TaxLine employerTaxLinesItem)
        employerTaxLines
        Parameters:
        employerTaxLinesItem - TaxLine
        Returns:
        Payslip

      • getEmployerTaxLines

        public List<TaxLine> getEmployerTaxLines()
        Get employerTaxLines
        Returns:
        employerTaxLines

      • setEmployerTaxLines

        public void setEmployerTaxLines​(List<TaxLine> employerTaxLines)
        employerTaxLines
        Parameters:
        employerTaxLines - List<TaxLine>

      • courtOrderLines

        public Payslip courtOrderLines​(List<CourtOrderLine> courtOrderLines)
        courtOrderLines
        Parameters:
        courtOrderLines - List<CourtOrderLine>
        Returns:
        Payslip

      • addCourtOrderLinesItem

        public Payslip addCourtOrderLinesItem​(CourtOrderLine courtOrderLinesItem)
        courtOrderLines
        Parameters:
        courtOrderLinesItem - CourtOrderLine
        Returns:
        Payslip

      • getCourtOrderLines

        public List<CourtOrderLine> getCourtOrderLines()
        Get courtOrderLines
        Returns:
        courtOrderLines

      • setCourtOrderLines

        public void setCourtOrderLines​(List<CourtOrderLine> courtOrderLines)
        courtOrderLines
        Parameters:
        courtOrderLines - List<CourtOrderLine>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object