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

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PayRun.CalendarTypeEnum`	Calendar type of the pay run
`static class`	`PayRun.PayRunStatusEnum`	Pay run status
`static class`	`PayRun.PayRunTypeEnum`	Pay run type

Constructor Summary

Constructors
Constructor Description

PayRun()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PayRun`	`addPaySlipsItem(Payslip paySlipsItem)`	paySlips
`PayRun`	`calendarType(PayRun.CalendarTypeEnum calendarType)`	Calendar type of the pay run
`boolean`	`equals(Object o)`
`PayRun.CalendarTypeEnum`	`getCalendarType()`	Calendar type of the pay run
`org.threeten.bp.LocalDate`	`getPaymentDate()`	Payment date of the pay run
`UUID`	`getPayrollCalendarID()`	Xero unique identifier for the payroll calendar
`UUID`	`getPayRunID()`	Xero unique identifier for the pay run
`PayRun.PayRunStatusEnum`	`getPayRunStatus()`	Pay run status
`PayRun.PayRunTypeEnum`	`getPayRunType()`	Pay run type
`List<Payslip>`	`getPaySlips()`	Get paySlips
`org.threeten.bp.LocalDate`	`getPeriodEndDate()`	Period end date of the payroll calendar
`org.threeten.bp.LocalDate`	`getPeriodStartDate()`	Period start date of the payroll calendar
`org.threeten.bp.LocalDate`	`getPostedDateTime()`	Posted date time of the pay run
`Double`	`getTotalCost()`	Total cost of the pay run
`Double`	`getTotalPay()`	Total pay of the pay run
`int`	`hashCode()`
`PayRun`	`paymentDate(org.threeten.bp.LocalDate paymentDate)`	Payment date of the pay run
`PayRun`	`payrollCalendarID(UUID payrollCalendarID)`	Xero unique identifier for the payroll calendar
`PayRun`	`payRunID(UUID payRunID)`	Xero unique identifier for the pay run
`PayRun`	`payRunStatus(PayRun.PayRunStatusEnum payRunStatus)`	Pay run status
`PayRun`	`payRunType(PayRun.PayRunTypeEnum payRunType)`	Pay run type
`PayRun`	`paySlips(List<Payslip> paySlips)`	paySlips
`PayRun`	`periodEndDate(org.threeten.bp.LocalDate periodEndDate)`	Period end date of the payroll calendar
`PayRun`	`periodStartDate(org.threeten.bp.LocalDate periodStartDate)`	Period start date of the payroll calendar
`PayRun`	`postedDateTime(org.threeten.bp.LocalDate postedDateTime)`	Posted date time of the pay run
`void`	`setCalendarType(PayRun.CalendarTypeEnum calendarType)`	Calendar type of the pay run
`void`	`setPaymentDate(org.threeten.bp.LocalDate paymentDate)`	Payment date of the pay run
`void`	`setPayrollCalendarID(UUID payrollCalendarID)`	Xero unique identifier for the payroll calendar
`void`	`setPayRunID(UUID payRunID)`	Xero unique identifier for the pay run
`void`	`setPayRunStatus(PayRun.PayRunStatusEnum payRunStatus)`	Pay run status
`void`	`setPayRunType(PayRun.PayRunTypeEnum payRunType)`	Pay run type
`void`	`setPaySlips(List<Payslip> paySlips)`	paySlips
`void`	`setPeriodEndDate(org.threeten.bp.LocalDate periodEndDate)`	Period end date of the payroll calendar
`void`	`setPeriodStartDate(org.threeten.bp.LocalDate periodStartDate)`	Period start date of the payroll calendar
`void`	`setPostedDateTime(org.threeten.bp.LocalDate postedDateTime)`	Posted date time of the pay run
`void`	`setTotalCost(Double totalCost)`	Total cost of the pay run
`void`	`setTotalPay(Double totalPay)`	Total pay of the pay run
`String`	`toString()`
`PayRun`	`totalCost(Double totalCost)`	Total cost of the pay run
`PayRun`	`totalPay(Double totalPay)`	Total pay of the pay run

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

- Constructor Detail
  - PayRun
```
public PayRun()
```
- Method Detail
  - payRunID
```
public PayRun payRunID(UUID payRunID)
```
    Xero unique identifier for the pay run
    
    Parameters:
    
    payRunID - UUID
    
    Returns:
    
    PayRun
  - getPayRunID
```
public UUID getPayRunID()
```
    Xero unique identifier for the pay run
    
    Returns:
    
    payRunID
  - setPayRunID
```
public void setPayRunID(UUID payRunID)
```
    Xero unique identifier for the pay run
    
    Parameters:
    
    payRunID - UUID
  - payrollCalendarID
```
public PayRun payrollCalendarID(UUID payrollCalendarID)
```
    Xero unique identifier for the payroll calendar
    
    Parameters:
    
    payrollCalendarID - UUID
    
    Returns:
    
    PayRun
  - getPayrollCalendarID
```
public UUID getPayrollCalendarID()
```
    Xero unique identifier for the payroll calendar
    
    Returns:
    
    payrollCalendarID
  - setPayrollCalendarID
```
public void setPayrollCalendarID(UUID payrollCalendarID)
```
    Xero unique identifier for the payroll calendar
    
    Parameters:
    
    payrollCalendarID - UUID
  - periodStartDate
```
public PayRun periodStartDate(org.threeten.bp.LocalDate periodStartDate)
```
    Period start date of the payroll calendar
    
    Parameters:
    
    periodStartDate - LocalDate
    
    Returns:
    
    PayRun
  - getPeriodStartDate
```
public org.threeten.bp.LocalDate getPeriodStartDate()
```
    Period start date of the payroll calendar
    
    Returns:
    
    periodStartDate
  - setPeriodStartDate
```
public void setPeriodStartDate(org.threeten.bp.LocalDate periodStartDate)
```
    Period start date of the payroll calendar
    
    Parameters:
    
    periodStartDate - LocalDate
  - periodEndDate
```
public PayRun periodEndDate(org.threeten.bp.LocalDate periodEndDate)
```
    Period end date of the payroll calendar
    
    Parameters:
    
    periodEndDate - LocalDate
    
    Returns:
    
    PayRun
  - getPeriodEndDate
```
public org.threeten.bp.LocalDate getPeriodEndDate()
```
    Period end date of the payroll calendar
    
    Returns:
    
    periodEndDate
  - setPeriodEndDate
```
public void setPeriodEndDate(org.threeten.bp.LocalDate periodEndDate)
```
    Period end date of the payroll calendar
    
    Parameters:
    
    periodEndDate - LocalDate
  - paymentDate
```
public PayRun paymentDate(org.threeten.bp.LocalDate paymentDate)
```
    Payment date of the pay run
    
    Parameters:
    
    paymentDate - LocalDate
    
    Returns:
    
    PayRun
  - getPaymentDate
```
public org.threeten.bp.LocalDate getPaymentDate()
```
    Payment date of the pay run
    
    Returns:
    
    paymentDate
  - setPaymentDate
```
public void setPaymentDate(org.threeten.bp.LocalDate paymentDate)
```
    Payment date of the pay run
    
    Parameters:
    
    paymentDate - LocalDate
  - totalCost
```
public PayRun totalCost(Double totalCost)
```
    Total cost of the pay run
    
    Parameters:
    
    totalCost - Double
    
    Returns:
    
    PayRun
  - getTotalCost
```
public Double getTotalCost()
```
    Total cost of the pay run
    
    Returns:
    
    totalCost
  - setTotalCost
```
public void setTotalCost(Double totalCost)
```
    Total cost of the pay run
    
    Parameters:
    
    totalCost - Double
  - totalPay
```
public PayRun totalPay(Double totalPay)
```
    Total pay of the pay run
    
    Parameters:
    
    totalPay - Double
    
    Returns:
    
    PayRun
  - getTotalPay
```
public Double getTotalPay()
```
    Total pay of the pay run
    
    Returns:
    
    totalPay
  - setTotalPay
```
public void setTotalPay(Double totalPay)
```
    Total pay of the pay run
    
    Parameters:
    
    totalPay - Double
  - payRunStatus
```
public PayRun payRunStatus(PayRun.PayRunStatusEnum payRunStatus)
```
    Pay run status
    
    Parameters:
    
    payRunStatus - PayRunStatusEnum
    
    Returns:
    
    PayRun
  - getPayRunStatus
```
public PayRun.PayRunStatusEnum getPayRunStatus()
```
    Pay run status
    
    Returns:
    
    payRunStatus
  - setPayRunStatus
```
public void setPayRunStatus(PayRun.PayRunStatusEnum payRunStatus)
```
    Pay run status
    
    Parameters:
    
    payRunStatus - PayRunStatusEnum
  - payRunType
```
public PayRun payRunType(PayRun.PayRunTypeEnum payRunType)
```
    Pay run type
    
    Parameters:
    
    payRunType - PayRunTypeEnum
    
    Returns:
    
    PayRun
  - getPayRunType
```
public PayRun.PayRunTypeEnum getPayRunType()
```
    Pay run type
    
    Returns:
    
    payRunType
  - setPayRunType
```
public void setPayRunType(PayRun.PayRunTypeEnum payRunType)
```
    Pay run type
    
    Parameters:
    
    payRunType - PayRunTypeEnum
  - calendarType
```
public PayRun calendarType(PayRun.CalendarTypeEnum calendarType)
```
    Calendar type of the pay run
    
    Parameters:
    
    calendarType - CalendarTypeEnum
    
    Returns:
    
    PayRun
  - getCalendarType
```
public PayRun.CalendarTypeEnum getCalendarType()
```
    Calendar type of the pay run
    
    Returns:
    
    calendarType
  - setCalendarType
```
public void setCalendarType(PayRun.CalendarTypeEnum calendarType)
```
    Calendar type of the pay run
    
    Parameters:
    
    calendarType - CalendarTypeEnum
  - postedDateTime
```
public PayRun postedDateTime(org.threeten.bp.LocalDate postedDateTime)
```
    Posted date time of the pay run
    
    Parameters:
    
    postedDateTime - LocalDate
    
    Returns:
    
    PayRun
  - getPostedDateTime
```
public org.threeten.bp.LocalDate getPostedDateTime()
```
    Posted date time of the pay run
    
    Returns:
    
    postedDateTime
  - setPostedDateTime
```
public void setPostedDateTime(org.threeten.bp.LocalDate postedDateTime)
```
    Posted date time of the pay run
    
    Parameters:
    
    postedDateTime - LocalDate
  - paySlips
```
public PayRun paySlips(List<Payslip> paySlips)
```
    paySlips
    
    Parameters:
    
    paySlips - List<Payslip>
    
    Returns:
    
    PayRun
  - addPaySlipsItem
```
public PayRun addPaySlipsItem(Payslip paySlipsItem)
```
    paySlips
    
    Parameters:
    
    paySlipsItem - Payslip
    
    Returns:
    
    PayRun
  - getPaySlips
```
public List<Payslip> getPaySlips()
```
    Get paySlips
    
    Returns:
    
    paySlips
  - setPaySlips
```
public void setPaySlips(List<Payslip> paySlips)
```
    paySlips
    
    Parameters:
    
    paySlips - List<Payslip>
  - 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

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PayRun

Method Detail

payRunID

getPayRunID

setPayRunID

payrollCalendarID

getPayrollCalendarID

setPayrollCalendarID

periodStartDate

getPeriodStartDate

setPeriodStartDate

periodEndDate

getPeriodEndDate

setPeriodEndDate

paymentDate

getPaymentDate

setPaymentDate

totalCost

getTotalCost

setTotalCost

totalPay

getTotalPay

setTotalPay

payRunStatus

getPayRunStatus

setPayRunStatus

payRunType

getPayRunType

setPayRunType

calendarType

getCalendarType

setCalendarType

postedDateTime

getPostedDateTime

setPostedDateTime

paySlips

addPaySlipsItem

getPaySlips

setPaySlips

equals

hashCode

toString