TimeEntryDto - SodiumHQ API Schema

Properties

Name	Type	Description
code	string	Unique code for the time entry
Unique code for the time entry
user	CodeAndNameDto
entryDate	string	The day the work was done (format: yyyy-MM-dd)
The day the work was done (format: yyyy-MM-dd)
durationMinutes	integer	How long the work took, in minutes
How long the work took, in minutes
startTime	string	When the work started (UTC) — populated for timer-logged entries, optional otherwise
When the work started (UTC) — populated for timer-logged entries, optional otherwise
endTime	string	When the work ended (UTC) — populated for timer-logged entries, optional otherwise
When the work ended (UTC) — populated for timer-logged entries, optional otherwise
blocks	array 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.
description	string	What the time was spent on
What the time was spent on
client	ClientRefDto
taskItem	CodeAndNameDto
workflowStep	LinkedWorkflowStepDto
service	CodeAndNameDto
isBillable	boolean	Whether this time can be billed to the client
Whether this time can be billed to the client
hourlyRate	number	Charge-out rate per hour snapshotted on the entry
Charge-out rate per hour snapshotted on the entry
costRate	number	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.
billableValue	number	The entry's billable value: its minutes at the stamped rate, to the penny (0 with no rate)
The entry's billable value: its minutes at the stamped rate, to the penny (0 with no rate)
settledValue	number	WIP disposed of so far across the entry's allocations, billed or written off
WIP disposed of so far across the entry's allocations, billed or written off
billedAmount	number	What the client has been charged for this entry across its allocations
What the client has been charged for this entry across its allocations
openWip	number	WIP still open: BillableValue minus SettledValue
WIP still open: BillableValue minus SettledValue
settlementState	enum	Open PartSettled Settled
Open PartSettled Settled
paymentApprovedDate	string	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.
paymentApprovedBy	CodeAndNameDto
timePayRunCode	string	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.
externalEventUid	string	The external calendar meeting the entry was logged from (its occurrence UID), if any
The external calendar meeting the entry was logged from (its occurrence UID), if any
createdDate	string	When the entry was created
When the entry was created
updatedDate	string	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

TimeEntryDtoPagedResult