GET
/
api
/
hris
/
v1
/
time-off-balances
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default: false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Response

200 - application/json
id
string
required
remote_id
string | null
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 | null

This is the Raw data

employee
string | null
required

The employee the balance belongs to.

balance
required

The current remaining PTO balance, always measured in terms of hours.

used
required

The amount of PTO used in terms of hours.

policy_type
string | null
required

The policy type of this time off balance