Skip to main content
GET
Get Employee Payroll Runs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Query Parameters

employee_id
string | null

The ID of the employees to fetch employee payroll run for

Example:

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

payroll_run_id
string | null

The IDs of the payroll runs to fetch employee payroll run for

Example:

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

remote_id
string

The third-party API ID of the matching object.

Example:

"3235005483341316245"

include_raw_data
boolean
default:false

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

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

page_size
integer
default:50

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

Required range: 1 <= x <= 200
cursor
string

The pagination cursor value.

modified_after
string

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"

start_date_from
string

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"

start_date_to
string

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"

end_date_from
string

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"

end_date_to
string

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"

check_date_from
string

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"

check_date_to
string

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"

expand
string

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]"

Response

Successful Response

cursor
string | null
required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size
integer
required

Indicates the count of items in the response

Example:

50

items
HrisEmployeePayrollRun · object[]
required

List of items in the current response

Example: