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

Authorizations

Authorization
string
header
required

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.

include_custom_fields
boolean
default:
false

Whether to include custom fields in the response.

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

200 - application/json

The TimeOffBalance object is used to represent current balances for an employee's Time Off plan.

balance
required

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

custom_fields
object | null
required

The custom fields related to the model

employee
any | null
required

The employee the balance belongs to.

id
string
required
modified_at
string
required

This is the datetime that this object was last updated by Bindbee

policy_type
string | null
required

The policy type of this time off balance

remote_id
string | null
required

The third-party API ID of the matching object.

used
required

The amount of PTO used in terms of hours.

raw_data
object | null

This is the Raw data