Package com.xero.models.payrollau
Class Employee
java.lang.Object
com.xero.models.payrollau.Employee
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe employee’s gender.static enum* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddBankAccountsItem(BankAccount bankAccountsItem) bankAccountsaddLeaveBalancesItem(LeaveBalance leaveBalancesItem) leaveBalancesaddLeaveLinesItem(LeaveLine leaveLinesItem) leaveLinesaddSuperMembershipsItem(SuperMembership superMembershipsItem) superMembershipsaddValidationErrorsItem(ValidationError validationErrorsItem) Displays array of validation error messages from the APIbankAccounts(List<BankAccount> bankAccounts) bankAccountsclassification(String classification) Employees classificationcountryOfResidence(CountryOfResidence countryOfResidence) countryOfResidencedateOfBirth(String dateOfBirth) Date of birth of the employee (YYYY-MM-DD)The email address for the employeeemployeeGroupName(String employeeGroupName) The Employee Group allows you to report on payroll expenses and liabilities for each group of employeesemployeeID(UUID employeeID) Xero unique identifier for an EmployeeemploymentType(EmploymentType employmentType) employmentTypebooleanFirst name of employeegender(Employee.GenderEnum gender) The employee’s gender.Get bankAccountsEmployees classificationGet countryOfResidenceDate of birth of the employee (YYYY-MM-DD)org.threeten.bp.LocalDateDate of birth of the employee (YYYY-MM-DD)getEmail()The email address for the employeeThe Employee Group allows you to report on payroll expenses and liabilities for each group of employeesXero unique identifier for an EmployeeGet employmentTypeFirst name of employeeThe employee’s gender.Get homeAddressGet incomeTypeAuthorised to approve other employees' leave requestsAuthorised to approve timesheetsIndicates if the employee has been updated for STP Phase 2 compliance.JobTitle of the employeeLast name of employeeGet leaveBalancesGet leaveLinesMiddle name(s) of the employeeEmployee mobile numberGet openingBalancesXero unique identifier for earnings rateXero unique identifier for payroll calendar for the employeeGet payTemplategetPhone()Employee phone numberStart date for an employee (YYYY-MM-DD)org.threeten.bp.LocalDateStart date for an employee (YYYY-MM-DD)Get statusGet superMembershipsGet taxDeclarationEmployee Termination Date (YYYY-MM-DD)org.threeten.bp.LocalDateEmployee Termination Date (YYYY-MM-DD)* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.getTitle()Title of the employeeEmployee’s twitter nameLast modified timestamporg.threeten.bp.OffsetDateTimeLast modified timestampDisplays array of validation error messages from the APIinthashCode()homeAddress(HomeAddress homeAddress) homeAddressincomeType(IncomeType incomeType) incomeTypeisAuthorisedToApproveLeave(Boolean isAuthorisedToApproveLeave) Authorised to approve other employees' leave requestsisAuthorisedToApproveTimesheets(Boolean isAuthorisedToApproveTimesheets) Authorised to approve timesheetsisSTP2Qualified(Boolean isSTP2Qualified) Indicates if the employee has been updated for STP Phase 2 compliance.JobTitle of the employeeLast name of employeeleaveBalances(List<LeaveBalance> leaveBalances) leaveBalancesleaveLines(List<LeaveLine> leaveLines) leaveLinesmiddleNames(String middleNames) Middle name(s) of the employeeEmployee mobile numberopeningBalances(OpeningBalances openingBalances) openingBalancesordinaryEarningsRateID(UUID ordinaryEarningsRateID) Xero unique identifier for earnings ratepayrollCalendarID(UUID payrollCalendarID) Xero unique identifier for payroll calendar for the employeepayTemplate(PayTemplate payTemplate) payTemplateEmployee phone numbervoidsetBankAccounts(List<BankAccount> bankAccounts) bankAccountsvoidsetClassification(String classification) Employees classificationvoidsetCountryOfResidence(CountryOfResidence countryOfResidence) countryOfResidencevoidsetDateOfBirth(String dateOfBirth) Date of birth of the employee (YYYY-MM-DD)voidsetDateOfBirth(org.threeten.bp.LocalDate dateOfBirth) Date of birth of the employee (YYYY-MM-DD)voidThe email address for the employeevoidsetEmployeeGroupName(String employeeGroupName) The Employee Group allows you to report on payroll expenses and liabilities for each group of employeesvoidsetEmployeeID(UUID employeeID) Xero unique identifier for an EmployeevoidsetEmploymentType(EmploymentType employmentType) employmentTypevoidsetFirstName(String firstName) First name of employeevoidsetGender(Employee.GenderEnum gender) The employee’s gender.voidsetHomeAddress(HomeAddress homeAddress) homeAddressvoidsetIncomeType(IncomeType incomeType) incomeTypevoidsetIsAuthorisedToApproveLeave(Boolean isAuthorisedToApproveLeave) Authorised to approve other employees' leave requestsvoidsetIsAuthorisedToApproveTimesheets(Boolean isAuthorisedToApproveTimesheets) Authorised to approve timesheetsvoidsetIsSTP2Qualified(Boolean isSTP2Qualified) Indicates if the employee has been updated for STP Phase 2 compliance.voidsetJobTitle(String jobTitle) JobTitle of the employeevoidsetLastName(String lastName) Last name of employeevoidsetLeaveBalances(List<LeaveBalance> leaveBalances) leaveBalancesvoidsetLeaveLines(List<LeaveLine> leaveLines) leaveLinesvoidsetMiddleNames(String middleNames) Middle name(s) of the employeevoidEmployee mobile numbervoidsetOpeningBalances(OpeningBalances openingBalances) openingBalancesvoidsetOrdinaryEarningsRateID(UUID ordinaryEarningsRateID) Xero unique identifier for earnings ratevoidsetPayrollCalendarID(UUID payrollCalendarID) Xero unique identifier for payroll calendar for the employeevoidsetPayTemplate(PayTemplate payTemplate) payTemplatevoidEmployee phone numbervoidsetStartDate(String startDate) Start date for an employee (YYYY-MM-DD)voidsetStartDate(org.threeten.bp.LocalDate startDate) Start date for an employee (YYYY-MM-DD)voidsetStatus(EmployeeStatus status) statusvoidsetSuperMemberships(List<SuperMembership> superMemberships) superMembershipsvoidsetTaxDeclaration(TaxDeclaration taxDeclaration) taxDeclarationvoidsetTerminationDate(String terminationDate) Employee Termination Date (YYYY-MM-DD)voidsetTerminationDate(org.threeten.bp.LocalDate terminationDate) Employee Termination Date (YYYY-MM-DD)voidsetTerminationReason(Employee.TerminationReasonEnum terminationReason) * `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.voidTitle of the employeevoidsetTwitterUserName(String twitterUserName) Employee’s twitter namevoidsetValidationErrors(List<ValidationError> validationErrors) Displays array of validation error messages from the APIStart date for an employee (YYYY-MM-DD)status(EmployeeStatus status) statussuperMemberships(List<SuperMembership> superMemberships) superMembershipstaxDeclaration(TaxDeclaration taxDeclaration) taxDeclarationterminationDate(String terminationDate) Employee Termination Date (YYYY-MM-DD)terminationReason(Employee.TerminationReasonEnum terminationReason) * `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.Title of the employeetoString()twitterUserName(String twitterUserName) Employee’s twitter namevalidationErrors(List<ValidationError> validationErrors) Displays array of validation error messages from the API
-
Constructor Details
-
Employee
public Employee()
-
-
Method Details
-
firstName
-
getFirstName
-
setFirstName
-
lastName
-
getLastName
-
setLastName
-
dateOfBirth
-
getDateOfBirth
-
getDateOfBirthAsDate
public org.threeten.bp.LocalDate getDateOfBirthAsDate()Date of birth of the employee (YYYY-MM-DD)- Returns:
- LocalDate
-
setDateOfBirth
Date of birth of the employee (YYYY-MM-DD)- Parameters:
dateOfBirth- String
-
setDateOfBirth
public void setDateOfBirth(org.threeten.bp.LocalDate dateOfBirth) Date of birth of the employee (YYYY-MM-DD)- Parameters:
dateOfBirth- LocalDateTime
-
homeAddress
homeAddress- Parameters:
homeAddress- HomeAddress- Returns:
- Employee
-
getHomeAddress
-
setHomeAddress
homeAddress- Parameters:
homeAddress- HomeAddress
-
startDate
-
getStartDate
-
getStartDateAsDate
public org.threeten.bp.LocalDate getStartDateAsDate()Start date for an employee (YYYY-MM-DD)- Returns:
- LocalDate
-
setStartDate
Start date for an employee (YYYY-MM-DD)- Parameters:
startDate- String
-
setStartDate
public void setStartDate(org.threeten.bp.LocalDate startDate) Start date for an employee (YYYY-MM-DD)- Parameters:
startDate- LocalDateTime
-
title
-
getTitle
-
setTitle
-
middleNames
-
getMiddleNames
-
setMiddleNames
Middle name(s) of the employee- Parameters:
middleNames- String
-
email
-
getEmail
-
setEmail
-
gender
The employee’s gender. See Employee Gender- Parameters:
gender- GenderEnum- Returns:
- Employee
-
getGender
-
setGender
The employee’s gender. See Employee Gender- Parameters:
gender- GenderEnum
-
phone
-
getPhone
-
setPhone
-
mobile
-
getMobile
-
setMobile
-
twitterUserName
-
getTwitterUserName
-
setTwitterUserName
Employee’s twitter name- Parameters:
twitterUserName- String
-
isAuthorisedToApproveLeave
-
getIsAuthorisedToApproveLeave
Authorised to approve other employees' leave requests- Returns:
- isAuthorisedToApproveLeave
-
setIsAuthorisedToApproveLeave
Authorised to approve other employees' leave requests- Parameters:
isAuthorisedToApproveLeave- Boolean
-
isAuthorisedToApproveTimesheets
-
getIsAuthorisedToApproveTimesheets
Authorised to approve timesheets- Returns:
- isAuthorisedToApproveTimesheets
-
setIsAuthorisedToApproveTimesheets
Authorised to approve timesheets- Parameters:
isAuthorisedToApproveTimesheets- Boolean
-
jobTitle
-
getJobTitle
-
setJobTitle
-
classification
-
getClassification
-
setClassification
Employees classification- Parameters:
classification- String
-
ordinaryEarningsRateID
-
getOrdinaryEarningsRateID
Xero unique identifier for earnings rate- Returns:
- ordinaryEarningsRateID
-
setOrdinaryEarningsRateID
Xero unique identifier for earnings rate- Parameters:
ordinaryEarningsRateID- UUID
-
payrollCalendarID
-
getPayrollCalendarID
Xero unique identifier for payroll calendar for the employee- Returns:
- payrollCalendarID
-
setPayrollCalendarID
Xero unique identifier for payroll calendar for the employee- Parameters:
payrollCalendarID- UUID
-
employeeGroupName
-
getEmployeeGroupName
The Employee Group allows you to report on payroll expenses and liabilities for each group of employees- Returns:
- employeeGroupName
-
setEmployeeGroupName
The Employee Group allows you to report on payroll expenses and liabilities for each group of employees- Parameters:
employeeGroupName- String
-
employeeID
-
getEmployeeID
-
setEmployeeID
Xero unique identifier for an Employee- Parameters:
employeeID- UUID
-
terminationDate
-
getTerminationDate
-
getTerminationDateAsDate
public org.threeten.bp.LocalDate getTerminationDateAsDate()Employee Termination Date (YYYY-MM-DD)- Returns:
- LocalDate
-
setTerminationDate
Employee Termination Date (YYYY-MM-DD)- Parameters:
terminationDate- String
-
setTerminationDate
public void setTerminationDate(org.threeten.bp.LocalDate terminationDate) Employee Termination Date (YYYY-MM-DD)- Parameters:
terminationDate- LocalDateTime
-
terminationReason
* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.- Parameters:
terminationReason- TerminationReasonEnum- Returns:
- Employee
-
getTerminationReason
* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.- Returns:
- terminationReason
-
setTerminationReason
* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.- Parameters:
terminationReason- TerminationReasonEnum
-
bankAccounts
bankAccounts- Parameters:
bankAccounts- List<BankAccount>- Returns:
- Employee
-
addBankAccountsItem
bankAccounts- Parameters:
bankAccountsItem- BankAccount- Returns:
- Employee
-
getBankAccounts
-
setBankAccounts
bankAccounts- Parameters:
bankAccounts- List<BankAccount>
-
payTemplate
payTemplate- Parameters:
payTemplate- PayTemplate- Returns:
- Employee
-
getPayTemplate
-
setPayTemplate
payTemplate- Parameters:
payTemplate- PayTemplate
-
openingBalances
openingBalances- Parameters:
openingBalances- OpeningBalances- Returns:
- Employee
-
getOpeningBalances
-
setOpeningBalances
openingBalances- Parameters:
openingBalances- OpeningBalances
-
taxDeclaration
taxDeclaration- Parameters:
taxDeclaration- TaxDeclaration- Returns:
- Employee
-
getTaxDeclaration
-
setTaxDeclaration
taxDeclaration- Parameters:
taxDeclaration- TaxDeclaration
-
incomeType
incomeType- Parameters:
incomeType- IncomeType- Returns:
- Employee
-
getIncomeType
-
setIncomeType
-
employmentType
employmentType- Parameters:
employmentType- EmploymentType- Returns:
- Employee
-
getEmploymentType
-
setEmploymentType
employmentType- Parameters:
employmentType- EmploymentType
-
countryOfResidence
countryOfResidence- Parameters:
countryOfResidence- CountryOfResidence- Returns:
- Employee
-
getCountryOfResidence
Get countryOfResidence- Returns:
- countryOfResidence
-
setCountryOfResidence
countryOfResidence- Parameters:
countryOfResidence- CountryOfResidence
-
isSTP2Qualified
-
getIsSTP2Qualified
Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable.- Returns:
- isSTP2Qualified
-
setIsSTP2Qualified
Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable.- Parameters:
isSTP2Qualified- Boolean
-
leaveBalances
leaveBalances- Parameters:
leaveBalances- List<LeaveBalance>- Returns:
- Employee
-
addLeaveBalancesItem
leaveBalances- Parameters:
leaveBalancesItem- LeaveBalance- Returns:
- Employee
-
getLeaveBalances
-
setLeaveBalances
leaveBalances- Parameters:
leaveBalances- List<LeaveBalance>
-
leaveLines
-
addLeaveLinesItem
-
getLeaveLines
-
setLeaveLines
-
superMemberships
superMemberships- Parameters:
superMemberships- List<SuperMembership>- Returns:
- Employee
-
addSuperMembershipsItem
superMemberships- Parameters:
superMembershipsItem- SuperMembership- Returns:
- Employee
-
getSuperMemberships
-
setSuperMemberships
superMemberships- Parameters:
superMemberships- List<SuperMembership>
-
status
status- Parameters:
status- EmployeeStatus- Returns:
- Employee
-
getStatus
-
setStatus
-
getUpdatedDateUTC
-
getUpdatedDateUTCAsDate
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()Last modified timestamp- Returns:
- OffsetDateTime
-
validationErrors
Displays array of validation error messages from the API- Parameters:
validationErrors- List<ValidationError>- Returns:
- Employee
-
addValidationErrorsItem
Displays array of validation error messages from the API- Parameters:
validationErrorsItem- ValidationError- Returns:
- Employee
-
getValidationErrors
Displays array of validation error messages from the API- Returns:
- validationErrors
-
setValidationErrors
Displays array of validation error messages from the API- Parameters:
validationErrors- List<ValidationError>
-
equals
-
hashCode
-
toString
-