Sign in
Time Off (Beta)

Create Time-Off Event

Beta: This endpoint is in beta and may change. Create a new time-off request or event

post/employer/time-off-events

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Request body

individual_idstring uuid required

A stable Finch id (UUID v4) for an individual in the company.

reviewer_idstring uuid nullable

The ID of the employee who reviewed/approved this request.

status'requested' | 'approved' | 'declined' | 'cancelled' | 'deleted' required

The status of the time-off request.

policy_type'pto' | 'sick' | 'parental' | 'unpaid' | 'other' | 'null' nullable

The type of time-off policy.

event_type'vacation' | 'sick' | 'personal' | 'jury_duty' | 'volunteer' | 'bereavement' | 'other' required

The specific type of time-off event.

start_datestring date-time nullable required

ISO 8601 datetime format (YYYY-MM-DDTHH:MM:SS). Default timestamps for start_date and end_date are 00:00:00 (beginning of day) and 23:59:59 (end of day), respectively. Note: Datetime values are represented in the timezone they are reflected in the provider.

end_datestring date-time nullable required

ISO 8601 datetime format (YYYY-MM-DDTHH:MM:SS). Default timestamps for start_date and end_date are 00:00:00 (beginning of day) and 23:59:59 (end of day), respectively. Note: Datetime values are represented in the timezone they are reflected in the provider.

Response

Time-off event creation initiated

time_off_event_idstring uuid required

The id of the time-off event.

job_idstring uuid required

Changes