Sign in

v1

latestOpenAPI 3.1.02026-08-061895260.0 KB
Paychecks

Get a list of paycheck objects

Returns a collection of paycheck objects. This object details a person's pay and pay period.

get/rest/paychecks

Query parameters

filter[job.id]string uuid
Example:e9d84b0d-92ba-43c9-93bf-7c993313fa6f

Limit the results to documents related to a specific job

filter[status]'ESTIMATED' | 'PROCESSING' | 'IN_TRANSIT' | 'DEPOSITED'
Example:DEPOSITED

Limit the results to paychecks with the specified status

filter[deposit_expected_at__gte]string date-time
Example:2023-03-15T04:00:00Z

Limit the results to paychecks with deposit_expected_at greater than or equal to the specified date

filter[deposit_expected_at__lt]string date-time
Example:2023-03-15T04:00:00Z

Limit the results to paychecks with deposit_expected_at less than the specified date

filter[pay_period_ends_at__gte]string date-time
Example:2023-03-15T04:00:00Z

Limit the results to paychecks with pay_period_ends_at greater than or equal to the specified date

filter[pay_period_ends_at__lt]string date-time
Example:2023-03-15T04:00:00Z

Limit the results to paychecks with pay_period_ends_at less than the specified date

filter[pay_period_starts_at__gte]string date-time
Example:2023-03-15T04:00:00Z

Limit the results to paychecks with pay_period_starts_at greater than or equal to the specified date

filter[pay_period_starts_at__lt]string date-time
Example:2023-03-15T04:00:00Z

Limit the results to paychecks with pay_period_starts_at less than the specified date

filterstring

Response

Returns the paycheck object.