API Docs / Schemas / TimeEntryDto

TimeEntryDto

A recorded block of time worked by a team member

Properties

Name Type Description
codestring

Unique code for the time entry

Unique code for the time entry

userCodeAndNameDto
entryDatestring

The day the work was done (format: yyyy-MM-dd)

The day the work was done (format: yyyy-MM-dd)

durationMinutesinteger

How long the work took, in minutes

How long the work took, in minutes

startTimestring

When the work started (UTC) — populated for timer-logged entries, optional otherwise

When the work started (UTC) — populated for timer-logged entries, optional otherwise

endTimestring

When the work ended (UTC) — populated for timer-logged entries, optional otherwise

When the work ended (UTC) — populated for timer-logged entries, optional otherwise

blocksarray of TimerBlockDto

The work blocks the entry was logged from, for timer-logged entries; empty for
manual entries. When present, StartTime, EndTime and DurationMinutes are derived
from the blocks (span start, span end, summed working time) and are read-only —
the summed duration can be less than the span when the timer was paused.

The work blocks the entry was logged from, for timer-logged entries; empty for
manual entries. When present, StartTime, EndTime and DurationMinutes are derived
from the blocks (span start, span end, summed working time) and are read-only —
the summed duration can be less than the span when the timer was paused.

descriptionstring

What the time was spent on

What the time was spent on

clientCodeAndNameDto
taskItemCodeAndNameDto
workflowStepLinkedWorkflowStepDto
serviceCodeAndNameDto
isBillableboolean

Whether this time can be billed to the client

Whether this time can be billed to the client

hourlyRatenumber

Charge-out rate per hour snapshotted on the entry

Charge-out rate per hour snapshotted on the entry

costRatenumber

Internal cost rate per hour snapshotted on the entry from the user's rate effective on
the entry date. Null when none applied, or when the caller lacks the Cost Rates permission.

Internal cost rate per hour snapshotted on the entry from the user's rate effective on
the entry date. Null when none applied, or when the caller lacks the Cost Rates permission.

billedLineItemCodestring

The code of the billing line item this entry was billed on (null until billed)

The code of the billing line item this entry was billed on (null until billed)

paymentApprovedDatestring

When the entry was approved for payment to the team member (null until approved).
Cleared automatically when the entry is edited — a material change goes back
through approval.

When the entry was approved for payment to the team member (null until approved).
Cleared automatically when the entry is edited — a material change goes back
through approval.

paymentApprovedByCodeAndNameDto
timePayRunCodestring

The code of the pay run this entry was paid on (null until paid). Paid entries
can no longer be edited or deleted.

The code of the pay run this entry was paid on (null until paid). Paid entries
can no longer be edited or deleted.

createdDatestring

When the entry was created

When the entry was created

updatedDatestring

When the entry was last updated

When the entry was last updated

JSON Example

{
  "code": "string",
  "user": {
    "code": "string",
    "name": "string"
  },
  "entryDate": "2024-01-01",
  "durationMinutes": 0,
  "startTime": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas