WorkflowStepDto - SodiumHQ API Schema

Properties

Name	Type	Description
name	string
description	string
timeEstimateMinutes	integer
plannedDateOffsetValue	integer	How many PlannedDateOffsetUnits after the task's start date, or before its due date, this step is planned for on a task. Null means the step sits on the task's start date. Set together with PlannedDateRelativeTo.
How many PlannedDateOffsetUnits after the task's start date, or before its due date, this step is planned for on a task. Null means the step sits on the task's start date. Set together with PlannedDateRelativeTo.
plannedDateOffsetUnit	enum	Day Week Month Year
Day Week Month Year
plannedDateRelativeTo	enum	DueDate StartDate
DueDate StartDate
plannedTime	string	Time of day on the planned date, when the step's automation may run. Null means the task's start time. Only valid alongside a planned date.
Time of day on the planned date, when the step's automation may run. Null means the task's start time. Only valid alongside a planned date.
stepNumber	integer	The step number within the workflow group. Used for ordering steps and referencing dependencies. If 0-based numbering is provided, it will be automatically converted to 1-based.
The step number within the workflow group. Used for ordering steps and referencing dependencies. If 0-based numbering is provided, it will be automatically converted to 1-based.
stepType	enum	Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage DocumentUpload ReviewLoggedTime BillForWork CisCollectPayments CisConfirmReturn CisSubmitReturn CisVerifySubcontractors
Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage DocumentUpload ReviewLoggedTime BillForWork CisCollectPayments CisConfirmReturn CisSubmitReturn CisVerifySubcontractors
autoExecute	boolean	Whether this step executes automatically when its dependencies are met. False means the user must manually trigger execution. Only relevant for executable step types (SendEmail, DocumentRequest, ClientConfirmation).
Whether this step executes automatically when its dependencies are met. False means the user must manually trigger execution. Only relevant for executable step types (SendEmail, DocumentRequest, ClientConfirmation).
assignmentType	enum	TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign ClientServicePreparer ClientServiceReviewer
TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign ClientServicePreparer ClientServiceReviewer
assignedUser	CodeAndNameDto
assignedTeam	CodeAndNameDto
billableService	CodeAndNameDto
dependsOnStepNumbers	array of integer	The step numbers that this step depends on (must be completed first). Can use either 0-based [0, 1] or 1-based [1, 2] numbering - 0-based will be auto-converted. Example: [1, 2] means this step depends on steps 1 and 2 being completed first.
The step numbers that this step depends on (must be completed first). Can use either 0-based [0, 1] or 1-based [1, 2] numbering - 0-based will be auto-converted. Example: [1, 2] means this step depends on steps 1 and 2 being completed first.
emailStepConfiguration	EmailStepConfigDto
documentRequestStepConfiguration	DocumentRequestStepConfigDto
documentApprovalStepConfiguration	DocumentApprovalStepConfigDto
documentUploadStepConfiguration	DocumentUploadStepConfigDto
clientConfirmationStepConfiguration	ClientConfirmationStepConfigDto
sendDataFormStepConfiguration	SendDataFormStepConfigDto
setServiceStageStepConfiguration	SetServiceStageStepConfigDto
setPipelineStageStepConfiguration	SetPipelineStageStepConfigDto
updateClientDataStepConfiguration	UpdateClientDataStepConfigDto
reviewLoggedTimeStepConfiguration	ReviewLoggedTimeStepConfigDto
billForWorkStepConfiguration	BillForWorkStepConfigDto
cisCollectPaymentsStepConfiguration	CisCollectPaymentsStepConfigDto
cisConfirmReturnStepConfiguration	CisConfirmReturnStepConfigDto
cisSubmitReturnStepConfiguration	CisSubmitReturnStepConfigDto
cisVerifySubcontractorsStepConfiguration	CisVerifySubcontractorsStepConfigDto
checklist	array of ChecklistItemDto	Checklist items for this workflow step template
Checklist items for this workflow step template
condition	ConditionDto
clientTypes	array of enum	The types of clients this step is applicable to. An empty list means the step applies to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
The types of clients this step is applicable to. An empty list means the step applies to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association

JSON Example

{
  "name": "string",
  "description": "string",
  "timeEstimateMinutes": 0,
  "plannedDateOffsetValue": 0,
  "plannedDateOffsetUnit": "Day"
}

Contained in Schemas

WorkflowGroupDto DTO for workflow groups within a workflow. Workflow Group Deadlines: Each group's deadl...