Skip to main content
A time report is an individual record that describes a period of absence or attendance for a specific employee. Unlike entity properties in the Employee model, time reports are not date-tracked - each record is a discrete event with its own date range.

Fields

FieldTypeRequiredDescription
idUUIDYesTwine-internal identifier
org_idUUIDYesOrganisation identifier
employee_idUUIDYesThe employee this record belongs to
start_datedateYesInclusive start date of the record
end_datedateYesInclusive end date of the record
source_external_time_type_idstringYesThe time type identifier from the source system
source_system_slugstringYesIdentifies which system the record originated from
request_statusenumNoApproval state - see below
minutesinteger[]NoDuration in minutes, one entry per workday within the date range
extentnumber[]NoDuration as a fraction of the workday, one entry per workday. Not available for all systems.
from_timestringNoClock start time (HH:MM). Not available for all systems.
to_timestringNoClock end time (HH:MM). Not available for all systems.
commentstringNoFree-text comment
child_idstringNoRemote identifier of the child for child-related leave types. Not available for all systems.
child_namestringNoName of the child for child-related leave types. Not available for all systems.
inserted_atdatetimeYesTimestamp of when the record was created in Twine

Request status

ValueDescription
approvedThe request has been approved
requestedSubmitted and awaiting approval
pendingPending action
rejectedThe request was rejected
cancelledThe request was cancelled
unknownThe status could not be determined from the source system

Time types

Every time report references a time type that describes what kind of absence or attendance is being recorded - vacation, sick leave, parental leave, and so on. Time types can be sourced from the external system or defined locally within Twine. Each time type has a name, an optional code, and an optional external identifier. Its behaviour is described by a set of traits:
TraitTypeDescription
unitenumThe unit in which this type is reported: day, hour, or minute
enabledbooleanWhether this time type is currently active
must_be_full_daybooleanWhen unit is not day, whether records must still span full days. Not available for all systems.
comment_as_child_namebooleanWhether the comment field should be treated as a child’s name, used for parental leave reporting in some systems.