Attendance data model
Also called timesheets
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) |
employee_user_id | string | Yes | (reference to HrisEmployee) |
start_at | string (date-time) | Yes | clock-in (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | Yes | clock-out (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
timeshift_id | string | No | the scheduled hris_timeshift this attendance record fulfils |
location_id | string | No | (reference to HrisLocation) |
company_id | string | No | (reference to HrisCompany) |
group_id | string | No | department, team, etc. (reference to HrisGroup) |
timezone | string | No | |
address | object | No | |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | |
address.region_code | string | No | |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | ISO 2-digit country code |
hours | number | No | worked hours |
currency | string | No | pairs with hourly_rate and tip amounts |
status | enum | No | Values: OPEN, CLOSED, APPROVED |
breaks | HrisAttendanceBreak[] | No | |
breaks[].id | string | No | |
breaks[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
breaks[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
breaks[].is_paid | boolean | No | |
breaks[].duration_minutes | number | No | |
breaks[].name | string | No | break type label, e.g. "Lunch" |
declared_tips_amount | number | No | cash tips declared by the employee for this attendance record |
non_cash_tips_amount | number | No | card/non-cash tips attributed to this attendance record |
job_name | string | No | |
hourly_rate | number | No | |
approver_user_id | string | No | (reference to HrisEmployee) |
approved_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
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?