AutomationSettings

Configures various automation settings for an Employer

Name / Description Type / Format Example
enableAutoPilot
IF enabled then payruns will be automatically finalised on the payment date and the next payrun will be started
boolean true
autoPilotTime
The time of day on the payment date at which the payrun should be automatically finalised
string "JustAfterMidnight" "NineAm" "OnePm" "FourPm" "SixPm" "ElevenPm"
autoPilotOffset
How many days before the payment date a payrun should be finalised.
Set it to 0 if you want the payrun to be automatically finalised on the payment date itself
integer int32 0
autoSubmitFps
If set to true, we'll automatically send your FPS to HMRC whenever you finalise a PayRun.
This property will always have the same value as the property with the same name on the RtiSubmissionSettings model.
boolean true
employeesWithoutEmailAddress
A count of how many employees or subcontractors for this employer do not have email addresses
integer int32 0
employeesWithEmailAddressButNotAutoSending
A count of how many employees or subcontractors for this employer do have email addresses but don't have the option enabled to auto-email payslips
integer int32 0
subcontractorsNotAutoSendingStatement
A count of how many subscontractors for this employer do don't have the option enabled to auto-email statement
integer int32 0
codingNoticesAutomaticallyApplied
An indicator of whether or not this employer is automatically applying DpsNotices
boolean true
payrunEmails
Automated emails that will be sent when a PayRun is finalised
PayrunEmail[] {PayrunEmail}
{
  "enableAutoPilot": true,
  "autoPilotTime": "JustAfterMidnight",
  "autoPilotOffset": 0,
  "autoSubmitFps": true,
  "employeesWithoutEmailAddress": 0,
  "employeesWithEmailAddressButNotAutoSending": 0,
  "subcontractorsNotAutoSendingStatement": 0,
  "codingNoticesAutomaticallyApplied": true,
  "payrunEmails": [
    {
      "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

- none -

Consumed by Operations
Update Automation Settings