Skip to main content
GET
Get Time Off Balance By 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<uuid>
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.

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

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

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string
required

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

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
employee
any | null
required

The employee the balance belongs to.

Example:

"018b48d5-79f8-7deb-8813-3e47b375067e"

balance
required

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

Example:

12

used
required

The amount of PTO used in terms of hours.

Example:

7

policy_type
enum<string>
required

The policy type of this time off balance. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
VACATION,
SICK,
PERSONAL,
JURY_DUTY,
VOLUNTEER,
BEREAVEMENT,
MATERNITY,
ANNUAL_LEAVE,
EMERGENCY_LEAVE,
LEAVE_OF_ABSENCE,
PATERNITY,
PAID_TIME_OFF,
LONG_TERM_DISABILITY,
SHORT_TERM_DISABILITY,
COMP_OFF,
WORK_FROM_HOME,
COMPASSIONATE,
TIME_OFF,
FMLA
Example:

"VACATION"

raw_data
Raw Data · object | null

This is the Raw data

Example: