List Employee Time Off Balances

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

id

string

required

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

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,updated_at"

filter

object | null

HRIS Time Off Balance filters

Show child attributes

filter.updated_after

string | 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

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

next

string | null

The unified cursor

updated_after

string | null

deprecated

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

200

application/json

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:

paid,

unpaid,

holiday,

vacation,

sick,

personal,

in_lieu,

bereavement,

jury_duty,

unmapped_value

Example:

"holiday"

data.policy.type.source_value

Example:

"holiday"

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

Example:

"hours"

data.policy.duration_unit.source_value

Example:

"hours"

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 | null

The created_at date of this policy

Example:

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

data.policy.updated_at

string | 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

Example:

"hours"

data.balance_unit.source_value

Example:

"hours"

data.balance_start_date

string | null

The date of when the initial balance quantity was set

Example:

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

data.balance_expiry_date

string | null

The date of when the current balance expires

Example:

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

data.updated_at

string | null

The updated_at date of this time off balance

Example:

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

next

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

string | null

raw.response

object | null