Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Timer

Creates a completed timer block retroactively. Unlike the start/stop endpoints, which stamp the server time on receipt, this endpoint accepts explicit timestamps so integrations can submit a whole block of time after the fact. Blocks may not be in the future, older than 30 days, or longer than 7 days.

post/api/timers

Request body

userIdstring required

The user the timer block is attributed to.

jobIdstring required

The job identifier

itemToMakeIdstring required

The item to make identifier

operationIdstring required

The operation identifier

type'setup' | 'run' | 'clockIn' | 'break' | 'labor' | 'machine' required
startedOnUtcstring date-time required

When the block started, in UTC.

stoppedOnUtcstring date-time required

When the block stopped, in UTC. Must be after StartedOnUtc.

externalReferencesobject nullable

Arbitrary key-value data used to correlate this timer with external systems and search for it later.

Response

The created timer. When the operation already has a machine timer, a Machine block is added to that timer as a segment and the combined timer is returned.

idstring required

The timer identifier

jobIdstring nullable

The job identifier

jobNamestring nullable

The job name.

itemToMakeIdstring nullable

The item to make identifier

itemToMakeItemIdstring nullable

The item to make's original item id.

itemToMakeNamestring nullable

The item to make name.

itemToMakeDescriptionstring nullable

The item to make description.

jobOperationIdstring nullable

The job operation identifier

jobOperationNamestring nullable

The job operation name.

jobOperationDescriptionstring nullable

The job operation description.

workOrderIdstring nullable

The work order identifier. Set when the timer is tracked against a work order rather than a job.

workOrderNamestring nullable

The work order name (its number when unnamed).

workOrderOperationIdstring nullable

The work order operation identifier.

workOrderOperationNamestring nullable

The work order operation name.

startedByIdstring nullable

The user identifier who started the timer

startedOnUtcstring date-time required

When the timer was started in UTC time.

startedOnUtcOriginalstring date-time required

When the timer was ORIGINALLY started in UTC time.

stoppedOnUtcstring date-time nullable

When the timer was stopped in UTC time.

stoppedOnUtcOriginalstring date-time nullable

When the timer was ORIGINALLY stopped in UTC time.

type'setup' | 'run' | 'clockIn' | 'break' | 'labor' | 'machine' required
isRunningboolean

Whether the timer is running or not

createdUtcstring date-time required

When the timer was created in UTC time.

modifiedUtcstring date-time nullable

When the timer was modified in UTC time.

elapsedTimeInSecondsnumber double nullable

Elapsed time this timer was running. Can be greater than the labor time if the operator has multiple concurrent timers.

operationTimeInSecondsnumber double nullable

Total Operation run time If this timer was overridden, the operation time will be adjusted by the multiple of the adjustment

laborTimeInSecondsnumber double nullable

Labor time for use in costing calculations Can be less than elapsed time if an operator's time was split between jobs

machineTimeInSecondsnumber double nullable

Machine time for use in costing and time displays which is just the elapsed time of the segments If the start/stop time has been overridden directly, use that value

externalReferencesobject nullable

External references associated with this entity.