RunningTimerDto

The calling user's live timer

Properties

Name Type Description
codestring

Unique code for the timer

Unique code for the timer

userCodeAndNameDto
startedAtstring

When the timer was first started (UTC) — the start of its first block

When the timer was first started (UTC) — the start of its first block

blocksarray of TimerBlockDto

The blocks of work accrued as the timer is paused and resumed. The block
with no end time is the one currently running; none open means the timer
is paused. Elapsed working time is the sum of the blocks.

The blocks of work accrued as the timer is paused and resumed. The block
with no end time is the one currently running; none open means the timer
is paused. Elapsed working time is the sum of the blocks.

descriptionstring

What the time is being spent on

What the time is being spent on

isBillableboolean

Whether the logged time will be billable — carried onto the entry when the timer stops

Whether the logged time will be billable — carried onto the entry when the timer stops

clientClientRefDto
taskItemCodeAndNameDto
workflowStepLinkedWorkflowStepDto
timeEntryCodestring

The code of the existing time entry the timer adds to when it stops, if any.
Null means stopping the timer logs a new entry.

The code of the existing time entry the timer adds to when it stops, if any.
Null means stopping the timer logs a new entry.

JSON Example

{
  "code": "string",
  "user": {
    "code": "string",
    "name": "string"
  },
  "startedAt": "2024-01-01T00:00:00Z",
  "blocks": [
    {
      "startedAt": "...",
      "endedAt": "...",
      "minutes": "..."
    }
  ],
  "description": "string"
}

Used By Operations