DocumentApprovalStepConfigDto

Configuration for DocumentApproval workflow steps.
Used for both workflow template definition and task workflow step instance customization.

Properties

Name	Type	Description
title	string	Optional default title for the document. Pre-fills the upload form so the user only needs to select the file.
Optional default title for the document. Pre-fills the upload form so the user only needs to select the file.
summary	string	Optional default summary for the document. Pre-fills the upload form so the user only needs to select the file.
Optional default summary for the document. Pre-fills the upload form so the user only needs to select the file.
categoryCode	string	Optional default document category code. Pre-fills the category dropdown on the upload form.
Optional default document category code. Pre-fills the category dropdown on the upload form.
recipientIncludeBusinessEmail	boolean	Whether to send the approval request email to the client's business email (the email address on the client record).
Whether to send the approval request email to the client's business email (the email address on the client record).
recipientContactTypes	array of enum	Client contact types to send the approval request email to. Resolved at execution time from the task's associated client contacts. Main Billing Payroll Accounts Director Psc
Client contact types to send the approval request email to. Resolved at execution time from the task's associated client contacts. Main Billing Payroll Accounts Director Psc
additionalEmailAddresses	array of string	Static email addresses to send the approval request email to.
Static email addresses to send the approval request email to.
chaseFrequencyDays	integer	Override for how often (in days) to chase this approval. When null, the tenant-level default is used.
Override for how often (in days) to chase this approval. When null, the tenant-level default is used.
documentTemplate	CodeAndNameDto
designThemeCode	string	Optional design theme override for PDF generation. When null, uses the template's default theme.
Optional design theme override for PDF generation. When null, uses the template's default theme.
templateTokenValues	object	Token values for template rendering, keyed by token name (e.g. "Title", "Subtitle", "Custom.CompanySecretary"). Collected at workflow design time, applied at execution time.
Token values for template rendering, keyed by token name (e.g. "Title", "Subtitle", "Custom.CompanySecretary"). Collected at workflow design time, applied at execution time.
portalFolderPath	string	Portal folder path for the generated document. When null, defaults to "Generated Documents".
Portal folder path for the generated document. When null, defaults to "Generated Documents".

JSON Example

{
  "title": "string",
  "summary": "string",
  "categoryCode": "string",
  "recipientIncludeBusinessEmail": false,
  "recipientContactTypes": [
    "Main"
  ]
}

Contained in Schemas

WorkflowStepDto DTO for workflow steps within a workflow group. Used for both create/update requests and GET respons...
WorkflowStepProgressDto Represents the progress of a single workflow step within a TaskItem. Contains both the step template...