Employer

Name / Description Type / Format Example
name string "string"
logoUrl string "string"
bankPaymentsCsvFormat string "StandardCsv" "Telleroo" "BarclaysBacs" "SantanderBacs" "Sif"
address Address {Address}
bankDetails BankDetails {BankDetails}
defaultPayOptions PayOptions {PayOptions}
hmrcDetails HmrcDetails {HmrcDetails}
defaultPension PensionSelection {PensionSelection}
rtiSubmissionSettings RtiSubmissionSettings {RtiSubmissionSettings}
autoEnrolmentSettings AutoEnrolmentSettings {AutoEnrolmentSettings}
leaveSettings
The default LeaveSettings. Only the Allowance and AllowanceResetDate fields are used.
LeaveSettings {LeaveSettings}
umbrellaSettings
Umbrella Settings for this Employer.
UmbrellaSettings {UmbrellaSettings}
employeeCount
The number of Employees this Employer has.
integer int32 0
startYear
The Tax Year in which the Employer started processing payroll in the application.
This can't be changed once PayRuns have been started
string "Year2017" "Year2018" "Year2019" "Year2020"
currentYear
The Tax Year the Employer is currently processing payroll for.
This is automatically incremented after the Year End process has been run.
string "Year2017" "Year2018" "Year2019" "Year2020"
supportAccessEnabled
If set to true then the support team can access this employer to help resolve support queries
boolean true
id
The unique id of the object
string uuid "string"
{
  "name": "string",
  "logoUrl": "string",
  "bankPaymentsCsvFormat": "StandardCsv",
  "address": {
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "line5": "string",
    "postCode": "string",
    "country": "England"
  },
  "bankDetails": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string"
  },
  "defaultPayOptions": {
    "period": "Monthly",
    "payAmount": 0.0,
    "basis": "Hourly",
    "nationalMinimumWage": true,
    "payAmountMultiplier": 0.0,
    "autoAdjustForLeave": true,
    "method": "Cash",
    "payCode": "string",
    "withholdTaxRefundIfPayIsZero": true,
    "mileageVehicleType": "Car",
    "mapsMiles": 0,
    "taxAndNi": {
      "niTable": "string",
      "secondaryClass1NotPayable": true,
      "postgradLoan": true,
      "studentLoan": "None",
      "taxCode": "string",
      "week1Month1": true
    },
    "fpsFields": {
      "irregularPaymentPattern": true,
      "nonIndividual": true,
      "hoursNormallyWorked": "LessThan16",
      "flexibleDrawdown": {
        "hasFlexibleDrawdown": true,
        "death": true,
        "pension": true,
        "taxablePayment": 0.0,
        "nonTaxablePayment": 0.0
      },
      "trivialCommutationPayment": {
        "hasTrivialCommutationPayment": true,
        "tcls": 0.0,
        "personalPension": 0.0,
        "occupationalPension": 0.0
      }
    },
    "regularPayLines": [
      {
        "value": 0.0,
        "rate": 0.0,
        "multiplier": 0.0,
        "description": "string",
        "code": "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,
    "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"
        },
        "telephone": "string",
        "papdisVersion": "PAP10",
        "papdisProviderId": "string",
        "papdisEmployerId": "string",
        "csvFormat": "Papdis",
        "excludeNilPaidFromContributions": true,
        "payPeriodDateAdjustment": 0,
        "miscBoolean1": true,
        "miscBoolean2": true,
        "miscString1": "string",
        "id": "string"
      },
      "administrator": {
        "name": "string",
        "email": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "line4": "string",
          "line5": "string",
          "postCode": "string",
          "country": "England"
        },
        "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"
      },
      "workerGroups": [
        {
          "name": "string",
          "employeeContribution": 0.0,
          "employeeContributionIsPercentage": true,
          "employerContribution": 0.0,
          "employerContributionIsPercentage": true,
          "customThreshold": true,
          "lowerLimit": 0.0,
          "upperLimit": 0.0,
          "papdisGroup": "string",
          "papdisSubGroup": "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,
    "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"
      },
      "contact": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "telephone": "string"
      }
    },
    "id": "string"
  },
  "autoEnrolmentSettings": {
    "stagingDate": "2019-11-18T19:33:14",
    "cyclicalReenrolmentDate": "2019-11-18T19:33:14",
    "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"
          },
          "telephone": "string",
          "papdisVersion": "PAP10",
          "papdisProviderId": "string",
          "papdisEmployerId": "string",
          "csvFormat": "Papdis",
          "excludeNilPaidFromContributions": true,
          "payPeriodDateAdjustment": 0,
          "miscBoolean1": true,
          "miscBoolean2": true,
          "miscString1": "string",
          "id": "string"
        },
        "administrator": {
          "name": "string",
          "email": "string",
          "address": {
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "line4": "string",
            "line5": "string",
            "postCode": "string",
            "country": "England"
          },
          "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"
        },
        "workerGroups": [
          {
            "name": "string",
            "employeeContribution": 0.0,
            "employeeContributionIsPercentage": true,
            "employerContribution": 0.0,
            "employerContributionIsPercentage": true,
            "customThreshold": true,
            "lowerLimit": 0.0,
            "upperLimit": 0.0,
            "papdisGroup": "string",
            "papdisSubGroup": "string",
            "workerGroupId": "string",
            "id": "string"
          }
        ],
        "externalDataProviderId": "SmartPension_Employer",
        "externalDataCompany": {
          "id": "string",
          "name": "string",
          "schemeName": "string"
        },
        "id": "string"
      },
      "workerGroupId": "string"
    },
    "pensionSameAsDefault": true,
    "daysToDeferAssessment": 0,
    "includeNonPensionedEmployeesInSubmission": true,
    "id": "string"
  },
  "leaveSettings": {
    "useDefaultAllowanceResetDate": true,
    "useDefaultAllowance": true,
    "allowanceResetDate": "2019-11-18T19:33:14",
    "allowance": 0.0,
    "adjustment": 0.0,
    "allowanceUsed": 0.0,
    "allowanceRemaining": 0.0,
    "showAllowanceOnPayslip": true
  },
  "umbrellaSettings": {
    "enabled": true,
    "chargePerTimesheet": 0.0,
    "apprenticeshipLevyDednRate": 0.0,
    "holidayRate": 0.0,
    "dpsbCode": "string",
    "expensesCode": "string",
    "holidayCode": "string",
    "cisFeeCode": "string"
  },
  "employeeCount": 0,
  "startYear": "Year2017",
  "currentYear": "Year2017",
  "supportAccessEnabled": true,
  "id": "string"
}
Contained in Models

- none -

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