Class Employee


  • public class Employee
    extends Object
    Employee
    • Constructor Detail

      • Employee

        public Employee()
    • Method Detail

      • firstName

        public Employee firstName​(String firstName)
        First name of employee
        Parameters:
        firstName - String
        Returns:
        Employee
      • getFirstName

        public String getFirstName()
        First name of employee
        Returns:
        firstName
      • setFirstName

        public void setFirstName​(String firstName)
        First name of employee
        Parameters:
        firstName - String
      • lastName

        public Employee lastName​(String lastName)
        Last name of employee
        Parameters:
        lastName - String
        Returns:
        Employee
      • getLastName

        public String getLastName()
        Last name of employee
        Returns:
        lastName
      • setLastName

        public void setLastName​(String lastName)
        Last name of employee
        Parameters:
        lastName - String
      • dateOfBirth

        public Employee dateOfBirth​(String dateOfBirth)
        Date of birth of the employee (YYYY-MM-DD)
        Parameters:
        dateOfBirth - String
        Returns:
        Employee
      • getDateOfBirth

        public String getDateOfBirth()
        Date of birth of the employee (YYYY-MM-DD)
        Returns:
        dateOfBirth
      • getDateOfBirthAsDate

        public org.threeten.bp.LocalDate getDateOfBirthAsDate()
        Date of birth of the employee (YYYY-MM-DD)
        Returns:
        LocalDate
      • setDateOfBirth

        public void setDateOfBirth​(String dateOfBirth)
        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

        public Employee homeAddress​(HomeAddress homeAddress)
        homeAddress
        Parameters:
        homeAddress - HomeAddress
        Returns:
        Employee
      • getHomeAddress

        public HomeAddress getHomeAddress()
        Get homeAddress
        Returns:
        homeAddress
      • setHomeAddress

        public void setHomeAddress​(HomeAddress homeAddress)
        homeAddress
        Parameters:
        homeAddress - HomeAddress
      • startDate

        public Employee startDate​(String startDate)
        Start date for an employee (YYYY-MM-DD)
        Parameters:
        startDate - String
        Returns:
        Employee
      • getStartDate

        public String getStartDate()
        Start date for an employee (YYYY-MM-DD)
        Returns:
        startDate
      • getStartDateAsDate

        public org.threeten.bp.LocalDate getStartDateAsDate()
        Start date for an employee (YYYY-MM-DD)
        Returns:
        LocalDate
      • setStartDate

        public void setStartDate​(String startDate)
        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

        public Employee title​(String title)
        Title of the employee
        Parameters:
        title - String
        Returns:
        Employee
      • getTitle

        public String getTitle()
        Title of the employee
        Returns:
        title
      • setTitle

        public void setTitle​(String title)
        Title of the employee
        Parameters:
        title - String
      • middleNames

        public Employee middleNames​(String middleNames)
        Middle name(s) of the employee
        Parameters:
        middleNames - String
        Returns:
        Employee
      • getMiddleNames

        public String getMiddleNames()
        Middle name(s) of the employee
        Returns:
        middleNames
      • setMiddleNames

        public void setMiddleNames​(String middleNames)
        Middle name(s) of the employee
        Parameters:
        middleNames - String
      • email

        public Employee email​(String email)
        The email address for the employee
        Parameters:
        email - String
        Returns:
        Employee
      • getEmail

        public String getEmail()
        The email address for the employee
        Returns:
        email
      • setEmail

        public void setEmail​(String email)
        The email address for the employee
        Parameters:
        email - String
      • gender

        public Employee gender​(Employee.GenderEnum gender)
        The employee’s gender. See Employee Gender
        Parameters:
        gender - GenderEnum
        Returns:
        Employee
      • getGender

        public Employee.GenderEnum getGender()
        The employee’s gender. See Employee Gender
        Returns:
        gender
      • setGender

        public void setGender​(Employee.GenderEnum gender)
        The employee’s gender. See Employee Gender
        Parameters:
        gender - GenderEnum
      • phone

        public Employee phone​(String phone)
        Employee phone number
        Parameters:
        phone - String
        Returns:
        Employee
      • getPhone

        public String getPhone()
        Employee phone number
        Returns:
        phone
      • setPhone

        public void setPhone​(String phone)
        Employee phone number
        Parameters:
        phone - String
      • mobile

        public Employee mobile​(String mobile)
        Employee mobile number
        Parameters:
        mobile - String
        Returns:
        Employee
      • getMobile

        public String getMobile()
        Employee mobile number
        Returns:
        mobile
      • setMobile

        public void setMobile​(String mobile)
        Employee mobile number
        Parameters:
        mobile - String
      • twitterUserName

        public Employee twitterUserName​(String twitterUserName)
        Employee’s twitter name
        Parameters:
        twitterUserName - String
        Returns:
        Employee
      • getTwitterUserName

        public String getTwitterUserName()
        Employee’s twitter name
        Returns:
        twitterUserName
      • setTwitterUserName

        public void setTwitterUserName​(String twitterUserName)
        Employee’s twitter name
        Parameters:
        twitterUserName - String
      • isAuthorisedToApproveLeave

        public Employee isAuthorisedToApproveLeave​(Boolean isAuthorisedToApproveLeave)
        Authorised to approve other employees' leave requests
        Parameters:
        isAuthorisedToApproveLeave - Boolean
        Returns:
        Employee
      • getIsAuthorisedToApproveLeave

        public Boolean getIsAuthorisedToApproveLeave()
        Authorised to approve other employees' leave requests
        Returns:
        isAuthorisedToApproveLeave
      • setIsAuthorisedToApproveLeave

        public void setIsAuthorisedToApproveLeave​(Boolean isAuthorisedToApproveLeave)
        Authorised to approve other employees' leave requests
        Parameters:
        isAuthorisedToApproveLeave - Boolean
      • isAuthorisedToApproveTimesheets

        public Employee isAuthorisedToApproveTimesheets​(Boolean isAuthorisedToApproveTimesheets)
        Authorised to approve timesheets
        Parameters:
        isAuthorisedToApproveTimesheets - Boolean
        Returns:
        Employee
      • getIsAuthorisedToApproveTimesheets

        public Boolean getIsAuthorisedToApproveTimesheets()
        Authorised to approve timesheets
        Returns:
        isAuthorisedToApproveTimesheets
      • setIsAuthorisedToApproveTimesheets

        public void setIsAuthorisedToApproveTimesheets​(Boolean isAuthorisedToApproveTimesheets)
        Authorised to approve timesheets
        Parameters:
        isAuthorisedToApproveTimesheets - Boolean
      • jobTitle

        public Employee jobTitle​(String jobTitle)
        JobTitle of the employee
        Parameters:
        jobTitle - String
        Returns:
        Employee
      • getJobTitle

        public String getJobTitle()
        JobTitle of the employee
        Returns:
        jobTitle
      • setJobTitle

        public void setJobTitle​(String jobTitle)
        JobTitle of the employee
        Parameters:
        jobTitle - String
      • classification

        public Employee classification​(String classification)
        Employees classification
        Parameters:
        classification - String
        Returns:
        Employee
      • getClassification

        public String getClassification()
        Employees classification
        Returns:
        classification
      • setClassification

        public void setClassification​(String classification)
        Employees classification
        Parameters:
        classification - String
      • ordinaryEarningsRateID

        public Employee ordinaryEarningsRateID​(UUID ordinaryEarningsRateID)
        Xero unique identifier for earnings rate
        Parameters:
        ordinaryEarningsRateID - UUID
        Returns:
        Employee
      • getOrdinaryEarningsRateID

        public UUID getOrdinaryEarningsRateID()
        Xero unique identifier for earnings rate
        Returns:
        ordinaryEarningsRateID
      • setOrdinaryEarningsRateID

        public void setOrdinaryEarningsRateID​(UUID ordinaryEarningsRateID)
        Xero unique identifier for earnings rate
        Parameters:
        ordinaryEarningsRateID - UUID
      • payrollCalendarID

        public Employee payrollCalendarID​(UUID payrollCalendarID)
        Xero unique identifier for payroll calendar for the employee
        Parameters:
        payrollCalendarID - UUID
        Returns:
        Employee
      • getPayrollCalendarID

        public UUID getPayrollCalendarID()
        Xero unique identifier for payroll calendar for the employee
        Returns:
        payrollCalendarID
      • setPayrollCalendarID

        public void setPayrollCalendarID​(UUID payrollCalendarID)
        Xero unique identifier for payroll calendar for the employee
        Parameters:
        payrollCalendarID - UUID
      • employeeGroupName

        public Employee employeeGroupName​(String employeeGroupName)
        The Employee Group allows you to report on payroll expenses and liabilities for each group of employees
        Parameters:
        employeeGroupName - String
        Returns:
        Employee
      • getEmployeeGroupName

        public String getEmployeeGroupName()
        The Employee Group allows you to report on payroll expenses and liabilities for each group of employees
        Returns:
        employeeGroupName
      • setEmployeeGroupName

        public void setEmployeeGroupName​(String employeeGroupName)
        The Employee Group allows you to report on payroll expenses and liabilities for each group of employees
        Parameters:
        employeeGroupName - String
      • employeeID

        public Employee employeeID​(UUID employeeID)
        Xero unique identifier for an Employee
        Parameters:
        employeeID - UUID
        Returns:
        Employee
      • getEmployeeID

        public UUID getEmployeeID()
        Xero unique identifier for an Employee
        Returns:
        employeeID
      • setEmployeeID

        public void setEmployeeID​(UUID employeeID)
        Xero unique identifier for an Employee
        Parameters:
        employeeID - UUID
      • terminationDate

        public Employee terminationDate​(String terminationDate)
        Employee Termination Date (YYYY-MM-DD)
        Parameters:
        terminationDate - String
        Returns:
        Employee
      • getTerminationDate

        public String getTerminationDate()
        Employee Termination Date (YYYY-MM-DD)
        Returns:
        terminationDate
      • getTerminationDateAsDate

        public org.threeten.bp.LocalDate getTerminationDateAsDate()
        Employee Termination Date (YYYY-MM-DD)
        Returns:
        LocalDate
      • setTerminationDate

        public void setTerminationDate​(String terminationDate)
        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

        public Employee 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.
        Parameters:
        terminationReason - TerminationReasonEnum
        Returns:
        Employee
      • getTerminationReason

        public Employee.TerminationReasonEnum 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

        public void setTerminationReason​(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.
        Parameters:
        terminationReason - TerminationReasonEnum
      • bankAccounts

        public Employee bankAccounts​(List<BankAccount> bankAccounts)
        bankAccounts
        Parameters:
        bankAccounts - List<BankAccount>
        Returns:
        Employee
      • addBankAccountsItem

        public Employee addBankAccountsItem​(BankAccount bankAccountsItem)
        bankAccounts
        Parameters:
        bankAccountsItem - BankAccount
        Returns:
        Employee
      • getBankAccounts

        public List<BankAccount> getBankAccounts()
        Get bankAccounts
        Returns:
        bankAccounts
      • setBankAccounts

        public void setBankAccounts​(List<BankAccount> bankAccounts)
        bankAccounts
        Parameters:
        bankAccounts - List<BankAccount>
      • payTemplate

        public Employee payTemplate​(PayTemplate payTemplate)
        payTemplate
        Parameters:
        payTemplate - PayTemplate
        Returns:
        Employee
      • getPayTemplate

        public PayTemplate getPayTemplate()
        Get payTemplate
        Returns:
        payTemplate
      • setPayTemplate

        public void setPayTemplate​(PayTemplate payTemplate)
        payTemplate
        Parameters:
        payTemplate - PayTemplate
      • openingBalances

        public Employee openingBalances​(OpeningBalances openingBalances)
        openingBalances
        Parameters:
        openingBalances - OpeningBalances
        Returns:
        Employee
      • getOpeningBalances

        public OpeningBalances getOpeningBalances()
        Get openingBalances
        Returns:
        openingBalances
      • setOpeningBalances

        public void setOpeningBalances​(OpeningBalances openingBalances)
        openingBalances
        Parameters:
        openingBalances - OpeningBalances
      • taxDeclaration

        public Employee taxDeclaration​(TaxDeclaration taxDeclaration)
        taxDeclaration
        Parameters:
        taxDeclaration - TaxDeclaration
        Returns:
        Employee
      • getTaxDeclaration

        public TaxDeclaration getTaxDeclaration()
        Get taxDeclaration
        Returns:
        taxDeclaration
      • setTaxDeclaration

        public void setTaxDeclaration​(TaxDeclaration taxDeclaration)
        taxDeclaration
        Parameters:
        taxDeclaration - TaxDeclaration
      • leaveBalances

        public Employee leaveBalances​(List<LeaveBalance> leaveBalances)
        leaveBalances
        Parameters:
        leaveBalances - List<LeaveBalance>
        Returns:
        Employee
      • addLeaveBalancesItem

        public Employee addLeaveBalancesItem​(LeaveBalance leaveBalancesItem)
        leaveBalances
        Parameters:
        leaveBalancesItem - LeaveBalance
        Returns:
        Employee
      • getLeaveBalances

        public List<LeaveBalance> getLeaveBalances()
        Get leaveBalances
        Returns:
        leaveBalances
      • setLeaveBalances

        public void setLeaveBalances​(List<LeaveBalance> leaveBalances)
        leaveBalances
        Parameters:
        leaveBalances - List<LeaveBalance>
      • leaveLines

        public Employee leaveLines​(List<LeaveLine> leaveLines)
        leaveLines
        Parameters:
        leaveLines - List<LeaveLine>
        Returns:
        Employee
      • addLeaveLinesItem

        public Employee addLeaveLinesItem​(LeaveLine leaveLinesItem)
        leaveLines
        Parameters:
        leaveLinesItem - LeaveLine
        Returns:
        Employee
      • getLeaveLines

        public List<LeaveLine> getLeaveLines()
        Get leaveLines
        Returns:
        leaveLines
      • setLeaveLines

        public void setLeaveLines​(List<LeaveLine> leaveLines)
        leaveLines
        Parameters:
        leaveLines - List<LeaveLine>
      • superMemberships

        public Employee superMemberships​(List<SuperMembership> superMemberships)
        superMemberships
        Parameters:
        superMemberships - List<SuperMembership>
        Returns:
        Employee
      • addSuperMembershipsItem

        public Employee addSuperMembershipsItem​(SuperMembership superMembershipsItem)
        superMemberships
        Parameters:
        superMembershipsItem - SuperMembership
        Returns:
        Employee
      • getSuperMemberships

        public List<SuperMembership> getSuperMemberships()
        Get superMemberships
        Returns:
        superMemberships
      • setSuperMemberships

        public void setSuperMemberships​(List<SuperMembership> superMemberships)
        superMemberships
        Parameters:
        superMemberships - List<SuperMembership>
      • status

        public Employee status​(EmployeeStatus status)
        status
        Parameters:
        status - EmployeeStatus
        Returns:
        Employee
      • getStatus

        public EmployeeStatus getStatus()
        Get status
        Returns:
        status
      • setStatus

        public void setStatus​(EmployeeStatus status)
        status
        Parameters:
        status - EmployeeStatus
      • getUpdatedDateUTC

        public String getUpdatedDateUTC()
        Last modified timestamp
        Returns:
        updatedDateUTC
      • getUpdatedDateUTCAsDate

        public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()
        Last modified timestamp
        Returns:
        OffsetDateTime
      • validationErrors

        public Employee validationErrors​(List<ValidationError> validationErrors)
        Displays array of validation error messages from the API
        Parameters:
        validationErrors - List<ValidationError>
        Returns:
        Employee
      • addValidationErrorsItem

        public Employee addValidationErrorsItem​(ValidationError validationErrorsItem)
        Displays array of validation error messages from the API
        Parameters:
        validationErrorsItem - ValidationError
        Returns:
        Employee
      • 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>
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object