Create an attendance

POST/hris/{connection_id}/attendance

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

Also called timesheets

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
employee_user_idstring required
(reference to HrisEmployee)
start_atdate-time required
clock-in (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time required
clock-out (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
timeshift_idstring
the scheduled hris_timeshift this attendance record fulfils
location_idstring
(reference to HrisLocation)
company_idstring
(reference to HrisCompany)
group_idstring
department, team, etc. (reference to HrisGroup)
timezonestring
addressobject
hoursnumber
worked hours
currencystring
pairs with hourly_rate and tip amounts
status enum
Valid values:
"OPEN"
"CLOSED"
"APPROVED"
breaks array
declared_tips_amountnumber
cash tips declared by the employee for this attendance record
non_cash_tips_amountnumber
card/non-cash tips attributed to this attendance record
job_namestring
hourly_ratenumber
approver_user_idstring
(reference to HrisEmployee)
approved_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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)
employee_user_idstringYes(reference to HrisEmployee)
start_atstring (date-time)Yesclock-in (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)Yesclock-out (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
timeshift_idstringNothe scheduled hris_timeshift this attendance record fulfils
location_idstringNo(reference to HrisLocation)
company_idstringNo(reference to HrisCompany)
group_idstringNodepartment, team, etc. (reference to HrisGroup)
timezonestringNo
addressobjectNo
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNoISO 2-digit country code
hoursnumberNoworked hours
currencystringNopairs with hourly_rate and tip amounts
statusenumNoValues: OPEN, CLOSED, APPROVED
breaksHrisAttendanceBreak[]No
breaks[].idstringNo
breaks[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
breaks[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
breaks[].is_paidbooleanNo
breaks[].duration_minutesnumberNo
breaks[].namestringNobreak type label, e.g. "Lunch"
declared_tips_amountnumberNocash tips declared by the employee for this attendance record
non_cash_tips_amountnumberNocard/non-cash tips attributed to this attendance record
job_namestringNo
hourly_ratenumberNo
approver_user_idstringNo(reference to HrisEmployee)
approved_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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/attendance',
  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?