TaskItemDto

A task, either standalone or a workflow step (with parent task context)

Properties

Name	Type	Description
code	string	Unique identifier within the tenant
Unique identifier within the tenant
name	string	The name of the task
The name of the task
description	string	The description of the task
The description of the task
status	enum	NotStarted InProgress Blocked Completed Skipped
NotStarted InProgress Blocked Completed Skipped
isProjected	boolean	Whether this task is projected (computed on the fly, not yet saved) or materialised (a saved task)
Whether this task is projected (computed on the fly, not yet saved) or materialised (a saved task)
timeEstimateMinutes	integer	The estimated time to complete the task, in whole minutes.
The estimated time to complete the task, in whole minutes.
startDate	string	When the task starts
When the task starts
dueDate	string	When the task is due
When the task is due
startTime	string	Time of day on SodiumHQ.DTOs.TaskItems.TaskItemDto.StartDate, in the practice's local time.
Time of day on SodiumHQ.DTOs.TaskItems.TaskItemDto.StartDate, in the practice's local time.
dueTime	string	Time of day on SodiumHQ.DTOs.TaskItems.TaskItemDto.DueDate, in the practice's local time.
Time of day on SodiumHQ.DTOs.TaskItems.TaskItemDto.DueDate, in the practice's local time.
isOverdue	boolean	Indicates if the task is overdue (DueDate is before today and status is not Completed or Skipped)
Indicates if the task is overdue (DueDate is before today and status is not Completed or Skipped)
statutoryDueDate	string	The statutory due date for compliance tasks (if applicable)
The statutory due date for compliance tasks (if applicable)
originalStartDate	string	The start date this task was originally projected for, set once at materialisation and never changed afterwards. Null for tasks that did not come from a recurring task. Identifies an occurrence across both materialisation and later rescheduling.
The start date this task was originally projected for, set once at materialisation and never changed afterwards. Null for tasks that did not come from a recurring task. Identifies an occurrence across both materialisation and later rescheduling.
clients	array of CodeAndNameDto	The clients this task is associated with
The clients this task is associated with
primaryClient	CodeAndNameDto
clientManager	CodeAndNameDto
clientPartner	CodeAndNameDto
clientAssociate	CodeAndNameDto
assignedUser	CodeAndNameDto
assignedTeam	CodeAndNameDto
createdDate	string	When the task was created
When the task was created
updatedDate	string	When the task was last updated
When the task was last updated
clientBillableService	CodeAndNameDto
stage	ClientBillableServiceStageDto
clientPipeline	CodeAndNameDto
recurringTask	CodeAndNameDto
workflow	CodeAndNameDto
category	CodeAndNameDto
workflowSteps	integer	The total number of workflow steps for this task
The total number of workflow steps for this task
workflowStepsComplete	integer	The number of workflow steps completed for this task
The number of workflow steps completed for this task
isAutomationDisabled	boolean	True when automation is switched off: the system never starts a workflow step on this task. Staff can still run, complete, skip and reassign steps by hand.
True when automation is switched off: the system never starts a workflow step on this task. Staff can still run, complete, skip and reassign steps by hand.
automationDisabledDate	string	When automation was switched off. Null while automation is on.
When automation was switched off. Null while automation is on.
automationDisabledByUserName	string	Who switched automation off. Null means Sodium switched it off automatically.
Who switched automation off. Null means Sodium switched it off automatically.
workflowStepEstimateMinutes	integer	Summed estimated minutes of the task's non-omitted workflow steps. Null when the task has no workflow or none of its steps carry an estimate. When present this is the task's effective time estimate, overriding TimeEstimateMinutes.
Summed estimated minutes of the task's non-omitted workflow steps. Null when the task has no workflow or none of its steps carry an estimate. When present this is the task's effective time estimate, overriding TimeEstimateMinutes.
checklist	array of ChecklistItemDto	Checklist items for this task
Checklist items for this task
latestNoteContent	string	The most recent note/comment on this task
The most recent note/comment on this task
latestNoteDate	string	When the most recent note was created
When the most recent note was created
workflowStepDetails	WorkflowStepDetailsDto
nextSteps	array of NextStepDto	The task's currently-executable workflow steps (dependencies met, not complete, not omitted), in group/step order. Includes auto-execute steps (flagged). Always empty for Completed/Skipped tasks. Populated on list endpoints for main task rows; null on workflow-step rows, projected tasks, and single-task responses.
The task's currently-executable workflow steps (dependencies met, not complete, not omitted), in group/step order. Includes auto-execute steps (flagged). Always empty for Completed/Skipped tasks. Populated on list endpoints for main task rows; null on workflow-step rows, projected tasks, and single-task responses.

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "status": "NotStarted",
  "isProjected": false
}

TaskItemDto

Properties

JSON Example

Used By Operations

Contained in Schemas