v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Time Off
Public API

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

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.