---
title: "Retrieve Payroll Run"
method: GET
path: "/hris/payrollruns/{id}"
tags: ["hris/payrollruns"]
---

# Retrieve Payroll Run

`GET /hris/payrollruns/{id}`

Retrieve a Payroll Run from any connected Hris software

## Path parameters

- `id` string, required

## Query parameters

- `remote_data` boolean

## Headers

- `x-connection-token` string, required

## Response `200`

- UnifiedHrisPayrollrunOutput
  - `run_state` string, nullable — The state of the payroll run
  - `run_type` string, nullable — The type of the payroll run
  - `start_date` string, date-time, nullable — The start date of the payroll run
  - `end_date` string, date-time, nullable — The end date of the payroll run
  - `check_date` string, date-time, nullable — The check date of the payroll run
  - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora
  - `id` string, nullable — The UUID of the payroll run record
  - `remote_id` string, nullable — The remote ID of the payroll run in the context of the 3rd Party
  - `remote_data` object, nullable — The remote data of the payroll run in the context of the 3rd Party
  - `remote_created_at` string, date-time, nullable — The date when the payroll run was created in the 3rd party system
  - `created_at` string, date-time, nullable — The created date of the payroll run record
  - `modified_at` string, date-time, nullable — The last modified date of the payroll run record
  - `remote_was_deleted` boolean, nullable — Indicates if the payroll run was deleted in the remote system
  - `employee_payroll_runs` string[], nullable — The UUIDs of the employee payroll runs associated with this payroll run

## Changes

- **2024-08-27** `5ba5c769e2e1` — 10 info
  - removed the `APPROVED` enum value from the `run_state` response property for the response status `200`
  - removed the `CLOSE` enum value from the `run_state` response property for the response status `200`
  - removed the `CORRECTION` enum value from the `run_type` response property for the response status `200`
  - removed the `DRAFT` enum value from the `run_state` response property for the response status `200`
  - …6 more
- **2024-08-13** `d5ae27a39da8` — 10 warning
  - added the new `APPROVED` enum value to the `run_state` response property for the response status `200`
  - added the new `CLOSE` enum value to the `run_state` response property for the response status `200`
  - added the new `CORRECTION` enum value to the `run_type` response property for the response status `200`
  - added the new `DRAFT` enum value to the `run_state` response property for the response status `200`
  - …6 more
- **2024-08-13** `6c3a1da2bdc9` — 14 info
  - added the optional property `check_date` to the response with the `200` status
  - added the optional property `created_at` to the response with the `200` status
  - added the optional property `employee_payroll_runs` to the response with the `200` status
  - added the optional property `end_date` to the response with the `200` status
  - …10 more
- …earlier changes not shown

[Full history](https://skmtc.dev/panoratech/apis/panora-api/changes/hris/payrollruns/:id/get.md)

---

[API](https://skmtc.dev/panoratech/apis/panora-api.md) · [All operations](https://skmtc.dev/panoratech/apis/panora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/panoratech/apis/panora-api/revisions/634ca9b624aa?raw)
