hris
timeoff

Update a timeoff

Changed on
patch/hris/{connection_id}/timeoff/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/timeoff/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Timeoff

Query parameters

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

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring required

employee ID (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_paidboolean
status'APPROVED' | 'PENDING' | 'DENIED' | 'CANCELLED'
approver_user_idstring

(reference to HrisEmployee)

approved_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

commentsstring
reasonstring
original_typestring

integration leave-type label before normalization

type'VACATION' | 'SICK' | 'HOLIDAY' | 'BEREAVEMENT' | 'PARENTAL' | 'UNPAID' | 'IN_LIEU' | 'OTHER'
durationnumber
duration_type'HOUR' | 'DAY'
rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring required

employee ID (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_paidboolean
status'APPROVED' | 'PENDING' | 'DENIED' | 'CANCELLED'
approver_user_idstring

(reference to HrisEmployee)

approved_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

commentsstring
reasonstring
original_typestring

integration leave-type label before normalization

type'VACATION' | 'SICK' | 'HOLIDAY' | 'BEREAVEMENT' | 'PARENTAL' | 'UNPAID' | 'IN_LIEU' | 'OTHER'
durationnumber
duration_type'HOUR' | 'DAY'
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 88010aaae74eRevision changes
    • info

      added the new optional request property

    • info

      added the enum value original_type to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status