Properties
| Name | Type | Description |
|---|---|---|
| taxMonth | enum | Previous Current Next |
Previous Current Next | ||
| subjectLine | string | Optional email subject line override (Liquid). When empty, the portal settings content block's subject is used. |
Optional email subject line override (Liquid). When empty, the portal settings content block's subject is used. | ||
| messageHtml | string | The message on the portal page above the return (Liquid) |
The message on the portal page above the return (Liquid) | ||
| buttonText* | string | Text of the confirm button on the portal page |
Text of the confirm button on the portal page | ||
| thankYouMessageHtml | string | The message shown after the contractor confirms (Liquid) |
The message shown after the contractor confirms (Liquid) | ||
| allowQuery | boolean | Whether the contractor may say something isn't right instead of confirming; a query blocks the step |
Whether the contractor may say something isn't right instead of confirming; a query blocks the step | ||
| notifyAssigneeOnConfirmation | boolean | Whether to notify the step's assignee when the contractor confirms |
Whether to notify the step's assignee when the contractor confirms | ||
| recipientIncludeBusinessEmail | boolean | Whether to send the email to the client's business email (the email address on the client record). |
Whether to send the email to the client's business email (the email address on the client record). | ||
| recipientContactTypes | array of enum | Client contact types to send the email to. |
Client contact types to send the email to. | ||
| additionalEmailAddresses | array of string | Static email addresses to send the email to. |
Static email addresses to send the email to. | ||
| chaseFrequencyDays | integer | Override for how often (in days) to chase the client. When null, the tenant-level default is used. |
Override for how often (in days) to chase the client. When null, the tenant-level default is used. | ||
JSON Example
{
"taxMonth": "Previous",
"subjectLine": "string",
"messageHtml": "string",
"buttonText": "string",
"thankYouMessageHtml": "string"
}