v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Payroll Runs

Get Payroll Runs

Returns a list of PayrollRun objects.

get/api/hris/v1/payroll-runs

Query parameters

idsstring nullable

The ID of the payroll runs to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the payroll runs to fetch

run_typestring

The type of the payroll run Possible values include: REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is no clear mapping, the original value passed through will be returned.

Example:REGULAR

The type of the payroll run Possible values include: REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is no clear mapping, the original value passed through will be returned.

run_statestring

The state of the payroll run Possible values include: PAID, DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, the original value passed through will be returned.

Example:PAID

The state of the payroll run Possible values include: PAID, DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, the original value passed through will be returned.

remote_idstring

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

pay_group_idstring nullable

The ID of the pay group to filter by

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the pay group to filter by

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

Number of results to return per page. Maximum size is 200.

cursorstring

The pagination cursor value.

The pagination cursor value.

modified_afterstring

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

start_date_fromstring

If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)

start_date_tostring

If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)

end_date_fromstring

If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601)

end_date_tostring

If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601)

check_date_fromstring

If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601)

check_date_tostring

If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601)

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "pay_group": "018af1fe-2fad-749e-a282-ea17ba4fc0c4",
      "run_state": "PAID",
      "run_type": "REGULAR",
      "start_date": "2020-11-08T00:00:00Z",
      "end_date": "2020-11-15T00:00:00Z",
      "check_date": "2020-11-15T00:00:00Z",
      "payroll_run_calendar": "018af1fe-2fad-749e-a282-ea17ba4fc0c4"
    }
  ]
}