Time Off Balance
Get Time Off Balance By Id
Time Off Balance
Get Time Off Balance By Id
Returns a TimeOffBalance object with the given id.
GET
/
api
/
hris
/
v1
/
time-off-balances
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
x-connector-token
string
requiredPath Parameters
id
string
requiredQuery Parameters
include_raw_data
boolean
default: falseWhether to include the original data Bindbee fetched from the third-party to produce these models.
Response
200 - application/json
The TimeOffBalance object is used to represent current balances for an employee's Time Off plan.
id
string
requiredremote_id
string | null
requiredThe third-party API ID of the matching object.
modified_at
string
requiredThis is the datetime that this object was last updated by Bindbee
employee
string | null
requiredThe 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
requiredThe policy type of this time off balance
raw_data
object | null
This is the Raw data