API Docs / Schemas / TaskItemDto

TaskItemDto

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

Properties

Name Type Description
codestring

Unique identifier within the tenant

Unique identifier within the tenant

namestring

The name of the task

The name of the task

descriptionstring

The description of the task

The description of the task

statusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

isProjectedboolean

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)

timeEstimateMinutesinteger

The estimated time to complete the task, in whole minutes.

The estimated time to complete the task, in whole minutes.

startDatestring

When the task starts

When the task starts

dueDatestring

When the task is due

When the task is due

isOverdueboolean

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)

statutoryDueDatestring

The statutory due date for compliance tasks (if applicable)

The statutory due date for compliance tasks (if applicable)

clientsarray of CodeAndNameDto

The clients this task is associated with

The clients this task is associated with

primaryClientCodeAndNameDto
assignedUserCodeAndNameDto
assignedTeamCodeAndNameDto
createdDatestring

When the task was created

When the task was created

updatedDatestring

When the task was last updated

When the task was last updated

clientBillableServiceCodeAndNameDto
clientPipelineCodeAndNameDto
recurringTaskCodeAndNameDto
workflowCodeAndNameDto
categoryCodeAndNameDto
workflowStepsinteger

The total number of workflow steps for this task

The total number of workflow steps for this task

workflowStepsCompleteinteger

The number of workflow steps completed for this task

The number of workflow steps completed for this task

workflowStepEstimateMinutesinteger

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.

checklistarray of ChecklistItemDto

Checklist items for this task

Checklist items for this task

latestNoteContentstring

The most recent note/comment on this task

The most recent note/comment on this task

latestNoteDatestring

When the most recent note was created

When the most recent note was created

workflowStepDetailsWorkflowStepDetailsDto

JSON Example

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

Used By Operations

Contained in Schemas