| 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.
|
| sendNotification | boolean | Whether to send the client a notification email with a link to view the document.
When false, the step completes as soon as the document is uploaded.
|
Whether to send the client a notification email with a link to view the document.
When false, the step completes as soon as the document is uploaded.
|
| message | string | Optional personal message included in the notification email via the
{{ Message }} template token. May contain HTML and template tokens.
Only used when SendNotification is true.
|
Optional personal message included in the notification email via the
{{ Message }} template token. May contain HTML and template tokens.
Only used when SendNotification is true.
|
| recipientIncludeBusinessEmail | boolean | Whether to send the notification email to the client's business email
(the email address on the client record). Only used when SendNotification is true.
|
Whether to send the notification email to the client's business email
(the email address on the client record). Only used when SendNotification is true.
|
| recipientContactTypes | array of enum | Client contact types to send the notification email to.
Resolved at execution time from the task's associated client contacts.
Only used when SendNotification is true.
Main Billing Payroll Accounts Director Psc Secretary Trustee
|
Client contact types to send the notification email to.
Resolved at execution time from the task's associated client contacts.
Only used when SendNotification is true.
Main Billing Payroll Accounts Director Psc Secretary Trustee
|
| additionalEmailAddresses | array of string | Static email addresses to send the notification email to.
Only used when SendNotification is true.
|
Static email addresses to send the notification email to.
Only used when SendNotification is true.
|
| includeAttachment | boolean | Whether to attach the document file to the notification email
in addition to the view link. Only used when SendNotification is true.
|
Whether to attach the document file to the notification email
in addition to the view link. Only used when SendNotification is true.
|
| 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 | Default portal folder path for the document.
Pre-fills the upload form for manual uploads; applied directly when generating
from a template (where null defaults to "Generated Documents").
|
Default portal folder path for the document.
Pre-fills the upload form for manual uploads; applied directly when generating
from a template (where null defaults to "Generated Documents").
|
| visibleInClientPortal | boolean | Default for whether the document is visible to the client in the portal.
Ignored (treated as true) when SendNotification is true — notifying the client
requires the document to be visible in the portal.
|
Default for whether the document is visible to the client in the portal.
Ignored (treated as true) when SendNotification is true — notifying the client
requires the document to be visible in the portal.
|
