Guides

Name / Description	Type / Format	Example
`isActive` If false then this email won't be sent	`boolean`	`true`
`name` Only used for reference, not included in the email	`string`	`"string"`
`templateType`	`string`	`"PayslipEmail"` `"AutoEnrolment_Enrolled"` `"AutoEnrolment_Enrolled_NetPay"` `"AutoEnrolment_NotEnrolled"` `"AutoEnrolment_Insert"` `"CisStatementEmail"` `"PayrunSummary"` `"PayslipsUnemailed"` `"PayrunAutoEmail"` `"P60Email"` `"AnnualCisStatementEmail"` `"P45Email"` `"AutoEnrolment_Postponed"` `"AutoEnrolment_ReEnrolled"` `"AutoEnrolment_Enrolled_SalarySacrifice"` `"AutoEnrolment_ReEnrolled_SalarySacrifice"` `"P11DEmail"`
`recipientAddress` The address to which the email should be sent	`string` email	`"string"`
`pdfPassword` If a value is provided, then all PDFs attached to the email will be encrypted using this password	`string`	`"string"`
`attachPayslips` If set to true then Payslips will be attached to the email	`boolean`	`true`
`payslips_Unemailed` If AttachPayslips is true and this property is also true then only payslips that haven't already been sent directly to employees will be attached.	`boolean`	`true`
`payslips_SingleFile` If AttachPayslips is true and this property is also true then the payslips will be attached as a single file rather than as separate PDFs,	`boolean`	`true`
`attachPaymentSummary` If set to True then the PaymentSummary report will be attached to the Email	`boolean`	`true`
`attachP32` If set to True then the P32 report will be attached to the email	`boolean`	`true`
`attachP30` If set to True then the P30 report will be attached to the email	`boolean`	`true`
`attachGrossToNet` If set to True then the GrossToNet report will be attached to the email	`boolean`	`true`
`attachPensionContributions` If set to True then the Pensions Contributions report will be attached to the email	`boolean`	`true`
`attachCostAnalysis` If set to True then the Cost Analysis report will be attached to the email	`boolean`	`true`
`attachCostOfEmployment` If set to True then the Cost of Employment report will be attached to the email	`boolean`	`true`
`attachFullSummaryOfPay` If set to True then the Full Summary Of Payment report will be attached to the email	`boolean`	`true`
`attachBankPayments` If set to True then the Bank Payments CSV file will be attached to the email	`boolean`	`true`
`customSubject` If TemplateType is null then you can provide a subject line here to be used for the email	`string`	`"string"`
`customBody` If TemplateType is null then you can provide the body text here to be used for the email	`string`	`"string"`
`customBody_IsHtml` If the CustomBody is in HTML format, set this to true.	`boolean`	`true`
`childId` This is nothing but the UniqueId of the model.	`string` uuid	`"string"`

JSON Example

{
  "isActive": true,
  "name": "string",
  "templateType": "PayslipEmail",
  "recipientAddress": "string",
  "pdfPassword": "string",
  "attachPayslips": true,
  "payslips_Unemailed": true,
  "payslips_SingleFile": true,
  "attachPaymentSummary": true,
  "attachP32": true,
  "attachP30": true,
  "attachGrossToNet": true,
  "attachPensionContributions": true,
  "attachCostAnalysis": true,
  "attachCostOfEmployment": true,
  "attachFullSummaryOfPay": true,
  "attachBankPayments": true,
  "customSubject": "string",
  "customBody": "string",
  "customBody_IsHtml": true,
  "childId": "string"
}

References

Contained in Models
AutomationSettings

Consumed by Operations

- none -

Returned by Operations

- none -