RecurringTaskItemDto

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

Properties

Name	Type	Description
libraryCode	string	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".
libraryStatus	enum	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
isImported	boolean	True if the tenant has already imported this library item.
True if the tenant has already imported this library item.
code	string
name	string
description	string
timeEstimateMinutes	integer
assignedUser	CodeAndNameDto
assignedTeam	CodeAndNameDto
billableService	CodeAndNameDto
sortOrder	integer
active	boolean
taskStartConfig	TaskStartConfigDto
recurrence	RecurrenceConfigDto
dueDateConfig	DueDateConfigDto
statutoryDateConfig	StatutoryDateConfigDto
holidayAdjustment	enum	None Skip MoveBefore MoveAfter
None Skip MoveBefore MoveAfter
assignmentType	enum	Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate
Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate
workflow	CodeAndNameDto
category	CodeAndNameDto
clientAssociationType	enum	None SpecificClients AllClients ClientsWithServices
None SpecificClients AllClients ClientsWithServices
vatReportingPeriod	enum	Monthly QuarterlyJanAprJulOct QuarterlyFebMayAugNov QuarterlyMarJunSepDec Annual
Monthly QuarterlyJanAprJulOct QuarterlyFebMayAugNov QuarterlyMarJunSepDec Annual
nextRunDate	string	The next date this recurring task should be created (for display purposes)
The next date this recurring task should be created (for display purposes)
checklist	array of ChecklistItemDto	Checklist items for this recurring task template
Checklist items for this recurring task template
taskNameTemplate	string	Optional template for naming tasks created from this recurring task. Supports {{ token }} placeholders (e.g. "VAT Return - {{ ClientName }} - {{ Quarter }} {{ Year }}"). When null or empty, tasks use the recurring task's Name. Available tokens can be retrieved from the GET /metadata/task-name-tokens endpoint. Unrecognised tokens are left as-is in generated task names.
Optional template for naming tasks created from this recurring task. Supports {{ token }} placeholders (e.g. "VAT Return - {{ ClientName }} - {{ Quarter }} {{ Year }}"). When null or empty, tasks use the recurring task's Name. Available tokens can be retrieved from the GET /metadata/task-name-tokens endpoint. Unrecognised tokens are left as-is in generated task names.

JSON Example

{
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary",
  "isImported": false,
  "code": "string",
  "name": "string"
}

Used By Operations

Contained in Schemas

RecurringTaskItemDtoPagedResult