TaskItemDto

DTO for task responses in the API, containing friendly references (emails/Codes) instead of database IDs.
Can represent either a task view or a workflow step view (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 (calculated) or materialised (exists in database)
Whether this task is projected (calculated) or materialised (exists in database)
timeEstimate	number	The estimated time to complete the task in hours
The estimated time to complete the task in hours
startDate	string	When the task starts
When the task starts
dueDate	string	When the task is due
When the task is due
statutoryDueDate	string	The statutory due date for compliance tasks (if applicable)
The statutory due date for compliance tasks (if applicable)
clients	array of CodeAndNameDto	The clients this task is associated with
The clients this task is associated with
primaryClient	CodeAndNameDto
assignedUser	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
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
workflowStepDetails	WorkflowStepDetailsDto

JSON Example

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

Used By Operations

Contained in Schemas

TaskItemDtoPaginatedResponse