Get Payroll Runs
Returns a list of PayrollRun objects.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Query Parameters
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.
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.
The third-party API ID of the matching object.
Whether to include the original data Bindbee fetched from the third-party to produce these models.
Whether to include custom fields in the response.
Number of results to return per page. Maximum size is 100.
1 <= x <= 1000
The pagination cursor value.
If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601)
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.
Response
Cursor value to fetch next set of items
"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"
Indicates the count of items in the response
50
The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.