| Name / Description | Type / Format | Example | |
|---|---|---|---|
address
|
Contract.Address
|
{Contract.Address}
|
|
bankDetails
|
Contract.BankDetails
|
{Contract.BankDetails}
|
|
defaultPayOptions
|
Contract.PayOptionsRequest
|
{Contract.PayOptionsRequest}
|
|
hmrcDetails
|
Contract.HmrcDetailsRequest
|
{Contract.HmrcDetailsRequest}
|
|
defaultPension
|
Contract.PensionSelectionRequest
|
{Contract.PensionSelectionRequest}
|
|
rtiSubmissionSettings
|
Contract.RtiSubmissionSettingsRequest
|
{Contract.RtiSubmissionSettingsRequest}
|
|
leaveSettings
|
Contract.EmployerLeaveSettingsRequest
|
{Contract.EmployerLeaveSettingsRequest}
|
|
settings
|
Contract.EmployerSettingsRequest
|
{Contract.EmployerSettingsRequest}
|
|
umbrellaSettings
|
Contract.UmbrellaSettingsRequest
|
{Contract.UmbrellaSettingsRequest}
|
|
autoEnrolmentSettings
|
Contract.AutoEnrolmentSettingsRequest
|
{Contract.AutoEnrolmentSettingsRequest}
|
|
id
|
string
uuid
|
"string"
|
|
name
|
string
|
"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"
|
|
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"
"BanklineBulkListDebit"
|
|
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
|
|
accruePayCodeSetUniqueId
|
string
uuid
|
"string"
|
|
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"
"Year2025"
|
|
currentYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
"Year2025"
|
|
supportAccessEnabled
[Deprecated] If set to true then the support team can access this employer to help resolve support queries.
If SupportAccessExpires is not provided support access will be turned off after 30 days. |
boolean
|
true
|
|
supportAccessExpires
The date and time when the support access expires
|
string
date
|
"2025-05-09"
|
|
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
|
|
displayName
|
string
|
"string"
|
|
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"
|
|
betaFeatures
|
string
|
"MultiRoleAe"
|
{
"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": {
"regularPayLines": [
{
"analysisCategoryCodesJson": "string",
"value": 0.0,
"rate": 0.0,
"multiplier": 0.0,
"description": "string",
"code": "string",
"tags": [
"string"
],
"childId": "string",
"isNetToGross": true,
"targetNetToGrossValue": 0.0,
"netToGrossDiscrepancy": 0.0,
"effectiveFrom": "2025-05-09",
"effectiveTo": "2025-05-09",
"isAutoGeneratedBasicPayLine": true,
"percentageOfEffectiveDays": 0.0,
"totalWorkingDays": 0.0,
"autoAdjustForLeave": true,
"isAutomaticBackPay": true,
"ignoreInitialBackPay": true,
"contributesToBasicPay": true,
"calculateAsWhenPaid": true,
"totalPaidDays": 0.0,
"roleId": "string",
"earnedFrom": "2025-05-09",
"earnedTo": "2025-05-09",
"annualValue": 0.0,
"department": "string",
"costCentre": "string",
"departmentId": "string",
"costCentreId": "string",
"analysisCategoriesCodes": [
{
"analysisCategory": "string",
"analysisCategoryCode": "string",
"analysisCategoryId": "string",
"analysisCategoryCodeId": "string"
}
],
"analysisCategoryCodeIds": [
"string"
],
"paySpineId": "string",
"paySpineGradeId": "string",
"spinalPointId": "string",
"londonAllowanceId": 0,
"fullTimeAnnualValue": 0.0
}
],
"period": "Custom",
"ordinal": 0,
"method": "Cash",
"withholdTaxRefundIfPayIsZero": true,
"taxAndNi": {
"niTable": "string",
"secondaryClass1NotPayable": true,
"postgradLoan": true,
"postgraduateLoanStartDate": "2025-05-09",
"postgraduateLoanEndDate": "2025-05-09",
"studentLoan": "None",
"studentLoanStartDate": "2025-05-09",
"studentLoanEndDate": "2025-05-09",
"taxCode": "string",
"week1Month1": true,
"foreignTaxCredit": true
},
"fpsFields": {
"offPayrollWorker": true,
"irregularPaymentPattern": true,
"nonIndividual": true,
"excludeFromRtiSubmissions": true,
"hoursNormallyWorked": "LessThan16"
},
"tags": [
"string"
],
"basis": "Hourly",
"nationalMinimumWage": true,
"payCode": "string",
"mileageVehicleType": "Car",
"mapsMiles": 0,
"payAmount": 0.0,
"payAmountMultiplier": 0.0,
"baseHourlyRate": 0.0,
"baseDailyRate": 0.0,
"autoAdjustForLeave": true,
"niTable": "string"
},
"hmrcDetails": {
"id": "string",
"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
},
"defaultPension": {
"id": "string",
"pensionSchemeId": "string",
"workerGroupId": "string",
"pensionScheme": {
"id": "string",
"name": "string",
"provider": {
"id": "string",
"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
},
"administrator": {
"id": "string",
"name": "string",
"email": "string",
"address": "error too many levels",
"telephone": "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": [
{
"id": "string",
"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"
}
],
"externalDataProviderId": "SmartPension_Employer",
"externalDataCompany": {
"id": "string",
"name": "string",
"schemeName": "string"
},
"displayName": "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"
}
]
},
"autoEnrolled": true
},
"rtiSubmissionSettings": {
"id": "string",
"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
},
"leaveSettings": {
"useDefaultHolidayType": true,
"useDefaultAllowanceResetDate": true,
"useDefaultAllowance": true,
"useDefaultAccruePaymentInLieu": true,
"useDefaultAccruePaymentInLieuRate": true,
"useDefaultHolidayAccrualBasis": true,
"useDefaultAccruePaymentInLieuPayAutomatically": true,
"useDefaultAccrueHoursPerDay": true,
"useDefaultMaximumAccruePeriod": true,
"allowanceResetDate": "2025-05-09",
"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": "2025-05-09",
"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
},
"autoEnrolmentSettings": {
"id": "string",
"stagingDate": "2025-05-09",
"cyclicalReenrolmentDate": "2025-05-09",
"previousCyclicalReenrolmentDate": "2025-05-09",
"defaultPension": {
"id": "string",
"pensionSchemeId": "string",
"workerGroupId": "string",
"pensionScheme": {
"id": "string",
"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",
"displayName": "string",
"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"
},
"autoEnrolled": true
},
"pensionSameAsDefault": true,
"daysToDeferAssessment": 0,
"deferByMonthsNotDays": true,
"deferEnrolmentBy": 0,
"deferEnrolmentByPeriodType": "Days",
"includeNonPensionedEmployeesInSubmission": true
},
"id": "string",
"name": "string",
"sourceSystemId": "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,
"accruePayCodeSetUniqueId": "string",
"employeeCount": 0,
"subcontractorCount": 0,
"startYear": "Year2017",
"currentYear": "Year2017",
"supportAccessEnabled": true,
"supportAccessExpires": "2025-05-09",
"archived": true,
"canUseBureauFeatures": true,
"multiRoleEnabled": true,
"educationPayrollEnabled": true,
"effectiveDateWorkingPatternsEnabled": true,
"backPayEnabled": true,
"displayName": "string",
"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",
"betaFeatures": "MultiRoleAe"
}- none -
- none -