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"
"Planday"
"Starling"
"Deputy"
"Bottomline"
"Twinfield"
"MyePayWindow"
"IFinance"
"AccountsIQ"
|
|
status
|
string
|
"Unmapped"
"Mapped"
"Ignored"
"Import"
|
|
employee
|
Item
|
{Item}
|
|
externalEmployee
|
Employee
|
{Employee}
|
|
lastSyncDate
The date and time this mapping was last synchronised
|
string
date
|
"2021-10-22"
|
{
"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,
"pdfPassword": "string",
"emailStatement": true,
"photoUrl": "string",
"telephone": "string",
"mobile": "string",
"dateOfBirth": "2021-10-22",
"statePensionAge": 0,
"gender": "Male",
"niNumber": "string",
"passportNumber": "string",
"partnerDetails": {
"firstName": "string",
"initials": "string",
"lastName": "string",
"niNumber": "string"
}
},
"employmentDetails": {
"cisSubContractor": true,
"payrollCode": "string",
"jobTitle": "string",
"onHold": true,
"onFurlough": true,
"furloughStart": "2021-10-22",
"furloughEnd": "2021-10-22",
"furloughCalculationBasis": "ActualPaidAmount",
"furloughCalculationBasisAmount": 0.0,
"partialFurlough": true,
"furloughHoursNormallyWorked": 0.0,
"furloughHoursOnFurlough": 0.0,
"isApprentice": true,
"workingPattern": "string",
"forcePreviousPayrollCode": "string",
"starterDetails": {
"startDate": "2021-10-22",
"starterDeclaration": "A",
"overseasEmployerDetails": {
"overseasEmployer": true,
"overseasSecondmentStatus": "MoreThan183Days",
"eeaCitizen": true,
"epm6Scheme": true
},
"pensionerPayroll": {
"inReceiptOfPension": true,
"bereaved": true,
"amount": 0.0
}
},
"directorshipDetails": {
"isDirector": true,
"startDate": "2021-10-22",
"leaveDate": "2021-10-22",
"niAlternativeMethod": true
},
"leaverDetails": {
"hasLeft": true,
"leaveDate": "2021-10-22",
"isDeceased": true,
"paymentAfterLeaving": true,
"p45Sent": true
},
"cis": {
"type": "SoleTrader",
"utr": "string",
"tradingName": "string",
"companyUtr": "string",
"companyNumber": "string",
"vatRegistered": true,
"vatNumber": "string",
"vatRate": 0.0,
"reverseChargeVAT": true,
"verification": {
"manuallyEntered": true,
"matchInsteadOfVerify": true,
"number": "string",
"date": "2021-10-22",
"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
},
"posts": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
]
},
"autoEnrolment": {
"state": "Automatic",
"stateDate": "2021-10-22",
"ukWorker": "No",
"daysToDeferAssessment": 0,
"postponementDate": "2021-10-22",
"deferByMonthsNotDays": true,
"exempt": true,
"aeExclusionCode": "NotKnown",
"aePostponementLetterSent": true,
"lastAssessment": {
"assessmentDate": "2021-10-22T01:06:31",
"employeeState": "Automatic",
"age": 0,
"ukWorker": "No",
"payPeriod": "Custom",
"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": {
"useDefaultHolidayType": true,
"useDefaultAllowanceResetDate": true,
"useDefaultAllowance": true,
"useDefaultAccruePaymentInLieu": true,
"useDefaultAccruePaymentInLieuRate": true,
"useDefaultAccruePaymentInLieuAllGrossPay": true,
"useDefaultAccruePaymentInLieuPayAutomatically": true,
"useDefaultAccrueHoursPerDay": true,
"allowanceResetDate": "2021-10-22",
"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
},
"rightToWork": {
"checked": true,
"documentType": "Other",
"documentRef": "string",
"documentExpiry": "2021-10-22",
"note": "string"
},
"bankDetails": {
"bankName": "string",
"bankBranch": "string",
"bankReference": "string",
"accountName": "string",
"accountNumber": "string",
"sortCode": "string",
"note": "string"
},
"tags": [
"string"
],
"payOptions": {
"period": "Custom",
"ordinal": 0,
"payAmount": 0.0,
"basis": "Hourly",
"nationalMinimumWage": true,
"payAmountMultiplier": 0.0,
"baseHourlyRate": 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"
},
"regularPayLines": [
{
"value": 0.0,
"rate": 0.0,
"multiplier": 0.0,
"description": "string",
"attachmentOrderId": "string",
"pensionId": "string",
"code": "string",
"tags": [
"string"
]
}
],
"tags": [
"string"
]
},
"status": "Current",
"aeNotEnroledWarning": true,
"sourceSystemId": "string"
},
"lastSyncDate": "2021-10-22"
}- none -