API Docs / Schemas / OnboardingTaskTemplateDto

OnboardingTaskTemplateDto

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

Properties

Name Type Description
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.

codestring
billableServiceCodeAndNameDto
namestring
descriptionstring
timeEstimateMinutesinteger
dueDateOffsetDaysinteger

Days after service start date for the task due date

Days after service start date for the 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 onboarding task template

Checklist items for this onboarding task template

activeboolean

Whether this template is active

Whether this template is active

JSON Example

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

Used By Operations

Contained in Schemas