Employer

Schema

Name / Description Type / Format Example
name string "string"
crn
Company Registration Number
 string "string"
logoUrl string "string"
logoSasUrl string "string"
alternativeId string "string"
bankPaymentsCsvFormat string "StandardCsv" "Telleroo" "BarclaysBacs" "SantanderBacs" "Sif" "Revolut" "Standard18FasterPayments" "Standard18Bacs" "Bankline" "BanklineBulk" "StandardCsvBacs" "LloydsMultipleStandardCsvBacs" "LloydsV11CsvBacs" "CoOpBulkCsvBacs" "CoOpFasterPaymentsCsv" "BankOfAmericaBacs" "DanskeBankUkLocalPayments" "DanskeBankUkFasterPayments" "Standard18BacsMulti"
bacsServiceUserNumber string "string"
bacsBureauNumber string "string"
rejectInvalidBankDetails boolean true
bankPaymentsReferenceFormat string "string"
bacsIncludeAEO boolean true
bacsIncludeDeductions boolean true
bacsIncludeHmrc boolean true
bacsIncludePensions boolean true
useTenantRtiSubmissionSettings
If the Tenant for this employer has Bureau Features enabled then they can set RtiSubmissionSettings to be used across multiple employers.
If this is set to true then those settings will be used instead of any set at the Employer level
 boolean true
address Address {Address}
bankDetails BankDetails {BankDetails}
defaultPayOptions
This object forms the basis of the Employees payment.
 PayOptions {PayOptions}
hmrcDetails HmrcDetails {HmrcDetails}
defaultPension PensionSelection {PensionSelection}
rtiSubmissionSettings RtiSubmissionSettings {RtiSubmissionSettings}
autoEnrolmentSettings AutoEnrolmentSettings {AutoEnrolmentSettings}
accruePayCodeSetUniqueId string uuid "string"
leaveSettings LeaveSettings {LeaveSettings}
settings
Miscellaneous settings related to the employer that don't naturally belong in other models
 EmployerSettings {EmployerSettings}
umbrellaSettings UmbrellaSettings {UmbrellaSettings}
employeeCount
The number of Employees this Employer has, including CIS Subcontractors.
 integer int32 0
subcontractorCount
The number of CIS Subcontractors this Employer has.
 integer int32 0
startYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024"
currentYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024"
supportAccessEnabled
If set to true then the support team can access this employer to help resolve
support queries
 boolean true
archived
A flag to indicate whather or not the employer is Archived, ie no longer actively used
 boolean true
canUseBureauFeatures boolean true
multiRoleEnabled boolean true
educationPayrollEnabled boolean true
effectiveDateWorkingPatternsEnabled boolean true
backPayEnabled boolean true
isOptedInToEvc
Indicates whether or not the Employer is opted in to the Employee Verification Programme.
Value can only be changed by its dedicated API end point.
 boolean true
evcId
If set then this will be used as the Employer ID sent to EVC in place of the standard EmployerId.
 string uuid "string"
holidayAccrualBasis string "RegularPayOnly" "AllGrossPay" "PaycodeSet" "WorkingPatternHours"
holidayAccrualDefaultRateType string "HourlyRate" "AverageHolidayRate" "FixedPeriodAmount"
mfaEnabled
if set to true requires all users to setup MFA
support queries
 boolean true
departmentJournalOverridesEnabled
Enables the journal overrides for departments, if set to true.
 boolean true
costCentreJournalOverridesEnabled
Enables the journal overrides for cost centre, if set to true.
 boolean true
settingsSortPayrollNumbersAlphanumerically
Enables the default sorting to be alphanumerically for payroll code, if set to true else numerical sorting will be applied
 boolean true
unauthorisedLeaveProRataRule string "WorkingPattern" "TwoSixtyDaysNotWorked" "TwoSixtyDaysWorked" "ThreeSixFiveDaysNotWorked" "ThreeSixFiveDaysWorked" "CalendarDays" "WorkingDays"
holidayLeaveProRataRule string "WorkingPattern" "TwoSixtyDaysNotWorked" "TwoSixtyDaysWorked" "ThreeSixFiveDaysNotWorked" "ThreeSixFiveDaysWorked" "CalendarDays" "WorkingDays"
sickLeaveProRataRule string "WorkingPattern" "TwoSixtyDaysNotWorked" "TwoSixtyDaysWorked" "ThreeSixFiveDaysNotWorked" "ThreeSixFiveDaysWorked" "CalendarDays" "WorkingDays"
parentalLeaveProRataRule string "WorkingPattern" "TwoSixtyDaysNotWorked" "TwoSixtyDaysWorked" "ThreeSixFiveDaysNotWorked" "ThreeSixFiveDaysWorked" "CalendarDays" "WorkingDays"
bereavementLeaveProRataRule string "WorkingPattern" "TwoSixtyDaysNotWorked" "TwoSixtyDaysWorked" "ThreeSixFiveDaysNotWorked" "ThreeSixFiveDaysWorked" "CalendarDays" "WorkingDays"
id
The unique id of the object
 string uuid "string"
sourceSystemId
Can only be given a value when the employer is created. It can then never be changed.
Used by external systems so they can store an immutable reference
 string "string"

JSON Example 

{
  "name": "string",
  "crn": "string",
  "logoUrl": "string",
  "logoSasUrl": "string",
  "alternativeId": "string",
  "bankPaymentsCsvFormat": "StandardCsv",
  "bacsServiceUserNumber": "string",
  "bacsBureauNumber": "string",
  "rejectInvalidBankDetails": true,
  "bankPaymentsReferenceFormat": "string",
  "bacsIncludeAEO": true,
  "bacsIncludeDeductions": true,
  "bacsIncludeHmrc": true,
  "bacsIncludePensions": true,
  "useTenantRtiSubmissionSettings": true,
  "address": {
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "line5": "string",
    "postCode": "string",
    "country": "England",
    "foreignCountry": "string"
  },
  "bankDetails": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string",
    "buildingSocietyRollNumber": "string"
  },
  "defaultPayOptions": {
    "period": "Custom",
    "ordinal": 0,
    "method": "Cash",
    "withholdTaxRefundIfPayIsZero": true,
    "taxAndNi": {
      "niTable": "string",
      "secondaryClass1NotPayable": true,
      "postgradLoan": true,
      "postgraduateLoanStartDate": "2024-11-21",
      "postgraduateLoanEndDate": "2024-11-21",
      "studentLoan": "None",
      "studentLoanStartDate": "2024-11-21",
      "studentLoanEndDate": "2024-11-21",
      "taxCode": "string",
      "week1Month1": true,
      "foreignTaxCredit": true
    },
    "fpsFields": {
      "offPayrollWorker": true,
      "irregularPaymentPattern": true,
      "nonIndividual": true,
      "hoursNormallyWorked": "LessThan16",
      "excludeFromRtiSubmissions": true
    },
    "tags": [
      "string"
    ],
    "basis": "Hourly",
    "nationalMinimumWage": true,
    "payCode": "string",
    "mileageVehicleType": "Car",
    "mapsMiles": 0,
    "payAmount": 0.0,
    "payAmountMultiplier": 0.0,
    "baseHourlyRate": 0.0,
    "baseDailyRate": 0.0,
    "basicPay": 0.0,
    "autoAdjustForLeave": true,
    "niTable": "string",
    "regularPayLines": [
      {
        "value": 0.0,
        "rate": 0.0,
        "multiplier": 0.0,
        "description": "string",
        "attachmentOrderId": "string",
        "pensionId": "string",
        "leaveId": "string",
        "loanId": "string",
        "leaveStatutoryDaysPaid": 0.0,
        "leaveStatutoryWeeksPaid": 0.0,
        "code": "string",
        "tags": [
          "string"
        ],
        "childId": "string",
        "isNetToGross": true,
        "targetNetToGrossValue": 0.0,
        "netToGrossDiscrepancy": 0.0,
        "effectiveFrom": "2024-11-21",
        "effectiveTo": "2024-11-21",
        "department": "string",
        "costCentre": "string",
        "departmentId": "string",
        "costCentreId": "string",
        "isAutoGeneratedBasicPayLine": true,
        "percentageOfEffectiveDays": 0.0,
        "totalWorkingDays": 0.0,
        "isAutomaticBackPay": true,
        "ignoreInitialBackPay": true,
        "initialBackPayPublicPayRunId": "string",
        "autoAdjustForLeave": true,
        "contributesToBasicPay": true,
        "calculateAsWhenPaid": true,
        "totalPaidDays": 0.0,
        "roleId": "string",
        "employeeRoleReference": "string",
        "earnedFrom": "2024-11-21",
        "earnedTo": "2024-11-21",
        "periodFrom": "2024-11-21",
        "periodTo": "2024-11-21",
        "annualValue": 0.0,
        "parentId": "string",
        "isAutoCalculatedBackPayLine": true,
        "isZeroHoursTeachersBackPayLine": true,
        "analysisCategoriesCodes": [
          {
            "analysisCategory": "string",
            "analysisCategoryCode": "string",
            "analysisCategoryId": "string",
            "analysisCategoryCodeId": "string"
          }
        ],
        "analysisCategoryCodeIds": [
          "string"
        ],
        "paySpineId": "string",
        "paySpineGradeId": "string",
        "spinalPointId": "string",
        "londonAllowanceId": 0,
        "fullTimeAnnualValue": 0.0,
        "paySpine": "string",
        "payGrade": "string",
        "spinePoint": "string"
      }
    ]
  },
  "hmrcDetails": {
    "officeNumber": "string",
    "payeReference": "string",
    "accountsOfficeReference": "string",
    "econ": "string",
    "utr": "string",
    "coTax": "string",
    "employmentAllowance": true,
    "employmentAllowanceMaxClaim": 0.0,
    "smallEmployersRelief": true,
    "apprenticeshipLevy": true,
    "apprenticeshipLevyAllowance": 0.0,
    "quarterlyPaymentSchedule": true,
    "includeEmploymentAllowanceOnMonthlyJournal": true,
    "carryForwardUnpaidLiabilities": true,
    "paymentDateRule": "OnPayDate",
    "paymentDateDayOfMonth": 0,
    "id": "string"
  },
  "defaultPension": {
    "id": "string",
    "pensionSchemeId": "string",
    "pensionScheme": {
      "name": "string",
      "provider": {
        "name": "string",
        "accountNo": "string",
        "portal": "string",
        "website": "string",
        "address": "error too many levels",
        "telephone": "string",
        "papdisVersion": "PAP10",
        "papdisProviderId": "string",
        "papdisEmployerId": "string",
        "csvFormat": "Papdis",
        "excludeNilPaidFromContributions": true,
        "payPeriodDateAdjustment": 0,
        "miscBoolean1": true,
        "miscBoolean2": true,
        "miscString1": "string",
        "miscString2": "string",
        "optOutWindow": 0,
        "optOutWindowIsMonths": true,
        "id": "string"
      },
      "administrator": {
        "name": "string",
        "email": "string",
        "address": "error too many levels",
        "telephone": "string",
        "id": "string"
      },
      "pensionRule": "ReliefAtSource",
      "qualifyingScheme": true,
      "disableAeLetters": true,
      "subtractBasicRateTax": true,
      "payMethod": "Cash",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string",
        "buildingSocietyRollNumber": "string"
      },
      "useCustomPayCodes": true,
      "useCustomPayCodesForTierablePay": true,
      "customPayCodes": [
        "string"
      ],
      "tierablePayCustomPayCodes": [
        "string"
      ],
      "workerGroups": [
        {
          "name": "string",
          "contributionLevelType": "UserDefined",
          "employeeContribution": 0.0,
          "employeeContributionIsPercentage": true,
          "employerContribution": 0.0,
          "employerContributionIsPercentage": true,
          "employerContributionTopUpPercentage": 0.0,
          "employerContributionIncludesNiSaving": true,
          "employerContributionNiSavingPercentage": 0.0,
          "isAvc": true,
          "additionalVoluntaryContribution": 0.0,
          "avcIsPercentage": true,
          "employerContributionNiSaving": 0.0,
          "customThreshold": true,
          "lowerLimit": 0.0,
          "upperLimit": 0.0,
          "papdisGroup": "string",
          "papdisSubGroup": "string",
          "localAuthorityNumber": "string",
          "schoolEmployerType": "string",
          "matIdentifier": "string",
          "matUniqueNumber": "string",
          "employerReference": "string",
          "lgpsFund": "Avon",
          "workerGroupId": "string",
          "assumedPensionablePay": "AssumedPensionablePay",
          "pensionablePayDefinition": "NotApplicable",
          "payslipDescription": "string",
          "id": "string"
        }
      ],
      "externalDataProviderId": "SmartPension_Employer",
      "externalDataCompany": {
        "id": "string",
        "name": "string",
        "schemeName": "string"
      },
      "payCodeType": "Default",
      "tierablePayPayCodeType": "Default",
      "payCodeSetUniqueId": "string",
      "tierablePayPayCodeSetUniqueId": "string",
      "paymentDateRule": "OnPayDate",
      "paymentDateDayOfWeek": "Sunday",
      "paymentDateDayOfMonth": 0,
      "reportOptionsLgpsIConnect": {
        "fileType": "SingleFile",
        "payrollReference1": "Empty",
        "payrollReference2": "Empty",
        "payrollReference3": "Empty",
        "populateEmailAddress": true,
        "populateTelephoneNumber": true,
        "populateMobileNumber": true,
        "populateWorksPlaceName": true,
        "populateWorksAddress": true,
        "populateWorksEmailAddress": true,
        "includeEmploymentBreaks": true,
        "breakReasonSmpIndicatorOnly": true,
        "populateMaritalStatus": true,
        "includeAeQualifyingEarnings": true,
        "proRatePtHoursByTermTimeWeeks": true,
        "ignoreTermTimeWeeksForFteFinalPay": true,
        "showFteAnnualSalaryForFteFinalPay": true,
        "casualStaffHoursAsOne": true,
        "casualStaffIndicatorAsY": true,
        "ignoreHours": true,
        "forceUpperCase": true,
        "salaryType": "PayOnJoining",
        "customText": "string"
      },
      "reportOptionsLgpsCivicaUpm": {
        "payrollNumber": "PayrollCode",
        "casualHours": "ReportAsZero",
        "omitHeaderLine": true,
        "includeFolderNo": true,
        "excludeSchoolEmployerName": true,
        "addressesForNewJoinersOnly": true,
        "proRatePtHoursWeeksWorked": true,
        "fullTimeHoursAsOneHundred": true,
        "includeWeeksWorkedColumns": true
      },
      "deficitValueOrdinal": 0,
      "deficitValue": 0.0,
      "includeDeficitValue": true,
      "deficitValuePayPeriod": "Custom",
      "nominalCodeMappings": [
        {
          "nominalCode": "string",
          "nominalName": "string",
          "journalNarrative": "string",
          "payCode": "string"
        }
      ],
      "id": "string"
    },
    "workerGroupId": "string"
  },
  "rtiSubmissionSettings": {
    "senderType": "ActingInCapacity",
    "senderId": "string",
    "password": "string",
    "excludeNilPaid": true,
    "includeHashCrossRef": true,
    "autoSubmitFps": true,
    "testInLive": true,
    "useTestGateway": true,
    "overrideTimestampValue": "string",
    "contact": {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "telephone": "string"
    },
    "agent": {
      "agentId": "string",
      "company": "string",
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England",
        "foreignCountry": "string"
      },
      "contact": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "telephone": "string"
      }
    },
    "allowLinkedEps": true,
    "shouldCompressFps": true,
    "autoSubmitEps": true
  },
  "autoEnrolmentSettings": {
    "stagingDate": "2024-11-21",
    "cyclicalReenrolmentDate": "2024-11-21",
    "previousCyclicalReenrolmentDate": "2024-11-21",
    "defaultPension": {
      "id": "string",
      "pensionSchemeId": "string",
      "pensionScheme": {
        "name": "string",
        "provider": "error too many levels",
        "administrator": "error too many levels",
        "pensionRule": "ReliefAtSource",
        "qualifyingScheme": true,
        "disableAeLetters": true,
        "subtractBasicRateTax": true,
        "payMethod": "Cash",
        "bankDetails": "error too many levels",
        "useCustomPayCodes": true,
        "useCustomPayCodesForTierablePay": true,
        "customPayCodes": [
          "string"
        ],
        "tierablePayCustomPayCodes": [
          "string"
        ],
        "workerGroups": "error too many levels",
        "externalDataProviderId": "SmartPension_Employer",
        "externalDataCompany": "error too many levels",
        "payCodeType": "Default",
        "tierablePayPayCodeType": "Default",
        "payCodeSetUniqueId": "string",
        "tierablePayPayCodeSetUniqueId": "string",
        "paymentDateRule": "OnPayDate",
        "paymentDateDayOfWeek": "Sunday",
        "paymentDateDayOfMonth": 0,
        "reportOptionsLgpsIConnect": "error too many levels",
        "reportOptionsLgpsCivicaUpm": "error too many levels",
        "deficitValueOrdinal": 0,
        "deficitValue": 0.0,
        "includeDeficitValue": true,
        "deficitValuePayPeriod": "Custom",
        "nominalCodeMappings": "error too many levels",
        "id": "string"
      },
      "workerGroupId": "string"
    },
    "pensionSameAsDefault": true,
    "daysToDeferAssessment": 0,
    "deferByMonthsNotDays": true,
    "deferEnrolmentBy": 0,
    "deferEnrolmentByPeriodType": "Days",
    "includeNonPensionedEmployeesInSubmission": true,
    "id": "string"
  },
  "accruePayCodeSetUniqueId": "string",
  "leaveSettings": {
    "useDefaultHolidayType": true,
    "useDefaultAllowanceResetDate": true,
    "useDefaultAllowance": true,
    "useDefaultAccruePaymentInLieu": true,
    "useDefaultAccruePaymentInLieuRate": true,
    "useDefaultHolidayAccrualBasis": true,
    "useDefaultAccruePaymentInLieuPayAutomatically": true,
    "useDefaultAccrueHoursPerDay": true,
    "useDefaultMaximumAccruePeriod": true,
    "allowanceResetDate": "2024-11-21",
    "allowance": 0.0,
    "adjustment": 0.0,
    "allowanceUsed": 0.0,
    "allowanceUsedPreviousPeriod": 0.0,
    "allowanceRemaining": 0.0,
    "holidayType": "Days",
    "accrueSetAmount": true,
    "accrueHoursPerDay": 0.0,
    "showAllowanceOnPayslip": true,
    "showAhpOnPayslip": true,
    "accruePaymentInLieuRate": 0.0,
    "accruePaymentInLieuAllGrossPay": true,
    "accruePaymentInLieuPayAutomatically": true,
    "accruePayCodeSetUniqueId": "string",
    "maximumAccruePeriod": 0.0,
    "holidayAccrualBasis": "RegularPayOnly",
    "holidayAccrualDefaultRateType": "HourlyRate",
    "occupationalSicknessUniqueId": "string",
    "accruedPaymentLiability": 0.0,
    "accruedPaymentAdjustment": 0.0,
    "accruedPaymentPaid": 0.0,
    "accruedPaymentBalance": 0.0,
    "accruedHoursAmount": 0.0,
    "accruedHoursAdjustment": 0.0,
    "accruedHoursPaid": 0.0,
    "accruedHoursAmountLastPeriod": 0.0,
    "paidHoursAmountLastPeriod": 0.0,
    "accruedHoursBalance": 0.0,
    "aggregatedServiceDate": "2024-11-21",
    "useAggregatedServiceDate": true,
    "useDefaultHolidayAccrualDefaultRateType": true,
    "unauthorisedLeaveProRataRule": "WorkingPattern",
    "holidayLeaveProRataRule": "WorkingPattern",
    "sickLeaveProRataRule": "WorkingPattern",
    "parentalLeaveProRataRule": "WorkingPattern",
    "bereavementLeaveProRataRule": "WorkingPattern"
  },
  "settings": {
    "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
  },
  "umbrellaSettings": {
    "enabled": true,
    "chargePerTimesheet": 0.0,
    "apprenticeshipLevyDednRate": 0.0,
    "holidayRate": 0.0,
    "dpsbCode": "string",
    "expensesCode": "string",
    "grossDeductionCode": "string",
    "holidayCode": "string",
    "cisFeeCode": "string",
    "detailFeeInComment": true
  },
  "employeeCount": 0,
  "subcontractorCount": 0,
  "startYear": "Year2017",
  "currentYear": "Year2017",
  "supportAccessEnabled": true,
  "archived": true,
  "canUseBureauFeatures": true,
  "multiRoleEnabled": true,
  "educationPayrollEnabled": true,
  "effectiveDateWorkingPatternsEnabled": true,
  "backPayEnabled": true,
  "isOptedInToEvc": true,
  "evcId": "string",
  "holidayAccrualBasis": "RegularPayOnly",
  "holidayAccrualDefaultRateType": "HourlyRate",
  "mfaEnabled": true,
  "departmentJournalOverridesEnabled": true,
  "costCentreJournalOverridesEnabled": true,
  "settingsSortPayrollNumbersAlphanumerically": true,
  "unauthorisedLeaveProRataRule": "WorkingPattern",
  "holidayLeaveProRataRule": "WorkingPattern",
  "sickLeaveProRataRule": "WorkingPattern",
  "parentalLeaveProRataRule": "WorkingPattern",
  "bereavementLeaveProRataRule": "WorkingPattern",
  "id": "string",
  "sourceSystemId": "string"
}

References

Contained in Models

- none -

Consumed by Operations
Create an Employer
Update an Employer
Returned by Operations
Create an Employer
Get an Employer
Update an Employer
Update Employer Logo
Getting Started Create Employer
Getting Started Understanding PayOptions