v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Employee Payroll Runs

Get Employee Payroll Runs

Returns a list of EmployeePayrollRun objects.

get/api/hris/v1/employee-payroll-runs

Query parameters

idsstring nullable

The ID of the employee payroll runs to fetch

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

The ID of the employee payroll runs to fetch

employee_idstring nullable

The ID of the employees to fetch employee payroll run for

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

The ID of the employees to fetch employee payroll run for

payroll_run_idstring nullable

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

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

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

remote_idstring

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

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"
      },
      "employee": "018b168d-70f9-7043-a796-56d66a4f8f07",
      "payroll_run": "018b709e-b6ef-7db4-902a-a064157bdba2",
      "start_date": "2023-07-01T00:00:00Z",
      "end_date": "2023-07-31T00:00:00Z",
      "check_date": "2023-08-31T00:00:00Z",
      "earnings": [
        {
          "name": "SALARY"
        }
      ],
      "deductions": [
        {
          "name": "Social Security"
        }
      ],
      "taxes": [
        {
          "name": "California State Income Tax"
        }
      ]
    }
  ]
}