Skip to main content

Time registration

Preview
This feature is in preview. It is being refined with early feedback, so its screens and behavior may change between releases, and it may need to be switched on for your organization before it appears. See experimental features for how preview works in Dime.Scheduler.

These tools report time that has already happened. They are read-only, and there are two of them because Dime.Scheduler keeps two different records of time.

A timesheet entryTime entryA claim of a resource's time on one task for one calendar day. This is the record that is submitted to the back office, where it becomes a time sheet line. is a claim: hours a resourceResourceAn entity that can carry out work - a person, vehicle, tool, or room - that you schedule on the planning board. has booked against a taskTaskA unit of work that belongs to a job. It appears in the open task list until it is scheduled to a resource., which is what the back officeBack officeThe ERP or business system Dime.Scheduler plans for - most often Microsoft Dynamics 365 Business Central. It owns the master data and remains authoritative over what it receives. costs. A tracked sessionTime sessionAn observation that a resource was working, travelling or waiting on a task between two moments. Sessions support a time entry and never reach the back office on their own. is an observation: a timer ran between two moments. A session only counts once it is folded into an entry, which is called claimingClaimThe act of turning finished work sessions into a time entry for one task and one day. A claim can also be made directly without a session; only work sessions count, travel and waiting do not..

The practical consequence for an assistant is that "how many hours did we bill" and "what was she actually doing" are different questions with different tools, and the gap between the two answers is usually the interesting part.

Neither tool reports the schedule

Both tools describe work that already happened. For what somebody is booked to do in future, use get_resource_planning instead. Confusing the two is the most common mistake here.

Get timesheet​

Tool: get_timesheet

Returns the hours resources have claimed against tasks. Reach for this for questions about what was booked, billed or still sitting in draft.

ParameterTypeRequiredDescription
startDatestringYesFirst day of the window, inclusive, as yyyy-MM-dd
endDatestringYesDay the window ends, exclusive, as yyyy-MM-dd
resourceNostringNoExact resource number whose time to report. Omit to report every resource
statusstringNoFilter by Draft, Submitting, Accepted, Failed, Approved or Rejected, the API names of the time entry statuses
limitnumberNoMaximum number of entries to return (default: 200)

Each entry reports the resource, the date, the hours, the job and task it was booked against, whether it is billable, its status, and the message the back office returned if a release failed.

Example prompts

"How many hours did Jane book last week?"

"What did we log on job JOB-001 in March?"

"Whose timesheets are still in draft?"

Get tracked time​

Tool: get_tracked_time

Returns the raw timer sessions behind the claims: who was working on what, between which two moments.

ParameterTypeRequiredDescription
startDatestringYesFirst day of the window, inclusive, as yyyy-MM-dd. Matches the day the session started
endDatestringYesDay the window ends, exclusive, as yyyy-MM-dd
resourceNostringNoExact resource number whose sessions to report. Omit to report every resource
unclaimedOnlybooleanNoReturn only sessions that have not been folded into an entry
limitnumberNoMaximum number of sessions to return (default: 200)

unclaimedOnly is how you find work that happened but was never reported, which is the usual explanation for a timesheet that looks too thin.

Sessions carry a type: Work, Travel or Waiting. Only Work rolls up into a claim, so travel and waiting time must not be added into a billable total.

Example prompts

"What was Jane actually doing on Tuesday?"

"Is anyone's timer still running?"

"Which tracked work never made it onto a timesheet?"

Conventions​

Two conventions differ from the rest of the tool set, and both are deliberate.

Resources are identified by number, not display name. Elsewhere the tools accept a resource's display name. These two require resourceNo, the exact resource number, because time is costed data and matching the wrong person is worse than failing. If you only know a name, call search_resources first rather than guessing.

The end of the window is exclusive. To ask about a single day, pass the next day as endDate. For a Monday to Sunday week, pass the following Monday.

Session timestamps carry no time zone. startedAt and stoppedAt are on the resource's own clock. Report them exactly as given and never convert them, or an assistant will confidently shift a technician's morning by several hours.

See also​