com.xero.models.payrollau

Class PayRun

java.lang.Object

com.xero.models.payrollau.PayRun

public class PayRun
extends Object

PayRun

Constructor Summary

Constructors

Constructor and Description
PayRun()

Method Summary

Modifier and Type	Method and Description
PayRun	_super(Double _super)
PayRun	addPayslipsItem(PayslipSummary payslipsItem)
PayRun	addValidationErrorsItem(ValidationError validationErrorsItem)
PayRun	deductions(Double deductions)
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()
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()
String	getPayRunPeriodStartDate() Period Start Date for the PayRun (YYYY-MM-DD)
org.threeten.bp.LocalDate	getPayRunPeriodStartDateAsDate()
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()
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)
PayRun	paymentDate(String paymentDate)
PayRun	payrollCalendarID(UUID payrollCalendarID)
PayRun	payRunID(UUID payRunID)
PayRun	payRunPeriodEndDate(String payRunPeriodEndDate)
PayRun	payRunPeriodStartDate(String payRunPeriodStartDate)
PayRun	payRunStatus(PayRunStatus payRunStatus)
PayRun	payslipMessage(String payslipMessage)
PayRun	payslips(List<PayslipSummary> payslips)
PayRun	reimbursement(Double reimbursement)
void	setDeductions(Double deductions)
void	setNetPay(Double netPay)
void	setPaymentDate(org.threeten.bp.LocalDate paymentDate)
void	setPaymentDate(String paymentDate)
void	setPayrollCalendarID(UUID payrollCalendarID)
void	setPayRunID(UUID payRunID)
void	setPayRunPeriodEndDate(org.threeten.bp.LocalDate payRunPeriodEndDate)
void	setPayRunPeriodEndDate(String payRunPeriodEndDate)
void	setPayRunPeriodStartDate(org.threeten.bp.LocalDate payRunPeriodStartDate)
void	setPayRunPeriodStartDate(String payRunPeriodStartDate)
void	setPayRunStatus(PayRunStatus payRunStatus)
void	setPayslipMessage(String payslipMessage)
void	setPayslips(List<PayslipSummary> payslips)
void	setReimbursement(Double reimbursement)
void	setSuper(Double _super)
void	setTax(Double tax)
void	setValidationErrors(List<ValidationError> validationErrors)
void	setWages(Double wages)
PayRun	tax(Double tax)
String	toString()
PayRun	validationErrors(List<ValidationError> validationErrors)
PayRun	wages(Double wages)

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)

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