Employer

Name / Description Type / Format Example
name string "string"
crn
Company Registration Number
string "string"
logoUrl string "string"
alternativeId string "string"
bankPaymentsCsvFormat string "StandardCsv" "Telleroo" "BarclaysBacs" "SantanderBacs" "Sif" "Revolut" "Standard18FasterPayments" "Standard18Bacs" "Bankline" "BanklineBulk" "StandardCsvBacs" "LloydsMultipleStandardCsvBacs" "LloydsV11CsvBacs" "CoOpBulkCsvBacs" "CoOpFasterPaymentsCsv"
bacsServiceUserNumber string "string"
bacsBureauNumber string "string"
rejectInvalidBankDetails boolean true
bankPaymentsReferenceFormat string "string"
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}
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"
currentYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022"
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
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"
{
  "name": "string",
  "crn": "string",
  "logoUrl": "string",
  "alternativeId": "string",
  "bankPaymentsCsvFormat": "StandardCsv",
  "bacsServiceUserNumber": "string",
  "bacsBureauNumber": "string",
  "rejectInvalidBankDetails": true,
  "bankPaymentsReferenceFormat": "string",
  "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"
  },
  "defaultPayOptions": {
    "period": "Custom",
    "ordinal": 0,
    "payAmount": 0.0,
    "basis": "Hourly",
    "nationalMinimumWage": true,
    "payAmountMultiplier": 0.0,
    "baseHourlyRate": 0.0,
    "baseDailyRate": 0.0,
    "autoAdjustForLeave": true,
    "method": "Cash",
    "payCode": "string",
    "withholdTaxRefundIfPayIsZero": true,
    "mileageVehicleType": "Car",
    "mapsMiles": 0,
    "taxAndNi": {
      "niTable": "string",
      "secondaryClass1NotPayable": true,
      "postgradLoan": true,
      "postgraduateLoanStartDate": "2022-06-29",
      "postgraduateLoanEndDate": "2022-06-29",
      "studentLoan": "None",
      "studentLoanStartDate": "2022-06-29",
      "studentLoanEndDate": "2022-06-29",
      "taxCode": "string",
      "week1Month1": true
    },
    "fpsFields": {
      "offPayrollWorker": true,
      "irregularPaymentPattern": true,
      "nonIndividual": true,
      "hoursNormallyWorked": "LessThan16"
    },
    "regularPayLines": [
      {
        "value": 0.0,
        "rate": 0.0,
        "multiplier": 0.0,
        "description": "string",
        "attachmentOrderId": "string",
        "pensionId": "string",
        "leaveId": "string",
        "leaveStatutoryDaysPaid": 0.0,
        "leaveStatutoryWeeksPaid": 0.0,
        "code": "string",
        "tags": [
          "string"
        ]
      }
    ],
    "tags": [
      "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,
    "id": "string"
  },
  "defaultPension": {
    "id": "string",
    "pensionSchemeId": "string",
    "pensionScheme": {
      "name": "string",
      "provider": {
        "name": "string",
        "accountNo": "string",
        "portal": "string",
        "website": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "line4": "string",
          "line5": "string",
          "postCode": "string",
          "country": "England",
          "foreignCountry": "string"
        },
        "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": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "line4": "string",
          "line5": "string",
          "postCode": "string",
          "country": "England",
          "foreignCountry": "string"
        },
        "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"
      },
      "useCustomPayCodes": true,
      "customPayCodes": [
        "string"
      ],
      "workerGroups": [
        {
          "name": "string",
          "contributionLevelType": "UserDefined",
          "employeeContribution": 0.0,
          "employeeContributionIsPercentage": true,
          "employerContribution": 0.0,
          "employerContributionIsPercentage": true,
          "employerContributionTopUpPercentage": 0.0,
          "customThreshold": true,
          "lowerLimit": 0.0,
          "upperLimit": 0.0,
          "papdisGroup": "string",
          "papdisSubGroup": "string",
          "localAuthorityNumber": "string",
          "schoolEmployerType": "string",
          "workerGroupId": "string",
          "id": "string"
        }
      ],
      "externalDataProviderId": "SmartPension_Employer",
      "externalDataCompany": {
        "id": "string",
        "name": "string",
        "schemeName": "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"
      }
    }
  },
  "autoEnrolmentSettings": {
    "stagingDate": "2022-06-29",
    "cyclicalReenrolmentDate": "2022-06-29",
    "previousCyclicalReenrolmentDate": "2022-06-29",
    "defaultPension": {
      "id": "string",
      "pensionSchemeId": "string",
      "pensionScheme": {
        "name": "string",
        "provider": {
          "name": "string",
          "accountNo": "string",
          "portal": "string",
          "website": "string",
          "address": {
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "line4": "string",
            "line5": "string",
            "postCode": "string",
            "country": "England",
            "foreignCountry": "string"
          },
          "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": {
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "line4": "string",
            "line5": "string",
            "postCode": "string",
            "country": "England",
            "foreignCountry": "string"
          },
          "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"
        },
        "useCustomPayCodes": true,
        "customPayCodes": [
          "string"
        ],
        "workerGroups": [
          {
            "name": "string",
            "contributionLevelType": "UserDefined",
            "employeeContribution": 0.0,
            "employeeContributionIsPercentage": true,
            "employerContribution": 0.0,
            "employerContributionIsPercentage": true,
            "employerContributionTopUpPercentage": 0.0,
            "customThreshold": true,
            "lowerLimit": 0.0,
            "upperLimit": 0.0,
            "papdisGroup": "string",
            "papdisSubGroup": "string",
            "localAuthorityNumber": "string",
            "schoolEmployerType": "string",
            "workerGroupId": "string",
            "id": "string"
          }
        ],
        "externalDataProviderId": "SmartPension_Employer",
        "externalDataCompany": {
          "id": "string",
          "name": "string",
          "schemeName": "string"
        },
        "id": "string"
      },
      "workerGroupId": "string"
    },
    "pensionSameAsDefault": true,
    "daysToDeferAssessment": 0,
    "deferByMonthsNotDays": true,
    "deferEnrolmentBy": 0,
    "deferEnrolmentByPeriodType": "Days",
    "includeNonPensionedEmployeesInSubmission": true,
    "id": "string"
  },
  "leaveSettings": {
    "useDefaultHolidayType": true,
    "useDefaultAllowanceResetDate": true,
    "useDefaultAllowance": true,
    "useDefaultAccruePaymentInLieu": true,
    "useDefaultAccruePaymentInLieuRate": true,
    "useDefaultAccruePaymentInLieuAllGrossPay": true,
    "useDefaultAccruePaymentInLieuPayAutomatically": true,
    "useDefaultAccrueHoursPerDay": true,
    "allowanceResetDate": "2022-06-29",
    "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,
    "accruedPaymentLiability": 0.0,
    "accruedPaymentAdjustment": 0.0,
    "accruedPaymentPaid": 0.0,
    "accruedPaymentBalance": 0.0
  },
  "settings": {
    "allowNegativePay": 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,
  "id": "string",
  "sourceSystemId": "string"
}
Contained in Models

- none -

Consumed by Operations
Create an Employer
Update an Employer
Getting Started Create Employer
Getting Started Understanding PayOptions