API Docs / Schemas / TaskTemplateDto

TaskTemplateDto

DTO for one-off task templates, exposing only codes and enums (never DB IDs).

Properties

Name Type Description
codestring

Stable identifier. For library-shipped items this is the library code; for tenant-imported
items this is the tenant entity's own code.

Stable identifier. For library-shipped items this is the library code; for tenant-imported
items this is the tenant entity's own code.

namestring

Display name shown to users in lists, dialogs, and the import browser.

Display name shown to users in lists, dialogs, and the import browser.

descriptionstring

Optional human-readable summary of what this entity is for.

Optional human-readable summary of what this entity is for.

libraryCodestring

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

libraryStatusenum

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

isImportedboolean

True if the tenant has already imported this library item.

True if the tenant has already imported this library item.

deprecatedboolean

True if this library item has been retired. Deprecated items are hidden from the import
browser (so new tasks cannot be created from them) but remain available for revert-to-library
on existing imports.

True if this library item has been retired. Deprecated items are hidden from the import
browser (so new tasks cannot be created from them) but remain available for revert-to-library
on existing imports.

billableServiceCodeAndNameDto
timeEstimateMinutesinteger

The estimated time to complete the task, in whole minutes

The estimated time to complete the task, in whole minutes

dueDateOffsetDaysinteger

Days after the creation date for the default task due date

Days after the creation date for the default task due date

assignmentTypeenum

Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate

Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate

assignedUserCodeAndNameDto
assignedTeamCodeAndNameDto
workflowCodeAndNameDto
categoryCodeAndNameDto
checklistarray of ChecklistItemDto

Checklist items for this task template

Checklist items for this task template

activeboolean

Whether this template is active (inactive templates are hidden when creating tasks)

Whether this template is active (inactive templates are hidden when creating tasks)

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas