API Docs / Schemas / RecurringTaskOccurrenceDto

RecurringTaskOccurrenceDto

One occurrence of a recurring task for one client: a date the schedule produces (or produced),
and what happened to it - still to be created, created as a task, or deleted.

Properties

Name Type Description
occurrenceDatestring

The occurrence's date as the schedule produced it - the task's Start before any manual edit.
Identifies the occurrence across creation and deletion.

The occurrence's date as the schedule produced it - the task's Start before any manual edit.
Identifies the occurrence across creation and deletion.

statusenum

Projected Created Deleted

Projected Created Deleted

startDatestring

The task's start date. For a created task this is its current start date, which may have been
edited away from SodiumHQ.DTOs.TaskItems.RecurringTaskOccurrenceDto.OccurrenceDate. Null for a deleted occurrence.

The task's start date. For a created task this is its current start date, which may have been
edited away from SodiumHQ.DTOs.TaskItems.RecurringTaskOccurrenceDto.OccurrenceDate. Null for a deleted occurrence.

dueDatestring

The task's due date. Null for a deleted occurrence.

The task's due date. Null for a deleted occurrence.

taskCodeAndNameDto
taskStatusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

deletedByCodeAndNameDto
deletedDatestring

When the occurrence was deleted (UTC). Only set for a deleted occurrence.

When the occurrence was deleted (UTC). Only set for a deleted occurrence.

restoredByCodeAndNameDto
restoredDatestring

When the occurrence was restored (UTC). Set alongside SodiumHQ.DTOs.TaskItems.RecurringTaskOccurrenceDto.RestoredBy.

When the occurrence was restored (UTC). Set alongside SodiumHQ.DTOs.TaskItems.RecurringTaskOccurrenceDto.RestoredBy.

JSON Example

{
  "occurrenceDate": "2024-01-01",
  "status": "Projected",
  "startDate": "2024-01-01",
  "dueDate": "2024-01-01",
  "task": {
    "code": "string",
    "name": "string"
  }
}

Contained in Schemas