DocumentationAPI Reference
API Reference

Get Time Off Balance

get
https://{companyDomain}.bamboohr.com/api/v1/employees//time_off/calculator

Returns time off balances for an employee across all assigned categories as of a given date. Each category's balance is calculated by summing all historical balance events (accruals, manual adjustments, used time off, and carry-over events) plus any future accruals and adjustments up to the specified date. To get current balances, pass today's date; to project future balances, pass a future date. Response defaults to XML unless Accept: application/json is provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the employee to get time off balances for.

Query Params
date

The date to calculate the time off balance as of, in YYYY-MM-DD format. Defaults to company today if not provided. Example: use a future date to project balance.

integer
0 to 4
Defaults to 2

Number of decimal places for balance and usedYearToDate values. Minimum 0, maximum 4. Defaults to 2.

Headers
string
enum

This endpoint can produce either JSON or XML.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized. Invalid API credentials.

Updated 3 days ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago