PayrunEmail

PayrunEmails are sent automatically when a payrun has been finalised

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
The EmployerTemplateType to use with this email. Set to null to use the CustomSubject and CustomBody
string "PayslipEmail" "PayslipsUnemailed" "PayrunSummary" "PayrunAutoEmail" "CisStatementEmail" "AutoEnrolment_Enrolled" "AutoEnrolment_Enrolled_NetPay" "AutoEnrolment_NotEnrolled" "AutoEnrolment_Insert"
recipientAddress
The address to which the email should be sent
string "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
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
{
  "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,
  "customSubject": "string",
  "customBody": "string",
  "customBody_IsHtml": true
}
Contained in Models
AutomationSettings
Consumed by Operations

- none -

Returned by Operations

- none -