List Employee Time Off Balances

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/time_off_balances \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "employee_id": "cx280928937",
      "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "policy_id": "cx280928937",
      "remote_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "policy": {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Holidays",
        "description": "Usable for regional and national holidays of employees.",
        "type": {
          "value": "holiday",
          "source_value": "<string>"
        },
        "duration_unit": {
          "value": "hours",
          "source_value": "<string>"
        },
        "reasons": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "<string>"
          }
        ],
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      },
      "current_balance": 8,
      "initial_balance": 8,
      "balance_unit": "hours",
      "balance_start_date": "2021-01-01T01:01:01.000Z",
      "balance_expiry_date": "2021-01-01T01:01:01.000Z",
      "is_unlimited": true,
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

hris

employees

{id}

time_off_balances

List Employee Time Off Balances

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/time_off_balances \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "employee_id": "cx280928937",
      "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "policy_id": "cx280928937",
      "remote_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "policy": {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Holidays",
        "description": "Usable for regional and national holidays of employees.",
        "type": {
          "value": "holiday",
          "source_value": "<string>"
        },
        "duration_unit": {
          "value": "hours",
          "source_value": "<string>"
        },
        "reasons": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "<string>"
          }
        ],
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      },
      "current_balance": 8,
      "initial_balance": 8,
      "balance_unit": "hours",
      "balance_start_date": "2021-01-01T01:01:01.000Z",
      "balance_expiry_date": "2021-01-01T01:01:01.000Z",
      "is_unlimited": true,
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields"

filter

object

HRIS Time Off Balance filters

Show child attributes

filter[updated_after]

string<date-time> | null

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

filter[policy_ids]

string[] | null

List of policy ids to filter time off balances by.

page

string | null

The page number of the results to fetch

page_size

string | null

The number of results per page (default value is 25)

string | null

The unified cursor

updated_after

string<date-time> | null

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

expand

string | null

The comma separated list of fields that will be expanded in the response

Example:

"policy"

Response

The list of time off balances of the employee with the given identifier was retrieved.

data

object[]

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employee_id

string | null

The employee id associated with this balance

Example:

"cx280928937"

data.remote_employee_id

string | null

Provider's unique identifier of the employee associated with this balance

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.policy_id

string | null

The time off policy id associated with this balance

Example:

"cx280928937"

data.remote_policy_id

string | null

Provider's unique identifier of the time off policy id associated with this balance

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.policy

object

The time off policy associated with this balance

Show child attributes

data.policy.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.policy.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.policy.name

string | null

The name of this policy

Example:

"Holidays"

data.policy.description

string | null

The description of this policy

Example:

"Usable for regional and national holidays of employees."

data.policy.type

object

The type of this policy

Show child attributes

data.policy.type.value

enum<string> | null

The unified value for the type of the time off policy. If the provider does not specify this unit, the value will be set to unmapped_value

Available options:

sick,

unmapped_value,

vacation,

long_term_disability,

short_term_disability,

absent,

comp_time,

training,

annual_leave,

leave_of_absence,

break,

child_care_leave,

maternity_leave,

jury_duty,

sabbatical,

accident,

paid,

unpaid,

holiday,

personal,

in_lieu,

bereavement,

other,

Example:

"holiday"

data.policy.type.source_value

data.policy.duration_unit

object

The duration unit of the current policy

Show child attributes

data.policy.duration_unit.value

enum<string> | null

The unified value for the duration unit. If the provider does not specify this unit, the value will be set to unknown

Available options:

minutes,

hours,

days,

weeks,

months,

years,

unknown,

unmapped_value,

Example:

"hours"

data.policy.duration_unit.source_value

data.policy.reasons

object[] | null

Show child attributes

data.policy.reasons.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.policy.reasons.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.policy.reasons.name

string | null

data.policy.created_at

string<date-time> | null

The created_at date of this policy

Example:

"2021-01-01T01:01:01.000Z"

data.policy.updated_at

string<date-time> | null

The updated_at date of this policy

Example:

"2021-01-01T01:01:01.000Z"

data.current_balance

number | null

The current numeric balance for the associated employee and time off policy

Example:

8

data.initial_balance

number | null

The initial numeric balance for the associated employee and time off policy as of the balance start date

Example:

8

data.balance_unit

object

The duration unit of the current balance

Show child attributes

data.balance_unit.value

enum<string> | null

The unified value for the duration unit. If the provider does not specify this unit, the value will be set to unknown

Available options:

minutes,

hours,

days,

weeks,

months,

years,

unknown,

unmapped_value,

Example:

"hours"

data.balance_unit.source_value

Example:

"hours"

data.balance_start_date

string<date-time> | null

The date of when the initial balance quantity was set

Example:

"2021-01-01T01:01:01.000Z"

data.balance_expiry_date

string<date-time> | null

The date of when the current balance expires

Example:

"2021-01-01T01:01:01.000Z"

data.is_unlimited

Indicates if this time off balance represents unlimited leave

Example:

true

data.updated_at

string<date-time> | null

The updated_at date of this time off balance

Example:

"2021-01-01T01:01:01.000Z"

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Update Employee Work Eligibility Request Get Employee Time Off Balance

⌘I

Getting Started

Use Cases

API Reference

List Employee Time Off Balances

Authorizations

Headers

Path Parameters

Query Parameters

Response