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

# Get Employee Payroll Runs By Id

`GET /api/hris/v1/employee-payroll-runs/{id}`

Returns an EmployeePayrollRun object with the given id

## Path parameters

- `id` string, uuid, required

## Query parameters

- `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.
- `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

- HrisEmployeePayrollRun — The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.
  - `id` string, uuid, required
  - `remote_id` string, nullable, required — The third-party API ID of the matching object.
  - `modified_at` string, 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.
    - number
    - integer
  - `net_pay` union, required — The take-home pay throughout a given period for an employee after deductions are made.
    - number
    - integer
  - `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.
  - `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
  - `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

## 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.
- `404` — The requested resource was not found.
- `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/7da10dc93a21/schema)