Timeoff data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
user_id | string | Yes | employee ID (reference to HrisEmployee) |
company_id | string | No | (reference to HrisCompany) |
start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
is_paid | boolean | No | |
status | enum | No | Values: APPROVED, PENDING, DENIED, CANCELLED |
approver_user_id | string | No | (reference to HrisEmployee) |
approved_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
comments | string | No | |
reason | string | No | |
original_type | string | No | integration leave-type label before normalization |
type | enum | No | Values: VACATION, SICK, HOLIDAY, BEREAVEMENT, PARENTAL, UNPAID, IN_LIEU, OTHER |
duration | number | No | |
duration_type | enum | No | Values: HOUR, DAY |
attachments | HrisAttachment[] | No | supporting documents (eg. doctor's notes) attached to the leave request |
attachments[].id | string | No | |
attachments[].filename | string | No | |
attachments[].content_type | string | No | |
attachments[].size | number | No | file size in bytes |
attachments[].download_url | string | No | |
metadata | HrisMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
Are we missing anything? Let us know
Was this page helpful?