Guides

When a user creates a new Employer, certain settings can be copied from an existing employer.
This model determines which employer (if any) settings should be copied from and what should be copied.

Schema

Name / Description	Type / Format	Example
`employer`	`EmployerItem`	`{EmployerItem}`
`payCodes` If true then PayCodes and PayCodeSets will be copied from the specified Employer	`boolean`	`true`
`csvMappings` If true then CSV Mappings will be copied from the specified Employer	`boolean`	`true`
`departments` If true then Departments, Cost Centres and Analysis Categories will be copied from the specified Employer	`boolean`	`true`
`rti` If true then RTI Settings will be copied from the specified Employer	`boolean`	`true`
`users` If true then Users will be copied from the specified Employer	`boolean`	`true`
`hmrcNoticeSettings` If true then HMRC Notice Settings will be copied from the specified Employer	`boolean`	`true`
`payOptions` If true then Default Pay Options will be copied from the specified Employer.	`boolean`	`true`
`workingPatterns` If true then WorkingPatterns will be copied from the specified Employer	`boolean`	`true`
`occupationalPolicies` If true then Occupational Absence Schemes will be copied from the specified Employer.	`boolean`	`true`
`pensionSchemes` If true then PensionSchemes will be copied from the specified Employer	`boolean`	`true`
`payees` If true then Payees will be copied from the specified Employer	`boolean`	`true`
`reportPacks` If true then ReportPacks will be copied from the specified Employer	`boolean`	`true`

JSON Example

{
  "employer": {
    "isOwner": true,
    "role": "Admin",
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "payCodes": true,
  "csvMappings": true,
  "departments": true,
  "rti": true,
  "users": true,
  "hmrcNoticeSettings": true,
  "payOptions": true,
  "workingPatterns": true,
  "occupationalPolicies": true,
  "pensionSchemes": true,
  "payees": true,
  "reportPacks": true
}

References

Contained in Models

- none -

Consumed by Operations
Set EmployerDefaults

Returned by Operations
Get EmployerDefaults
Set EmployerDefaults