Get Employee Payroll Runs
Returns a list of EmployeePayrollRun 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
- Create an Employee Payroll Run - write earnings, deductions, and taxes for an employee into the customer’s payroll system
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 employee payroll runs to fetch
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
The ID of the employees to fetch employee payroll run for
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
The IDs of the payroll runs to fetch employee payroll run for
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
The IDs of the payroll codes to fetch employee payroll runs for. A run matches when any of its earnings, deductions or taxes carries one of these codes.
"019fbd01-e900-7418-a54c-3fcba1299e88,019fbd01-e394-76ed-93fb-b9eda49a3b41"
The third-party API ID of the matching object.
"3235005483341316245"
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