EmployerSettings

Miscellaneous settings related to the employer that don't naturally belong in other models

Name / Description Type / Format Example
allowNegativePay boolean true
manualStatutoryPayLinesEnabled boolean true
mergeMatchingNominalsEnabled boolean true
autoCalcBackPayForNewStarters boolean true
payCodeValidationEnabled boolean true
calculateEffectiveDateSalaryChanges boolean true
groupPayLinesEnabled
A flag to indicate whether paylines should be grouped. The grouping is done based on the following PayLine properties: Rate, Multiplier, Code, Description and RoleId
boolean true
contractedWeeks
The amount of weeks an employee works, utilise for employees who aren't working full time.
This value is the default which can be inherited when creating/updating a WorkingPattern.
number double 0.0
fullTimeContractedWeeks
The amount of weeks an employee works (Full Time).
This value is the default which can be inherited when creating/updating a WorkingPattern.
number double 0.0
fullTimeContractedHours
The amount of hours an employee works (Full Time).
This value is the default which can be inherited when creating/updating a WorkingPattern.
number double 0.0
disabledPayRunWarningsList
Pay run warnings that the user has opted to ignore.
PayRunEntryWarningType[]
journalCsvFormat string "Default" "SapS4Hana" "MappedOutput"
preferAsyncPayrunApiCalls
This setting is only available temporarily and is only setable by users with access to beta features enabled.
If set to true the the web applicaiton will use new async API calls for managing payruns
boolean true
nominalMappingsEnabled
Enables the nominal mappings(Custom Codes,System Codes,Control Codes,Employer Codes) for the employer, if set to true.
boolean true
sortPayrollNumbersAlphanumerically
Enables the default sorting to be alphanumerically for payroll code, if set to true else numerical sorting will be applied
boolean true
{
  "allowNegativePay": true,
  "manualStatutoryPayLinesEnabled": true,
  "mergeMatchingNominalsEnabled": true,
  "autoCalcBackPayForNewStarters": true,
  "payCodeValidationEnabled": true,
  "calculateEffectiveDateSalaryChanges": true,
  "groupPayLinesEnabled": true,
  "contractedWeeks": 0.0,
  "fullTimeContractedWeeks": 0.0,
  "fullTimeContractedHours": 0.0,
  "disabledPayRunWarningsList": [],
  "journalCsvFormat": "Default",
  "preferAsyncPayrunApiCalls": true,
  "nominalMappingsEnabled": true,
  "sortPayrollNumbersAlphanumerically": true
}
Contained in Models
Employer
Consumed by Operations

- none -

Returned by Operations

- none -