v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
hris
timeoff

List all timeoffs

get/hris/{connection_id}/timeoff

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

company_idstring

The company ID to filter by (reference to HrisCompany)

typestring
start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
user_idstring required
company_idstring
start_atstring date-time
end_atstring date-time
is_paidboolean
status'APPROVED' | 'PENDING' | 'DENIED' | 'CANCELLED'
approver_user_idstring
approved_atstring date-time
commentsstring
reasonstring
type'VACATION' | 'SICK' | 'HOLIDAY' | 'BEREAVEMENT' | 'PARENTAL' | 'UNPAID' | 'IN_LIEU' | 'OTHER'
durationnumber
duration_type'HOUR' | 'DAY'
rawobject