Create a timeoff

Updated:

POST/hris/{connection_id}/timeoff

Creates a HrisTimeoff. Provide the unified HrisTimeoff fields in the request body; they are mapped to the provider's API. Returns the created HrisTimeoff.

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstring required
employee ID (reference to HrisEmployee)
company_idstring
(reference to HrisCompany)
start_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_paidboolean
status enum
Valid values:
"APPROVED"
"PENDING"
"DENIED"
"CANCELLED"
approver_user_idstring
(reference to HrisEmployee)
approved_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
commentsstring
reasonstring
original_typestring
integration leave-type label before normalization
type enum
Valid values:
"VACATION"
"SICK"
"HOLIDAY"
"BEREAVEMENT"
"PARENTAL"
durationnumber
duration_type enum
Valid values:
"HOUR"
"DAY"
attachments array
supporting documents (eg. doctor's notes) attached to the leave request
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringYesemployee ID (reference to HrisEmployee)
company_idstringNo(reference to HrisCompany)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_paidbooleanNo
statusenumNoValues: APPROVED, PENDING, DENIED, CANCELLED
approver_user_idstringNo(reference to HrisEmployee)
approved_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
commentsstringNo
reasonstringNo
original_typestringNointegration leave-type label before normalization
typeenumNoValues: VACATION, SICK, HOLIDAY, BEREAVEMENT, PARENTAL, UNPAID, IN_LIEU, OTHER
durationnumberNo
duration_typeenumNoValues: HOUR, DAY
attachmentsHrisAttachment[]Nosupporting documents (eg. doctor's notes) attached to the leave request
attachments[].idstringNo
attachments[].filenamestringNo
attachments[].content_typestringNo
attachments[].sizenumberNofile size in bytes
attachments[].download_urlstringNo
metadataHrisMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe 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[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo
metadata[].slugstringNoThe 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.

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/timeoff',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?