Properties
| Name | Type | Description |
|---|---|---|
| collectedBy | enum | Staff Client |
Staff Client | ||
| taxMonth | enum | Previous Current Next |
Previous Current Next | ||
| subjectLine | string | Client mode: optional email subject line override (Liquid). When empty, the portal settings content block's |
Client mode: optional email subject line override (Liquid). When empty, the portal settings content block's | ||
| messageHtml | string | Client mode: the message at the top of the portal page (Liquid) |
Client mode: the message at the top of the portal page (Liquid) | ||
| allowNoPayments | boolean | Whether the client may declare that no payments were made in the tax month |
Whether the client may declare that no payments were made in the tax month | ||
| allowNewSubcontractors | boolean | Whether the client may add a subcontractor to CIS Manager from the page (unverified until verified with HMRC) |
Whether the client may add a subcontractor to CIS Manager from the page (unverified until verified with HMRC) | ||
| notifyAssigneeOnSubmission | boolean | Whether to notify the step's assignee when the client submits |
Whether to notify the step's assignee when the client submits | ||
| 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
{
"collectedBy": "Staff",
"taxMonth": "Previous",
"subjectLine": "string",
"messageHtml": "string",
"allowNoPayments": false
}