---
title: "Retrieve Time off Balances"
method: GET
path: "/hris/timeoffbalances/{id}"
tags: ["hris/timeoffbalances"]
---

# Retrieve Time off Balances

`GET /hris/timeoffbalances/{id}`

Retrieve Time off Balances from any connected Hris software

## Path parameters

- `id` string, required

## Query parameters

- `remote_data` boolean

## Headers

- `x-connection-token` string, required

## Response `200`

- UnifiedHrisTimeoffbalanceOutput
  - `balance` number, nullable — The current balance of time off
  - `employee_id` string, nullable — The UUID of the associated employee
  - `used` number, nullable — The amount of time off used
  - `policy_type` string, nullable — The type of time off policy
  - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora
  - `id` string, nullable — The UUID of the time off balance record
  - `remote_id` string, nullable — The remote ID of the time off balance in the context of the 3rd Party
  - `remote_data` object, nullable — The remote data of the time off balance in the context of the 3rd Party
  - `remote_created_at` string, nullable — The date when the time off balance was created in the 3rd party system
  - `created_at` string, nullable — The created date of the time off balance record
  - `modified_at` string, nullable — The last modified date of the time off balance record
  - `remote_was_deleted` boolean, nullable — Indicates if the time off balance was deleted in the remote system

## Changes

- **2024-08-27** `5ba5c769e2e1` — 6 info
  - removed the `BEREAVEMENT` enum value from the `policy_type` response property for the response status `200`
  - removed the `JURY_DUTY` enum value from the `policy_type` response property for the response status `200`
  - removed the `PERSONAL` enum value from the `policy_type` response property for the response status `200`
  - removed the `SICK` enum value from the `policy_type` response property for the response status `200`
  - …2 more
- **2024-08-13** `d5ae27a39da8` — 6 warning
  - added the new `BEREAVEMENT` enum value to the `policy_type` response property for the response status `200`
  - added the new `JURY_DUTY` enum value to the `policy_type` response property for the response status `200`
  - added the new `PERSONAL` enum value to the `policy_type` response property for the response status `200`
  - added the new `SICK` enum value to the `policy_type` response property for the response status `200`
  - …2 more
- **2024-08-13** `6c3a1da2bdc9` — 12 info
  - added the optional property `balance` 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_id` to the response with the `200` status
  - added the optional property `field_mappings` to the response with the `200` status
  - …8 more
- …earlier changes not shown

[Full history](https://skmtc.dev/panoratech/apis/panora-api/changes/hris/timeoffbalances/: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)