---
title: "Get Employee Payroll Runs"
method: GET
path: "/api/hris/v1/employee-payroll-runs"
tags: ["Employee Payroll Runs"]
---

# Get Employee Payroll Runs

`GET /api/hris/v1/employee-payroll-runs`

Returns a list of EmployeePayrollRun objects.

## Query parameters

- `ids` string, nullable — The ID of the employee payroll runs to fetch
- `employee_id` string, nullable — The ID of the employees to fetch employee payroll run for
- `payroll_run_id` string, nullable — The IDs of the payroll runs to fetch employee payroll run for
- `remote_id` string — The third-party API ID of the matching object.
- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — Whether to include custom fields in the response.
- `page_size` integer — Number of results to return per page. Maximum size is 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). If no timezone offset is supplied, the value is interpreted as UTC.
- `start_date_from` string — 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.
- `start_date_to` string — 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.
- `end_date_from` string — 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.
- `end_date_to` string — 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.
- `check_date_from` string — 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.
- `check_date_to` string — 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.
- `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.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- PaginatedResponseHrisEmployeePayrollRun
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` HrisEmployeePayrollRun[], required — List of items in the current response
    - `id` string, uuid, required
    - `remote_id` string, nullable, required — The third-party API ID of the matching object.
    - `modified_at` string, date-time, required — This is the datetime that this object was last updated by Bindbee
    - `raw_data` object, nullable — This is the Raw data
    - `custom_fields` object, nullable, required — The custom fields related to the model
    - `employee` string, nullable, required — The employee whose payroll is being run.
    - `payroll_run` string, nullable, required — The payroll being run.
    - `gross_pay` union, required — The total earnings throughout a given period for an employee before any deductions are made.
      - integer
      - number
    - `net_pay` union, required — The take-home pay throughout a given period for an employee after deductions are made.
      - integer
      - number
    - `start_date` string, nullable, required — The day and time the benefit started.
    - `end_date` string, nullable, required — The day and time the benefit ended.
    - `check_date` string, nullable, required — The day and time the payroll run was checked.
    - `earnings` Earning[], nullable, required — The earnings of the Employee
      - `amount` union, required — The amount earned.
        - integer
        - number
      - `name` 'SALARY' | 'REIMBURSEMENT' | 'OVERTIME' | 'BONUS' | 'HOURLY', nullable, required — The type of earning. If the value is not one of the defined enum values, the original value passed through will be returned.
      - `currency` string, nullable — The currency of the earning amount.
      - `payroll_code` string, uuid, nullable — The ID of the payroll code associated with this earning.
    - `deductions` Deduction[], nullable, required — The deductions of the Employee
      - `name` string, nullable, required — The deduction's name.
      - `employee_deduction` union, required — The amount of money that is withheld from an employee's gross pay by the employee.
        - integer
        - number
      - `company_deduction` union, required — The amount of money that is withheld on behalf of an employee by the company.
        - integer
        - number
      - `currency` string, nullable — The currency of the deduction amount.
      - `payroll_code` string, uuid, nullable — The ID of the payroll code associated with this deduction.
    - `taxes` Tax[], nullable, required — The taxes of the Employee
      - `name` string, nullable, required — The tax's name.
      - `amount` union, required — The tax amount.
        - integer
        - number
      - `currency` string, nullable — The currency of the tax amount.
      - `payroll_code` string, uuid, nullable — The ID of the payroll code associated with this tax.

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/revisions/b4bf8a66eaaa/schema)