Get Payroll Runs
Returns a list of PayrollRun objects.
Usecases
Usecases
- Read Payroll and Match Deductions to Plans - read a payslip line by line and trace each deduction to the plan behind it
Authorizations
Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.
The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.
Query Parameters
The ID of the payroll runs to fetch
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
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. Pass several values, comma-separated, to match any of them.
"REGULAR"
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. Pass several values, comma-separated, to match any of them.
"PAID"
The third-party API ID of the matching object.
"3235005483341316245"
The ID of the pay group to filter by
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
Whether to include the original data Bindbee fetched from the third-party to produce these models.
false
Whether to include custom fields in the response.
false
Number of results to return per page. Maximum size is 200.
1 <= x <= 200The pagination cursor value.
If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.
"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). If no timezone offset is supplied, the value is interpreted as UTC.
"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). If no timezone offset is supplied, the value is interpreted as UTC.
"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). If no timezone offset is supplied, the value is interpreted as UTC.
"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). If no timezone offset is supplied, the value is interpreted as UTC.
"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). If no timezone offset is supplied, the value is interpreted as UTC.
"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). If no timezone offset is supplied, the value is interpreted as UTC.
"2024-02-21T21:22:12.993Z"
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.
"manager[first_name,last_name]"
Response
Successful Response
Cursor value to fetch next set of items
"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"
The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.
50
List of items in the current response