RecurringTaskItemDto

DTO for recurring task templates, exposing only codes and enums.

Properties

Name	Type	Description
code	string	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.
name	string	Display name shown to users in lists, dialogs, and the import browser.
Display name shown to users in lists, dialogs, and the import browser.
description	string	Optional human-readable summary of what this entity is for.
Optional human-readable summary of what this entity is for.
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.
deprecated	boolean	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.
timeEstimateMinutes	integer	The estimated time to complete each generated task, in whole minutes.
The estimated time to complete each generated task, in whole minutes.
assignedUser	CodeAndNameDto
assignedTeam	CodeAndNameDto
billableService	CodeAndNameDto
sortOrder	integer	Sort order for displaying recurring tasks.
Sort order for displaying recurring tasks.
active	boolean	Whether this recurring task is active and will generate new tasks.
Whether this recurring task is active and will generate new tasks.
hasCustomSchedules	boolean	Whether any non-default schedules exist for this task. Maintained automatically as schedules are created and deleted - not user-settable.
Whether any non-default schedules exist for this task. Maintained automatically as schedules are created and deleted - not user-settable.
isDefaultSchedule	boolean	Whether Schedule is the task's default. Only false when the list is filtered by client and that client is linked to a custom schedule - Schedule then carries the custom values.
Whether Schedule is the task's default. Only false when the list is filtered by client and that client is linked to a custom schedule - Schedule then carries the custom values.
customSchedule	CodeAndNameDto
schedule	ScheduleConfigDto
process	ProcessConfigDto
assignmentType	enum	Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate
Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate
category	CodeAndNameDto
clientAssociationType	enum	None SpecificClients AllClients ClientsWithServices ClientsWithPipelines
None SpecificClients AllClients ClientsWithServices ClientsWithPipelines
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)
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

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

Used By Operations

Contained in Schemas

RecurringTaskItemDtoPagedResult