RecurringTaskScheduleDto

A schedule a recurring task runs on. Every task has one default schedule (its own dates) plus
any number of custom schedules with clients linked to them; a schedule with no clients is
legal (parked for later use).

Properties

Name	Type	Description
code	string	Stable identifier of the schedule.
Stable identifier of the schedule.
name	string	Optional user label; the UI otherwise renders the schedule phrase from the fields.
Optional user label; the UI otherwise renders the schedule phrase from the fields.
isDefault	boolean	Whether this is the task's default schedule: the one clients without a link run on. Not deletable and holds no explicit clients.
Whether this is the task's default schedule: the one clients without a link run on. Not deletable and holds no explicit clients.
recurringTask	CodeAndNameDto
schedule	ScheduleConfigDto
clients	array of CodeAndNameDto	Clients linked to this schedule, ordered by name. The list endpoint returns the first few (see TotalClients for the real count); the single-schedule endpoint returns all of them. Always empty for the default schedule.
Clients linked to this schedule, ordered by name. The list endpoint returns the first few (see TotalClients for the real count); the single-schedule endpoint returns all of them. Always empty for the default schedule.
totalClients	integer	Total number of clients linked to this schedule.
Total number of clients linked to this schedule.

JSON Example

{
  "code": "string",
  "name": "string",
  "isDefault": false,
  "recurringTask": {
    "code": "string",
    "name": "string"
  },
  "schedule": {
    "basis": "...",
    "recurrence": "...",
    "start": "...",
    "due": "...",
    "statutory": "..."
  }
}

Used By Operations

Contained in Schemas

RecurringTaskScheduleDtoPagedResult