DAdailypay
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

Request

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.

Example response

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributes": {
        "pay_period_ends_at": "2023-03-15T04:00:00Z",
        "pay_period_starts_at": "2023-03-15T04:00:00Z",
        "deposit_expected_at": "2023-03-15T04:00:00Z",
        "currency": "USD"
      },
      "links": {
        "self": "https://api.dailypay.com/rest/paychecks/f4e2fd6c-b567-447c-a003-b7315b8d22d2"
      },
      "relationships": {
        "person": {
          "data": {
            "type": "people",
            "id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
          }
        },
        "job": {
          "data": {
            "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.