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 NZ.
        Parameters:
        totalEarnings - Double
        Returns:
        PaySlip
      • getTotalEarnings

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

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

        public PaySlip grossEarnings​(Double grossEarnings)
        Total earnings before any deductions. Same as total earnings for NZ.
        Parameters:
        grossEarnings - Double
        Returns:
        PaySlip
      • getGrossEarnings

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

        public void setGrossEarnings​(Double grossEarnings)
        Total earnings before any deductions. Same as total earnings for NZ.
        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
      • totalStatutoryDeductions

        public PaySlip totalStatutoryDeductions​(Double totalStatutoryDeductions)
        Total amounts required by law to subtract from the employee's earnings
        Parameters:
        totalStatutoryDeductions - Double
        Returns:
        PaySlip
      • getTotalStatutoryDeductions

        public Double getTotalStatutoryDeductions()
        Total amounts required by law to subtract from the employee's earnings
        Returns:
        totalStatutoryDeductions
      • setTotalStatutoryDeductions

        public void setTotalStatutoryDeductions​(Double totalStatutoryDeductions)
        Total amounts required by law to subtract from the employee's earnings
        Parameters:
        totalStatutoryDeductions - Double
      • totalSuperannuation

        public PaySlip totalSuperannuation​(Double totalSuperannuation)
        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:
        totalSuperannuation - Double
        Returns:
        PaySlip
      • getTotalSuperannuation

        public Double getTotalSuperannuation()
        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:
        totalSuperannuation
      • setTotalSuperannuation

        public void setTotalSuperannuation​(Double totalSuperannuation)
        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:
        totalSuperannuation - 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>
      • superannuationLines

        public PaySlip superannuationLines​(List<SuperannuationLine> superannuationLines)
        superannuationLines
        Parameters:
        superannuationLines - List<SuperannuationLine>
        Returns:
        PaySlip
      • addSuperannuationLinesItem

        public PaySlip addSuperannuationLinesItem​(SuperannuationLine superannuationLinesItem)
        superannuationLines
        Parameters:
        superannuationLinesItem - SuperannuationLine
        Returns:
        PaySlip
      • getSuperannuationLines

        public List<SuperannuationLine> getSuperannuationLines()
        Get superannuationLines
        Returns:
        superannuationLines
      • setSuperannuationLines

        public void setSuperannuationLines​(List<SuperannuationLine> superannuationLines)
        superannuationLines
        Parameters:
        superannuationLines - List<SuperannuationLine>
      • 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>
      • statutoryDeductionLines

        public PaySlip statutoryDeductionLines​(List<StatutoryDeductionLine> statutoryDeductionLines)
        statutoryDeductionLines
        Parameters:
        statutoryDeductionLines - List<StatutoryDeductionLine>
        Returns:
        PaySlip
      • addStatutoryDeductionLinesItem

        public PaySlip addStatutoryDeductionLinesItem​(StatutoryDeductionLine statutoryDeductionLinesItem)
        statutoryDeductionLines
        Parameters:
        statutoryDeductionLinesItem - StatutoryDeductionLine
        Returns:
        PaySlip
      • getStatutoryDeductionLines

        public List<StatutoryDeductionLine> getStatutoryDeductionLines()
        Get statutoryDeductionLines
        Returns:
        statutoryDeductionLines
      • setStatutoryDeductionLines

        public void setStatutoryDeductionLines​(List<StatutoryDeductionLine> statutoryDeductionLines)
        statutoryDeductionLines
        Parameters:
        statutoryDeductionLines - List<StatutoryDeductionLine>
      • taxSettings

        public PaySlip taxSettings​(TaxSettings taxSettings)
        taxSettings
        Parameters:
        taxSettings - TaxSettings
        Returns:
        PaySlip
      • getTaxSettings

        public TaxSettings getTaxSettings()
        Get taxSettings
        Returns:
        taxSettings
      • setTaxSettings

        public void setTaxSettings​(TaxSettings taxSettings)
        taxSettings
        Parameters:
        taxSettings - TaxSettings
      • grossEarningsHistory

        public PaySlip grossEarningsHistory​(GrossEarningsHistory grossEarningsHistory)
        grossEarningsHistory
        Parameters:
        grossEarningsHistory - GrossEarningsHistory
        Returns:
        PaySlip
      • getGrossEarningsHistory

        public GrossEarningsHistory getGrossEarningsHistory()
        Get grossEarningsHistory
        Returns:
        grossEarningsHistory
      • setGrossEarningsHistory

        public void setGrossEarningsHistory​(GrossEarningsHistory grossEarningsHistory)
        grossEarningsHistory
        Parameters:
        grossEarningsHistory - GrossEarningsHistory
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object