AutomationSettings

Configures various automation settings for an Employer

Schema

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 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
enableAutoOpen
IF enabled then whenever you close a payrun, the next one will be started. Automatically set to true if EnableAutoPilot is true
 boolean true
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
autoSubmitPayments
If set to true, we'll automatically submit payments whenever you finalise a PayRun.
The employer must be connected to an ExternalDataProvider supporting Type of 'Payments'.
 boolean true
autoSubmitJournal
If set to true, we'll automatically submit the payroll journal whenever you finalise a PayRun.
The employer must be connected to an ExternalDataProvider supporting Type of 'Accounting'.
 boolean true
autoSubmitPayments_Employee
Used in conjunction with AutoSubmitPayments.
 boolean true
autoSubmitPayslips
If set to true, we'll automatically submit payslips whenever you finalise a PayRun.
The employer must be connected to an ExternalDataProvider supporting Type of 'EmployeePortal'.
 boolean true
autoSubmitP45s
If set to true, we'll automatically submit P45s whenever you finalise a PayRun.
The employer must be connected to an ExternalDataProvider supporting Type of 'EmployeePortal'.
 boolean true
autoSubmitPayments_Hmrc
Used in conjunction with AutoSubmitPayments.
 boolean true
autoSubmitPayments_Deductions
Used in conjunction with AutoSubmitPayments.
 boolean true
autoSubmitPayments_Aeos
Used in conjunction with AutoSubmitPayments.
 boolean true
autoSubmitPayments_Pensions
Used in conjunction with AutoSubmitPayments.
 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}
autoSubmitPensionLetters
If set to true, we'll automatically submit Pension Letters whenever you finalise a PayRun.
The employer must be connected to an ExternalDataProvider supporting Type of 'EmployeePortal'.
 boolean true
autoSubmitEps
If set to true, we'll automatically send your EPS to HMRC whenever you finalise a PayRun.
 boolean true

JSON Example 

{
  "enableAutoPilot": true,
  "autoPilotTime": "JustAfterMidnight",
  "autoPilotOffset": 0,
  "enableAutoOpen": true,
  "autoSubmitFps": true,
  "autoSubmitPayments": true,
  "autoSubmitJournal": true,
  "autoSubmitPayments_Employee": true,
  "autoSubmitPayslips": true,
  "autoSubmitP45s": true,
  "autoSubmitPayments_Hmrc": true,
  "autoSubmitPayments_Deductions": true,
  "autoSubmitPayments_Aeos": true,
  "autoSubmitPayments_Pensions": 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,
      "attachCostAnalysis": true,
      "attachCostOfEmployment": true,
      "attachFullSummaryOfPay": true,
      "attachBankPayments": true,
      "customSubject": "string",
      "customBody": "string",
      "customBody_IsHtml": true,
      "childId": "string"
    }
  ],
  "autoSubmitPensionLetters": true,
  "autoSubmitEps": true
}

References

Contained in Models

- none -

Consumed by Operations
Update Automation Settings
Returned by Operations
Get Automation Settings
Update Automation Settings