API Docs / Schemas / StartRunningTimerRequest

StartRunningTimerRequest

Request to start the calling user's timer, or update the details of the one
already running (the start time is preserved on update)

Properties

Name Type Description
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

clientCodestring

The code of the client the time relates to (optional)

The code of the client the time relates to (optional)

taskItemCodestring

The code of the task the time relates to (optional)

The code of the task the time relates to (optional)

workflowGroupNumberinteger

The group number of the workflow step the time relates to (optional; requires
TaskItemCode and WorkflowStepNumber) — carried onto the entry when the timer stops

The group number of the workflow step the time relates to (optional; requires
TaskItemCode and WorkflowStepNumber) — carried onto the entry when the timer stops

workflowStepNumberinteger

The step number of the workflow step the time relates to (optional; requires
TaskItemCode and WorkflowGroupNumber) — carried onto the entry when the timer stops

The step number of the workflow step the time relates to (optional; requires
TaskItemCode and WorkflowGroupNumber) — carried onto the entry when the timer stops

JSON Example

{
  "description": "string",
  "isBillable": false,
  "clientCode": "string",
  "taskItemCode": "string",
  "workflowGroupNumber": 0
}

Used By Operations