Package com.merge.api.resources.hris.types

Class Employee

  • public final class Employee
extends java.lang.Object

    • Method Detail

      • getId

        public java.util.Optional<java.lang.String> getId()

      • getRemoteId

        public java.util.Optional<java.lang.String> getRemoteId()
        Returns:
        The third-party API ID of the matching object.

      • getCreatedAt

        public java.util.Optional<java.time.OffsetDateTime> getCreatedAt()
        Returns:
        The datetime that this object was created by Merge.

      • getModifiedAt

        public java.util.Optional<java.time.OffsetDateTime> getModifiedAt()
        Returns:
        The datetime that this object was modified by Merge.

      • getEmployeeNumber

        public java.util.Optional<java.lang.String> getEmployeeNumber()
        Returns:
        The employee's number that appears in the third-party integration's UI.

      • getCompany

        public java.util.Optional<EmployeeCompany> getCompany()
        Returns:
        The ID of the employee's company.

      • getFirstName

        public java.util.Optional<java.lang.String> getFirstName()
        Returns:
        The employee's first name.

      • getLastName

        public java.util.Optional<java.lang.String> getLastName()
        Returns:
        The employee's last name.

      • getPreferredName

        public java.util.Optional<java.lang.String> getPreferredName()
        Returns:
        The employee's preferred first name.

      • getDisplayFullName

        public java.util.Optional<java.lang.String> getDisplayFullName()
        Returns:
        The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

      • getUsername

        public java.util.Optional<java.lang.String> getUsername()
        Returns:
        The employee's username that appears in the remote UI.

      • getGroups

        public java.util.Optional<java.util.List<java.util.Optional<EmployeeGroupsItem>>> getGroups()

      • getWorkEmail

        public java.util.Optional<java.lang.String> getWorkEmail()
        Returns:
        The employee's work email.

      • getPersonalEmail

        public java.util.Optional<java.lang.String> getPersonalEmail()
        Returns:
        The employee's personal email.

      • getMobilePhoneNumber

        public java.util.Optional<java.lang.String> getMobilePhoneNumber()
        Returns:
        The employee's mobile phone number.

      • getEmployments

        public java.util.Optional<java.util.List<java.util.Optional<EmployeeEmploymentsItem>>> getEmployments()
        Returns:
        Array of Employment IDs for this Employee.

      • getHomeLocation

        public java.util.Optional<EmployeeHomeLocation> getHomeLocation()
        Returns:
        The employee's home address.

      • getWorkLocation

        public java.util.Optional<EmployeeWorkLocation> getWorkLocation()
        Returns:
        The employee's work address.

      • getManager

        public java.util.Optional<EmployeeManager> getManager()
        Returns:
        The employee ID of the employee's manager.

      • getTeam

        public java.util.Optional<EmployeeTeam> getTeam()
        Returns:
        The employee's team.

      • getPayGroup

        public java.util.Optional<EmployeePayGroup> getPayGroup()
        Returns:
        The employee's pay group

      • getSsn

        public java.util.Optional<java.lang.String> getSsn()
        Returns:
        The employee's social security number.

      • getGender

        public java.util.Optional<EmployeeGender> getGender()
        Returns:
        The employee's gender.
        • MALE - MALE
        • FEMALE - FEMALE
        • NON-BINARY - NON-BINARY
        • OTHER - OTHER
        • PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

      • getEthnicity

        public java.util.Optional<EmployeeEthnicity> getEthnicity()
        Returns:
        The employee's ethnicity.
        • AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
        • ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
        • BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
        • HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
        • NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
        • TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
        • WHITE - WHITE
        • PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

      • getMaritalStatus

        public java.util.Optional<EmployeeMaritalStatus> getMaritalStatus()
        Returns:
        The employee's filing status as related to marital status.
        • SINGLE - SINGLE
        • MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
        • MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
        • HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
        • QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

      • getDateOfBirth

        public java.util.Optional<java.time.OffsetDateTime> getDateOfBirth()
        Returns:
        The employee's date of birth.

      • getHireDate

        public java.util.Optional<java.time.OffsetDateTime> getHireDate()
        Returns:
        The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.

      • getStartDate

        public java.util.Optional<java.time.OffsetDateTime> getStartDate()
        Returns:
        The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

      • getRemoteCreatedAt

        public java.util.Optional<java.time.OffsetDateTime> getRemoteCreatedAt()
        Returns:
        When the third party's employee was created.

      • getEmploymentStatus

        public java.util.Optional<EmployeeEmploymentStatus> getEmploymentStatus()
        Returns:
        The employment status of the employee.
        • ACTIVE - ACTIVE
        • PENDING - PENDING
        • INACTIVE - INACTIVE

      • getTerminationDate

        public java.util.Optional<java.time.OffsetDateTime> getTerminationDate()
        Returns:
        The employee's termination date.

      • getAvatar

        public java.util.Optional<java.lang.String> getAvatar()
        Returns:
        The URL of the employee's avatar image.

      • getCustomFields

        public java.util.Optional<java.util.Map<java.lang.String,​com.fasterxml.jackson.databind.JsonNode>> getCustomFields()
        Returns:
        Custom fields configured for a given model.

      • getRemoteWasDeleted

        public java.util.Optional<java.lang.Boolean> getRemoteWasDeleted()
        Returns:
        Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

      • getFieldMappings

        public java.util.Optional<java.util.Map<java.lang.String,​com.fasterxml.jackson.databind.JsonNode>> getFieldMappings()

      • getRemoteData

        public java.util.Optional<java.util.List<RemoteData>> getRemoteData()

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object