Package com.xero.models.payrollau

Class PayRun

java.lang.Object
com.xero.models.payrollau.PayRun
public class PayRun
extends Object
PayRun

  • Constructor Details

    • PayRun

      public PayRun()

  • Method Details

    • payrollCalendarID

      public PayRun payrollCalendarID​(UUID payrollCalendarID)

    • getPayrollCalendarID

      public UUID getPayrollCalendarID()
      Xero identifier for pay run
      Returns:
      payrollCalendarID

    • setPayrollCalendarID

      public void setPayrollCalendarID​(UUID payrollCalendarID)

    • payRunID

      public PayRun payRunID​(UUID payRunID)

    • getPayRunID

      public UUID getPayRunID()
      Xero identifier for pay run
      Returns:
      payRunID

    • setPayRunID

      public void setPayRunID​(UUID payRunID)

    • payRunPeriodStartDate

      public PayRun payRunPeriodStartDate​(String payRunPeriodStartDate)

    • getPayRunPeriodStartDate

      public String getPayRunPeriodStartDate()
      Period Start Date for the PayRun (YYYY-MM-DD)
      Returns:
      payRunPeriodStartDate

    • getPayRunPeriodStartDateAsDate

      public org.threeten.bp.LocalDate getPayRunPeriodStartDateAsDate()

    • setPayRunPeriodStartDate

      public void setPayRunPeriodStartDate​(String payRunPeriodStartDate)

    • setPayRunPeriodStartDate

      public void setPayRunPeriodStartDate​(org.threeten.bp.LocalDate payRunPeriodStartDate)

    • payRunPeriodEndDate

      public PayRun payRunPeriodEndDate​(String payRunPeriodEndDate)

    • getPayRunPeriodEndDate

      public String getPayRunPeriodEndDate()
      Period End Date for the PayRun (YYYY-MM-DD)
      Returns:
      payRunPeriodEndDate

    • getPayRunPeriodEndDateAsDate

      public org.threeten.bp.LocalDate getPayRunPeriodEndDateAsDate()

    • setPayRunPeriodEndDate

      public void setPayRunPeriodEndDate​(String payRunPeriodEndDate)

    • setPayRunPeriodEndDate

      public void setPayRunPeriodEndDate​(org.threeten.bp.LocalDate payRunPeriodEndDate)

    • payRunStatus

      public PayRun payRunStatus​(PayRunStatus payRunStatus)

    • getPayRunStatus

      public PayRunStatus getPayRunStatus()
      Get payRunStatus
      Returns:
      payRunStatus

    • setPayRunStatus

      public void setPayRunStatus​(PayRunStatus payRunStatus)

    • paymentDate

      public PayRun paymentDate​(String paymentDate)

    • getPaymentDate

      public String getPaymentDate()
      Payment Date for the PayRun (YYYY-MM-DD)
      Returns:
      paymentDate

    • getPaymentDateAsDate

      public org.threeten.bp.LocalDate getPaymentDateAsDate()

    • setPaymentDate

      public void setPaymentDate​(String paymentDate)

    • setPaymentDate

      public void setPaymentDate​(org.threeten.bp.LocalDate paymentDate)

    • payslipMessage

      public PayRun payslipMessage​(String payslipMessage)

    • getPayslipMessage

      public String getPayslipMessage()
      Payslip message for the PayRun
      Returns:
      payslipMessage

    • setPayslipMessage

      public void setPayslipMessage​(String payslipMessage)

    • getUpdatedDateUTC

      public String getUpdatedDateUTC()
      Last modified timestamp
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • payslips

      public PayRun payslips​(List<PayslipSummary> payslips)

    • addPayslipsItem

      public PayRun addPayslipsItem​(PayslipSummary payslipsItem)

    • getPayslips

      public List<PayslipSummary> getPayslips()
      The payslips in the payrun
      Returns:
      payslips

    • setPayslips

      public void setPayslips​(List<PayslipSummary> payslips)

    • wages

      public PayRun wages​(Double wages)

    • getWages

      public Double getWages()
      The total Wages for the Payrun
      Returns:
      wages

    • setWages

      public void setWages​(Double wages)

    • deductions

      public PayRun deductions​(Double deductions)

    • getDeductions

      public Double getDeductions()
      The total Deductions for the Payrun
      Returns:
      deductions

    • setDeductions

      public void setDeductions​(Double deductions)

    • tax

      public PayRun tax​(Double tax)

    • getTax

      public Double getTax()
      The total Tax for the Payrun
      Returns:
      tax

    • setTax

      public void setTax​(Double tax)

    • _super

      public PayRun _super​(Double _super)

    • getSuper

      public Double getSuper()
      The total Super for the Payrun
      Returns:
      _super

    • setSuper

      public void setSuper​(Double _super)

    • reimbursement

      public PayRun reimbursement​(Double reimbursement)

    • getReimbursement

      public Double getReimbursement()
      The total Reimbursements for the Payrun
      Returns:
      reimbursement

    • setReimbursement

      public void setReimbursement​(Double reimbursement)

    • netPay

      public PayRun netPay​(Double netPay)

    • getNetPay

      public Double getNetPay()
      The total NetPay for the Payrun
      Returns:
      netPay

    • setNetPay

      public void setNetPay​(Double netPay)

    • validationErrors

      public PayRun validationErrors​(List<ValidationError> validationErrors)

    • addValidationErrorsItem

      public PayRun addValidationErrorsItem​(ValidationError validationErrorsItem)

    • getValidationErrors

      public List<ValidationError> getValidationErrors()
      Displays array of validation error messages from the API
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors​(List<ValidationError> validationErrors)

    • 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