Time Off (Beta)

Time-Off Balances

Beta: This endpoint is in beta and may change. Read employee time-off balances and accrual information

get/employer/time-off-balances

Query parameters

individual_idstring uuid

Filter by individual employee ID

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

Filter by policy type

Finch-API-Versionstring date required

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

Time-off balances for employees

individual_idstring uuid required

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

The type of time-off policy.

source_policy_typestring nullable required

The raw policy type as defined by the provider.

units'days' | 'hours' | 'minutes' required

The units for the time-off amount.

usedinteger nullable required

Total amount used for this policy.

totalinteger nullable required

Total amount allocated for this policy.