Adjust Time Off Balance

Creates a balance adjustment for an employee's time off type. The adjustment is recorded as an override history item. Cannot adjust balances for discretionary (unlimited) time off types.

OAuth Scopes: time_off.write

put/api/v1/employees/{employeeId}/time_off/balance_adjustment

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
- HTTP basic
- or OAuth 2
  Authorization code/authorize.php
  Token URL/token.php
  Scopestime_off.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/employees/:employeeId/time_off/balance_adjustment/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

employeeIdinteger required

The internal employee ID.

Request body

datestring date required

The date the adjustment should be added in history. Should be in ISO8601 date format (YYYY-MM-DD).

timeOffTypeIdinteger required

The ID of the time off type to add a balance adjustment for.

amountnumber required

The number of hours/days to adjust the balance by.

notestring

This is an optional note to show in history.

Response

The balance adjustment has been created.

Changes

No recorded changes to this operation across all 2 revisions of this API.