Package com.merge.api.resources.hris.employees.requests

Class EmployeesListRequest

  • public final class EmployeesListRequest
extends java.lang.Object

    • Method Detail

      • getCompanyId

        public java.util.Optional<java.lang.String> getCompanyId()
        Returns:
        If provided, will only return employees for this company.

      • getCreatedAfter

        public java.util.Optional<java.time.OffsetDateTime> getCreatedAfter()
        Returns:
        If provided, will only return objects created after this datetime.

      • getCreatedBefore

        public java.util.Optional<java.time.OffsetDateTime> getCreatedBefore()
        Returns:
        If provided, will only return objects created before this datetime.

      • getCursor

        public java.util.Optional<java.lang.String> getCursor()
        Returns:
        The pagination cursor value.

      • getDisplayFullName

        public java.util.Optional<java.lang.String> getDisplayFullName()
        Returns:
        If provided, will only return employees with this display name.

      • getEmploymentStatus

        public java.util.Optional<EmployeesListRequestEmploymentStatus> getEmploymentStatus()
        Returns:
        If provided, will only return employees with this employment status.
        • ACTIVE - ACTIVE
        • PENDING - PENDING
        • INACTIVE - INACTIVE

      • getEmploymentType

        public java.util.Optional<java.lang.String> getEmploymentType()
        Returns:
        If provided, will only return employees that have an employment of the specified employment_type.

      • getExpand

        public java.util.Optional<EmployeesListRequestExpand> getExpand()
        Returns:
        Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

      • getFirstName

        public java.util.Optional<java.lang.String> getFirstName()
        Returns:
        If provided, will only return employees with this first name.

      • getGroups

        public java.util.Optional<java.lang.String> getGroups()
        Returns:
        If provided, will only return employees matching the group ids; multiple groups can be separated by commas.

      • getHomeLocationId

        public java.util.Optional<java.lang.String> getHomeLocationId()
        Returns:
        If provided, will only return employees for this home location.

      • getIncludeDeletedData

        public java.util.Optional<java.lang.Boolean> getIncludeDeletedData()
        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.

      • getIncludeRemoteData

        public java.util.Optional<java.lang.Boolean> getIncludeRemoteData()
        Returns:
        Whether to include the original data Merge fetched from the third-party to produce these models.

      • getIncludeSensitiveFields

        public java.util.Optional<java.lang.Boolean> getIncludeSensitiveFields()
        Returns:
        Whether to include sensitive fields (such as social security numbers) in the response.

      • getIncludeShellData

        public java.util.Optional<java.lang.Boolean> getIncludeShellData()
        Returns:
        Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

      • getJobTitle

        public java.util.Optional<java.lang.String> getJobTitle()
        Returns:
        If provided, will only return employees that have an employment of the specified job_title.

      • getLastName

        public java.util.Optional<java.lang.String> getLastName()
        Returns:
        If provided, will only return employees with this last name.

      • getManagerId

        public java.util.Optional<java.lang.String> getManagerId()
        Returns:
        If provided, will only return employees for this manager.

      • getModifiedAfter

        public java.util.Optional<java.time.OffsetDateTime> getModifiedAfter()
        Returns:
        If provided, only objects synced by Merge after this date time will be returned.

      • getModifiedBefore

        public java.util.Optional<java.time.OffsetDateTime> getModifiedBefore()
        Returns:
        If provided, only objects synced by Merge before this date time will be returned.

      • getPageSize

        public java.util.Optional<java.lang.Integer> getPageSize()
        Returns:
        Number of results to return per page.

      • getPayGroupId

        public java.util.Optional<java.lang.String> getPayGroupId()
        Returns:
        If provided, will only return employees for this pay group

      • getPersonalEmail

        public java.util.Optional<java.lang.String> getPersonalEmail()
        Returns:
        If provided, will only return Employees with this personal email

      • getRemoteId

        public java.util.Optional<java.lang.String> getRemoteId()
        Returns:
        The API provider's ID for the given object.

      • getShowEnumOrigins

        public java.util.Optional<EmployeesListRequestShowEnumOrigins> getShowEnumOrigins()
        Returns:
        A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

      • getStartedAfter

        public java.util.Optional<java.time.OffsetDateTime> getStartedAfter()
        Returns:
        If provided, will only return employees that started after this datetime.

      • getStartedBefore

        public java.util.Optional<java.time.OffsetDateTime> getStartedBefore()
        Returns:
        If provided, will only return employees that started before this datetime.

      • getTeamId

        public java.util.Optional<java.lang.String> getTeamId()
        Returns:
        If provided, will only return employees for this team.

      • getTerminatedAfter

        public java.util.Optional<java.time.OffsetDateTime> getTerminatedAfter()
        Returns:
        If provided, will only return employees that were terminated after this datetime.

      • getTerminatedBefore

        public java.util.Optional<java.time.OffsetDateTime> getTerminatedBefore()
        Returns:
        If provided, will only return employees that were terminated before this datetime.

      • getWorkEmail

        public java.util.Optional<java.lang.String> getWorkEmail()
        Returns:
        If provided, will only return Employees with this work email

      • getWorkLocationId

        public java.util.Optional<java.lang.String> getWorkLocationId()
        Returns:
        If provided, will only return employees for this location.

      • 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