java.lang.Object
- com.xero.models.payrollau.PayRun

```
public class PayRun
extends Object
```
PayRun

Constructor Summary

Constructors
Constructor Description

PayRun()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PayRun`	`_super(Double _super)`	The total Super for the Payrun
`PayRun`	`addPayslipsItem(PayslipSummary payslipsItem)`	The payslips in the payrun
`PayRun`	`addValidationErrorsItem(ValidationError validationErrorsItem)`	Displays array of validation error messages from the API
`PayRun`	`deductions(Double deductions)`	The total Deductions for the Payrun
`boolean`	`equals(Object o)`
`Double`	`getDeductions()`	The total Deductions for the Payrun
`Double`	`getNetPay()`	The total NetPay for the Payrun
`String`	`getPaymentDate()`	Payment Date for the PayRun (YYYY-MM-DD)
`org.threeten.bp.LocalDate`	`getPaymentDateAsDate()`	Payment Date for the PayRun (YYYY-MM-DD)
`UUID`	`getPayrollCalendarID()`	Xero identifier for pay run
`UUID`	`getPayRunID()`	Xero identifier for pay run
`String`	`getPayRunPeriodEndDate()`	Period End Date for the PayRun (YYYY-MM-DD)
`org.threeten.bp.LocalDate`	`getPayRunPeriodEndDateAsDate()`	Period End Date for the PayRun (YYYY-MM-DD)
`String`	`getPayRunPeriodStartDate()`	Period Start Date for the PayRun (YYYY-MM-DD)
`org.threeten.bp.LocalDate`	`getPayRunPeriodStartDateAsDate()`	Period Start Date for the PayRun (YYYY-MM-DD)
`PayRunStatus`	`getPayRunStatus()`	Get payRunStatus
`String`	`getPayslipMessage()`	Payslip message for the PayRun
`List<PayslipSummary>`	`getPayslips()`	The payslips in the payrun
`Double`	`getReimbursement()`	The total Reimbursements for the Payrun
`Double`	`getSuper()`	The total Super for the Payrun
`Double`	`getTax()`	The total Tax for the Payrun
`String`	`getUpdatedDateUTC()`	Last modified timestamp
`org.threeten.bp.OffsetDateTime`	`getUpdatedDateUTCAsDate()`	Last modified timestamp
`List<ValidationError>`	`getValidationErrors()`	Displays array of validation error messages from the API
`Double`	`getWages()`	The total Wages for the Payrun
`int`	`hashCode()`
`PayRun`	`netPay(Double netPay)`	The total NetPay for the Payrun
`PayRun`	`paymentDate(String paymentDate)`	Payment Date for the PayRun (YYYY-MM-DD)
`PayRun`	`payrollCalendarID(UUID payrollCalendarID)`	Xero identifier for pay run
`PayRun`	`payRunID(UUID payRunID)`	Xero identifier for pay run
`PayRun`	`payRunPeriodEndDate(String payRunPeriodEndDate)`	Period End Date for the PayRun (YYYY-MM-DD)
`PayRun`	`payRunPeriodStartDate(String payRunPeriodStartDate)`	Period Start Date for the PayRun (YYYY-MM-DD)
`PayRun`	`payRunStatus(PayRunStatus payRunStatus)`	payRunStatus
`PayRun`	`payslipMessage(String payslipMessage)`	Payslip message for the PayRun
`PayRun`	`payslips(List<PayslipSummary> payslips)`	The payslips in the payrun
`PayRun`	`reimbursement(Double reimbursement)`	The total Reimbursements for the Payrun
`void`	`setDeductions(Double deductions)`	The total Deductions for the Payrun
`void`	`setNetPay(Double netPay)`	The total NetPay for the Payrun
`void`	`setPaymentDate(String paymentDate)`	Payment Date for the PayRun (YYYY-MM-DD)
`void`	`setPaymentDate(org.threeten.bp.LocalDate paymentDate)`	Payment Date for the PayRun (YYYY-MM-DD)
`void`	`setPayrollCalendarID(UUID payrollCalendarID)`	Xero identifier for pay run
`void`	`setPayRunID(UUID payRunID)`	Xero identifier for pay run
`void`	`setPayRunPeriodEndDate(String payRunPeriodEndDate)`	Period End Date for the PayRun (YYYY-MM-DD)
`void`	`setPayRunPeriodEndDate(org.threeten.bp.LocalDate payRunPeriodEndDate)`	Period End Date for the PayRun (YYYY-MM-DD)
`void`	`setPayRunPeriodStartDate(String payRunPeriodStartDate)`	Period Start Date for the PayRun (YYYY-MM-DD)
`void`	`setPayRunPeriodStartDate(org.threeten.bp.LocalDate payRunPeriodStartDate)`	Period Start Date for the PayRun (YYYY-MM-DD)
`void`	`setPayRunStatus(PayRunStatus payRunStatus)`	payRunStatus
`void`	`setPayslipMessage(String payslipMessage)`	Payslip message for the PayRun
`void`	`setPayslips(List<PayslipSummary> payslips)`	The payslips in the payrun
`void`	`setReimbursement(Double reimbursement)`	The total Reimbursements for the Payrun
`void`	`setSuper(Double _super)`	The total Super for the Payrun
`void`	`setTax(Double tax)`	The total Tax for the Payrun
`void`	`setValidationErrors(List<ValidationError> validationErrors)`	Displays array of validation error messages from the API
`void`	`setWages(Double wages)`	The total Wages for the Payrun
`PayRun`	`tax(Double tax)`	The total Tax for the Payrun
`String`	`toString()`
`PayRun`	`validationErrors(List<ValidationError> validationErrors)`	Displays array of validation error messages from the API
`PayRun`	`wages(Double wages)`	The total Wages for the Payrun

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PayRun
```
public PayRun()
```
- Method Detail
  - payrollCalendarID
```
public PayRun payrollCalendarID(UUID payrollCalendarID)
```
    Xero identifier for pay run
    
    Parameters:
    
    payrollCalendarID - UUID
    
    Returns:
    
    PayRun
  - getPayrollCalendarID
```
public UUID getPayrollCalendarID()
```
    Xero identifier for pay run
    
    Returns:
    
    payrollCalendarID
  - setPayrollCalendarID
```
public void setPayrollCalendarID(UUID payrollCalendarID)
```
    Xero identifier for pay run
    
    Parameters:
    
    payrollCalendarID - UUID
  - payRunID
```
public PayRun payRunID(UUID payRunID)
```
    Xero identifier for pay run
    
    Parameters:
    
    payRunID - UUID
    
    Returns:
    
    PayRun
  - getPayRunID
```
public UUID getPayRunID()
```
    Xero identifier for pay run
    
    Returns:
    
    payRunID
  - setPayRunID
```
public void setPayRunID(UUID payRunID)
```
    Xero identifier for pay run
    
    Parameters:
    
    payRunID - UUID
  - payRunPeriodStartDate
```
public PayRun payRunPeriodStartDate(String payRunPeriodStartDate)
```
    Period Start Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    payRunPeriodStartDate - String
    
    Returns:
    
    PayRun
  - getPayRunPeriodStartDate
```
public String getPayRunPeriodStartDate()
```
    Period Start Date for the PayRun (YYYY-MM-DD)
    
    Returns:
    
    payRunPeriodStartDate
  - getPayRunPeriodStartDateAsDate
```
public org.threeten.bp.LocalDate getPayRunPeriodStartDateAsDate()
```
    Period Start Date for the PayRun (YYYY-MM-DD)
    
    Returns:
    
    LocalDate
  - setPayRunPeriodStartDate
```
public void setPayRunPeriodStartDate(String payRunPeriodStartDate)
```
    Period Start Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    payRunPeriodStartDate - String
  - setPayRunPeriodStartDate
```
public void setPayRunPeriodStartDate(org.threeten.bp.LocalDate payRunPeriodStartDate)
```
    Period Start Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    payRunPeriodStartDate - LocalDateTime
  - payRunPeriodEndDate
```
public PayRun payRunPeriodEndDate(String payRunPeriodEndDate)
```
    Period End Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    payRunPeriodEndDate - String
    
    Returns:
    
    PayRun
  - getPayRunPeriodEndDate
```
public String getPayRunPeriodEndDate()
```
    Period End Date for the PayRun (YYYY-MM-DD)
    
    Returns:
    
    payRunPeriodEndDate
  - getPayRunPeriodEndDateAsDate
```
public org.threeten.bp.LocalDate getPayRunPeriodEndDateAsDate()
```
    Period End Date for the PayRun (YYYY-MM-DD)
    
    Returns:
    
    LocalDate
  - setPayRunPeriodEndDate
```
public void setPayRunPeriodEndDate(String payRunPeriodEndDate)
```
    Period End Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    payRunPeriodEndDate - String
  - setPayRunPeriodEndDate
```
public void setPayRunPeriodEndDate(org.threeten.bp.LocalDate payRunPeriodEndDate)
```
    Period End Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    payRunPeriodEndDate - LocalDateTime
  - payRunStatus
```
public PayRun payRunStatus(PayRunStatus payRunStatus)
```
    payRunStatus
    
    Parameters:
    
    payRunStatus - PayRunStatus
    
    Returns:
    
    PayRun
  - getPayRunStatus
```
public PayRunStatus getPayRunStatus()
```
    Get payRunStatus
    
    Returns:
    
    payRunStatus
  - setPayRunStatus
```
public void setPayRunStatus(PayRunStatus payRunStatus)
```
    payRunStatus
    
    Parameters:
    
    payRunStatus - PayRunStatus
  - paymentDate
```
public PayRun paymentDate(String paymentDate)
```
    Payment Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    paymentDate - String
    
    Returns:
    
    PayRun
  - getPaymentDate
```
public String getPaymentDate()
```
    Payment Date for the PayRun (YYYY-MM-DD)
    
    Returns:
    
    paymentDate
  - getPaymentDateAsDate
```
public org.threeten.bp.LocalDate getPaymentDateAsDate()
```
    Payment Date for the PayRun (YYYY-MM-DD)
    
    Returns:
    
    LocalDate
  - setPaymentDate
```
public void setPaymentDate(String paymentDate)
```
    Payment Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    paymentDate - String
  - setPaymentDate
```
public void setPaymentDate(org.threeten.bp.LocalDate paymentDate)
```
    Payment Date for the PayRun (YYYY-MM-DD)
    
    Parameters:
    
    paymentDate - LocalDateTime
  - payslipMessage
```
public PayRun payslipMessage(String payslipMessage)
```
    Payslip message for the PayRun
    
    Parameters:
    
    payslipMessage - String
    
    Returns:
    
    PayRun
  - getPayslipMessage
```
public String getPayslipMessage()
```
    Payslip message for the PayRun
    
    Returns:
    
    payslipMessage
  - setPayslipMessage
```
public void setPayslipMessage(String payslipMessage)
```
    Payslip message for the PayRun
    
    Parameters:
    
    payslipMessage - String
  - getUpdatedDateUTC
```
public String getUpdatedDateUTC()
```
    Last modified timestamp
    
    Returns:
    
    updatedDateUTC
  - getUpdatedDateUTCAsDate
```
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()
```
    Last modified timestamp
    
    Returns:
    
    OffsetDateTime
  - payslips
```
public PayRun payslips(List<PayslipSummary> payslips)
```
    The payslips in the payrun
    
    Parameters:
    
    payslips - List<PayslipSummary>
    
    Returns:
    
    PayRun
  - addPayslipsItem
```
public PayRun addPayslipsItem(PayslipSummary payslipsItem)
```
    The payslips in the payrun
    
    Parameters:
    
    payslipsItem - PayslipSummary
    
    Returns:
    
    PayRun
  - getPayslips
```
public List<PayslipSummary> getPayslips()
```
    The payslips in the payrun
    
    Returns:
    
    payslips
  - setPayslips
```
public void setPayslips(List<PayslipSummary> payslips)
```
    The payslips in the payrun
    
    Parameters:
    
    payslips - List<PayslipSummary>
  - wages
```
public PayRun wages(Double wages)
```
    The total Wages for the Payrun
    
    Parameters:
    
    wages - Double
    
    Returns:
    
    PayRun
  - getWages
```
public Double getWages()
```
    The total Wages for the Payrun
    
    Returns:
    
    wages
  - setWages
```
public void setWages(Double wages)
```
    The total Wages for the Payrun
    
    Parameters:
    
    wages - Double
  - deductions
```
public PayRun deductions(Double deductions)
```
    The total Deductions for the Payrun
    
    Parameters:
    
    deductions - Double
    
    Returns:
    
    PayRun
  - getDeductions
```
public Double getDeductions()
```
    The total Deductions for the Payrun
    
    Returns:
    
    deductions
  - setDeductions
```
public void setDeductions(Double deductions)
```
    The total Deductions for the Payrun
    
    Parameters:
    
    deductions - Double
  - tax
```
public PayRun tax(Double tax)
```
    The total Tax for the Payrun
    
    Parameters:
    
    tax - Double
    
    Returns:
    
    PayRun
  - getTax
```
public Double getTax()
```
    The total Tax for the Payrun
    
    Returns:
    
    tax
  - setTax
```
public void setTax(Double tax)
```
    The total Tax for the Payrun
    
    Parameters:
    
    tax - Double
  - _super
```
public PayRun _super(Double _super)
```
    The total Super for the Payrun
    
    Parameters:
    
    _super - Double
    
    Returns:
    
    PayRun
  - getSuper
```
public Double getSuper()
```
    The total Super for the Payrun
    
    Returns:
    
    _super
  - setSuper
```
public void setSuper(Double _super)
```
    The total Super for the Payrun
    
    Parameters:
    
    _super - Double
  - reimbursement
```
public PayRun reimbursement(Double reimbursement)
```
    The total Reimbursements for the Payrun
    
    Parameters:
    
    reimbursement - Double
    
    Returns:
    
    PayRun
  - getReimbursement
```
public Double getReimbursement()
```
    The total Reimbursements for the Payrun
    
    Returns:
    
    reimbursement
  - setReimbursement
```
public void setReimbursement(Double reimbursement)
```
    The total Reimbursements for the Payrun
    
    Parameters:
    
    reimbursement - Double
  - netPay
```
public PayRun netPay(Double netPay)
```
    The total NetPay for the Payrun
    
    Parameters:
    
    netPay - Double
    
    Returns:
    
    PayRun
  - getNetPay
```
public Double getNetPay()
```
    The total NetPay for the Payrun
    
    Returns:
    
    netPay
  - setNetPay
```
public void setNetPay(Double netPay)
```
    The total NetPay for the Payrun
    
    Parameters:
    
    netPay - Double
  - validationErrors
```
public PayRun validationErrors(List<ValidationError> validationErrors)
```
    Displays array of validation error messages from the API
    
    Parameters:
    
    validationErrors - List<ValidationError>
    
    Returns:
    
    PayRun
  - addValidationErrorsItem
```
public PayRun addValidationErrorsItem(ValidationError validationErrorsItem)
```
    Displays array of validation error messages from the API
    
    Parameters:
    
    validationErrorsItem - ValidationError
    
    Returns:
    
    PayRun
  - getValidationErrors
```
public List<ValidationError> getValidationErrors()
```
    Displays array of validation error messages from the API
    
    Returns:
    
    validationErrors
  - setValidationErrors
```
public void setValidationErrors(List<ValidationError> validationErrors)
```
    Displays array of validation error messages from the API
    
    Parameters:
    
    validationErrors - List<ValidationError>
  - 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

Class PayRun

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PayRun

Method Detail

payrollCalendarID

getPayrollCalendarID

setPayrollCalendarID

payRunID

getPayRunID

setPayRunID

payRunPeriodStartDate

getPayRunPeriodStartDate

getPayRunPeriodStartDateAsDate

setPayRunPeriodStartDate

setPayRunPeriodStartDate

payRunPeriodEndDate

getPayRunPeriodEndDate

getPayRunPeriodEndDateAsDate

setPayRunPeriodEndDate

setPayRunPeriodEndDate

payRunStatus

getPayRunStatus

setPayRunStatus

paymentDate

getPaymentDate

getPaymentDateAsDate

setPaymentDate

setPaymentDate

payslipMessage

getPayslipMessage

setPayslipMessage

getUpdatedDateUTC

getUpdatedDateUTCAsDate

payslips

addPayslipsItem

getPayslips

setPayslips

wages

getWages

setWages

deductions

getDeductions

setDeductions

tax

getTax

setTax

_super

getSuper

setSuper

reimbursement

getReimbursement

setReimbursement

netPay

getNetPay

setNetPay

validationErrors

addValidationErrorsItem

getValidationErrors

setValidationErrors

equals

hashCode

toString