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

Class PayrollRunsListRequest

  • public final class PayrollRunsListRequest
extends java.lang.Object

    • Method Detail

      • 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.

      • getEndedAfter

        public java.util.Optional<java.time.OffsetDateTime> getEndedAfter()
        Returns:
        If provided, will only return payroll runs ended after this datetime.

      • getEndedBefore

        public java.util.Optional<java.time.OffsetDateTime> getEndedBefore()
        Returns:
        If provided, will only return payroll runs ended before this datetime.

      • 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.

      • 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).

      • 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.

      • getRemoteId

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

      • getRunType

        public java.util.Optional<PayrollRunsListRequestRunType> getRunType()
        Returns:
        If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
        • REGULAR - REGULAR
        • OFF_CYCLE - OFF_CYCLE
        • CORRECTION - CORRECTION
        • TERMINATION - TERMINATION
        • SIGN_ON_BONUS - SIGN_ON_BONUS

      • getShowEnumOrigins

        public java.util.Optional<PayrollRunsListRequestShowEnumOrigins> 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 payroll runs started after this datetime.

      • getStartedBefore

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

      • 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