ExternalEmployeeMapping

Used to represent details of an employee from an ExternalDataProvider, along with mapping information to an employee in the payroll system

Name / Description Type / Format Example
externalId
The id for the employee in the external system
string "string"
providerId string "SmartPension_Employer" "SmartPension_Adviser" "PeoplesPension" "Xero" "Qbo" "Sage" "Nest" "Cashplus" "BreatheHr" "KashFlow" "Reckon" "FreeAgent" "FreeAgentPm" "Modulr" "Square" "Cezanne" "Ciphr" "Telleroo" "WeWorked" "RotaCloud" "Quinyx" "Csod"
status string "Unmapped" "Mapped" "Ignored" "Import"
employee Item {Item}
externalEmployee Employee {Employee}
lastSyncDate
The date and time this mapping was last synchronised
string date "2020-07-12"
{
  "externalId": "string",
  "providerId": "SmartPension_Employer",
  "status": "Unmapped",
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "externalEmployee": {
    "id": "string",
    "personalDetails": {
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England"
      },
      "maritalStatus": "Single",
      "title": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "email": "string",
      "emailPayslip": true,
      "passwordProtectPayslip": true,
      "emailStatement": true,
      "photoUrl": "string",
      "telephone": "string",
      "mobile": "string",
      "dateOfBirth": "2020-07-12",
      "statePensionAge": 0,
      "gender": "Male",
      "niNumber": "string",
      "passportNumber": "string",
      "partnerDetails": {
        "firstName": "string",
        "initials": "string",
        "lastName": "string",
        "niNumber": "string"
      }
    },
    "employmentDetails": {
      "cisSubContractor": true,
      "payrollCode": "string",
      "jobTitle": "string",
      "onFurlough": true,
      "furloughStart": "2020-07-12",
      "furloughEnd": "2020-07-12",
      "furloughCalculationBasis": "ActualPaidAmount",
      "furloughCalculationBasisAmount": 0.0,
      "isApprentice": true,
      "workingPattern": "string",
      "forcePreviousPayrollCode": "string",
      "starterDetails": {
        "startDate": "2020-07-12",
        "starterDeclaration": "A",
        "overseasEmployerDetails": {
          "overseasEmployer": true,
          "overseasSecondmentStatus": "MoreThan183Days",
          "eeaCitizen": true,
          "epm6Scheme": true
        }
      },
      "directorshipDetails": {
        "isDirector": true,
        "startDate": "2020-07-12",
        "leaveDate": "2020-07-12",
        "niAlternativeMethod": true
      },
      "leaverDetails": {
        "hasLeft": true,
        "leaveDate": "2020-07-12",
        "isDeceased": true
      },
      "cis": {
        "type": "SoleTrader",
        "utr": "string",
        "tradingName": "string",
        "companyUtr": "string",
        "companyNumber": "string",
        "vatRegistered": true,
        "vatNumber": "string",
        "vatRate": 0.0,
        "verification": {
          "manuallyEntered": true,
          "matchInsteadOfVerify": true,
          "number": "string",
          "date": "2020-07-12",
          "taxStatus": "Gross",
          "verificationRequest": "string",
          "verificationResponse": {
            "employeeUniqueId": "string",
            "emailStatementTo": "string",
            "numberOfPayments": 0,
            "item": {
              "id": "string",
              "name": "string",
              "metadata": {},
              "url": "string"
            },
            "displayName": "string",
            "action": "string",
            "type": "string",
            "name": {
              "ttl": "string",
              "fore": [
                "string"
              ],
              "initials": "string",
              "sur": "string"
            },
            "tradingName": "string",
            "worksRef": "string",
            "unmatchedRate": "string",
            "utr": "string",
            "crn": "string",
            "nino": "string",
            "partnership": {
              "name": "string",
              "utr": "string"
            },
            "address": {
              "line": [
                "string"
              ],
              "postcode": "string",
              "postCode": "string",
              "ukPostcode": "string",
              "country": "string"
            },
            "telephone": "string",
            "totalPaymentsUnrounded": "string",
            "costOfMaterialsUnrounded": "string",
            "umbrellaFee": "string",
            "validationMsg": "string",
            "verificationNumber": "string",
            "totalPayments": "string",
            "costOfMaterials": "string",
            "totalDeducted": "string",
            "matched": "string",
            "taxTreatment": "string"
          }
        }
      },
      "department": {
        "code": "string",
        "title": "string",
        "color": "string",
        "employeeCount": 0
      }
    },
    "autoEnrolment": {
      "state": "Automatic",
      "stateDate": "2020-07-12",
      "ukWorker": "No",
      "daysToDeferAssessment": 0,
      "exempt": true,
      "aeExclusionCode": "NotKnown",
      "lastAssessment": {
        "assessmentDate": "2020-07-12T15:27:43",
        "employeeState": "Automatic",
        "age": 0,
        "ukWorker": "No",
        "payPeriod": "Monthly",
        "ordinal": 0,
        "earningsInPeriod": 0.0,
        "qualifyingEarningsInPeriod": 0.0,
        "aeExclusionCode": "NotKnown",
        "status": "Eligible",
        "reason": "string",
        "action": {
          "action": "NoChange",
          "employeeState": "Automatic",
          "actionCompleted": true,
          "actionCompletedMessage": "string",
          "requiredLetter": "B1",
          "pensionSchemeId": "string",
          "workerGroupId": "string",
          "letterNotYetSent": true
        },
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "id": "string"
      }
    },
    "leaveSettings": {
      "useDefaultAllowanceResetDate": true,
      "useDefaultAllowance": true,
      "useDefaultAccruePaymentInLieu": true,
      "useDefaultAccruePaymentInLieuAllGrossPay": true,
      "useDefaultAccruePaymentInLieuPayAutomatically": true,
      "allowanceResetDate": "2020-07-12",
      "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
    },
    "rightToWork": {
      "checked": true,
      "documentType": "Other",
      "documentRef": "string",
      "documentExpiry": "2020-07-12",
      "note": "string"
    },
    "bankDetails": {
      "bankName": "string",
      "bankBranch": "string",
      "bankReference": "string",
      "accountName": "string",
      "accountNumber": "string",
      "sortCode": "string",
      "note": "string"
    },
    "tags": [
      "string"
    ],
    "payOptions": {
      "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"
      ]
    },
    "status": "Current",
    "aeNotEnroledWarning": true
  },
  "lastSyncDate": "2020-07-12"
}
Contained in Models

- none -

Consumed by Operations
Update Employee
Returned by Operations
Get Employee
Update Employee