Skip to content

Relationships

Schema relationships
graph LR
    TimesheetEntries -->|"employee"| Employees
    TimesheetEntries -->|"job_role"| JobRoles
    TimesheetEntries -->|"location"| Locations
    TimesheetEntries -->|"groups"| Groups

Properties

idstring
required·

The unique identifier for the timesheet entry

breaksobject[]

The breaks taken during this entry

end_timestring · date-time

When the break ended. Empty while the break is in progress.

is_paidboolean

Whether the break is paid

start_timestring · date-time

When the break started

created_atstring · date-time

The date and time the timesheet entry was created

employeeobject

The employee who worked the time, not the person who entered it

References: Employees → id
idstring

The unique identifier for employees

namestring

The name of the employee

end_timestring · date-time

When the time block ended, in the same format as start_time. Empty while the entry is still open, when the provider records only a duration, or when the time zone is unknown.

groupsobject[]

The groups, such as departments or cost centers, the time is attributed to

References: Groups → id
idstring

The unique identifier for groups

namestring

The name of the group

typestring

The type of the group

hours_workednumber

The number of hours worked in this entry, excluding unpaid breaks. It is the provider's own worked or payable figure when it has one, otherwise end_time minus start_time minus unpaid breaks, and it is empty while the entry is still open. Summing it across entries gives the time worked: unpaid breaks, time off and holidays count as 0 and paid breaks count their length.

job_roleobject

The job role the time was worked in

References: JobRoles → id
idstring

The unique identifier for job roles

namestring

The name of the job role

locationobject

The location where the time was worked

References: Locations → id
idstring

The unique identifier for locations

namestring

The name of the location

notesstring

The notes attached to the entry

pay_currencystring

The currency of the pay rate, as an ISO 4217 code

pay_ratenumber

The hourly pay rate applied to this entry, in major units of pay_currency (for example 15.5)

projectobject

The project the time was logged against

idstring

The unique identifier for the project

namestring

The name of the project

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_timestring · date-time

When the time block started, as an ISO 8601 date-time with an explicit offset (Z or +HH:MM). Provider local times without an offset are converted using timezone. Empty when the provider records only a duration, or when the time zone is unknown.

statusstring

The approval status of the entry. draft: not yet submitted. pending: awaiting approval. approved: approved. rejected: rejected or sent back for correction. processed: paid, exported or locked by payroll. Providers that only record an approved flag return approved when it is set, and otherwise pending for completed entries and draft for entries that are still open.

Possible values:
draftpendingapprovedrejectedprocessed
timezonestring

The IANA time zone name the time was recorded in, for example America/New_York

typestring

The kind of time recorded: regular working time, overtime, on call, a break, time off or a holiday. Providers that store breaks as separate entries return them with type break.

Possible values:
regularovertimeon_callbreaktime_offholidayother
updated_atstring · date-time

The date and time the timesheet entry was last updated

work_datestring

The local calendar date the time counts toward, in YYYY-MM-DD format: the provider's own work, business or payroll date when it has one, otherwise the date of start_time in timezone. It is never taken from the UTC date. A shift that crosses midnight counts toward the date the provider attributes it to.