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"
bankPaymentsReferenceFormat string "string"
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}
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"
currentYear 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",
  "crn": "string",
  "logoUrl": "string",
  "alternativeId": "string",
  "bankPaymentsCsvFormat": "StandardCsv",
  "bankPaymentsReferenceFormat": "string",
  "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",
    "ordinal": 0,
    "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": {
      "offPayrollWorker": true,
      "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",
        "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,
    "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",
        "miscString2": "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",
          "contributionLevelType": "UserDefined",
          "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": "2020-07-10",
    "cyclicalReenrolmentDate": "2020-07-10",
    "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",
          "miscString2": "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",
            "contributionLevelType": "UserDefined",
            "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,
    "useDefaultAccruePaymentInLieu": true,
    "useDefaultAccruePaymentInLieuAllGrossPay": true,
    "useDefaultAccruePaymentInLieuPayAutomatically": true,
    "allowanceResetDate": "2020-07-10",
    "allowance": 0.0,
    "adjustment": 0.0,
    "allowanceUsed": 0.0,
    "allowanceUsedPreviousPeriod": 0.0,
    "allowanceRemaining": 0.0,
    "showAllowanceOnPayslip": true,
    "accruePaymentInLieu": true,
    "accruePaymentInLieuAllGrossPay": true,
    "accruePaymentInLieuPayAutomatically": true,
    "accruedPaymentLiability": 0.0,
    "accruedPaymentAdjustment": 0.0,
    "accruedPaymentPaid": 0.0,
    "accruedPaymentBalance": 0.0
  },
  "umbrellaSettings": {
    "enabled": true,
    "chargePerTimesheet": 0.0,
    "apprenticeshipLevyDednRate": 0.0,
    "holidayRate": 0.0,
    "dpsbCode": "string",
    "expensesCode": "string",
    "holidayCode": "string",
    "cisFeeCode": "string",
    "detailFeeInComment": true
  },
  "employeeCount": 0,
  "subcontractorCount": 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