v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Time Off

Public API

Create Time Off History Item

Creates a time off history item for an employee. For used type entries, a timeOffRequestId referencing an approved request is required. For override (balance adjustment) entries via the /history path, provide the amount and timeOffTypeId directly. The eventType defaults based on the URI path when omitted.

OAuth Scopes: time_off.write

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

Path parameters

employeeIdinteger required

The internal employee ID.

Request body

datestring date required

The date for the history item in YYYY-MM-DD format.

eventType'used' | 'override'

The type of history event. Defaults to used for the /history path and override for the /balance_adjustment path when omitted.

timeOffRequestIdinteger

The ID of an approved time off request. Required when eventType is used.

timeOffTypeIdinteger

The ID of the time off type. Required when eventType is override.

amountnumber

The number of hours/days to record. Required when eventType is override.

notestring

An optional note to show in history.

Response

The history item has been created.