| Name / Description | Type / Format | Example | |
|---|---|---|---|
personalDetails
|
Contract.PersonalDetailsRequest
|
{Contract.PersonalDetailsRequest}
|
|
employmentDetails
|
Contract.EmploymentDetailsRequest
|
{Contract.EmploymentDetailsRequest}
|
|
autoEnrolment
|
Contract.AutoEnrolmentRequest
|
{Contract.AutoEnrolmentRequest}
|
|
leaveSettings
|
Contract.EmployeeLeaveSettingsRequest
|
{Contract.EmployeeLeaveSettingsRequest}
|
|
rightToWork
|
Contract.RightToWork
|
{Contract.RightToWork}
|
|
bankDetails
|
Contract.BankDetails
|
{Contract.BankDetails}
|
|
payOptions
|
Contract.PayOptionsRequest
|
{Contract.PayOptionsRequest}
|
|
tags
|
string[]
|
|
|
holidaySchemeUniqueId
|
string
uuid
|
"string"
|
|
aggregatedServiceDate
|
string
date
|
"2025-06-28"
|
|
evcId
If set then this will be used as the EmployeeIDFromProduct sent to EVC in place of the standard EmployeeId.
|
string
uuid
|
"string"
|
|
defaultPensionSchemeUniqueId
The UniqueId of the Pension Scheme that will be used for this employee.
|
string
uuid
|
"string"
|
|
defaultPensionSchemeName
The name of the Pension Scheme that will be used for this employee.
|
string
|
"string"
|
|
defaultWorkerGroupUniqueId
The UniqueId of the Worker Group that will be used for this employee.
|
string
uuid
|
"string"
|
|
defaultWorkerGroupName
The name of the Worker Group that will be used for this employee.
|
string
|
"string"
|
|
sourceSystemId
Used by external systems so they can store an immutable reference.
Once this property is set it cannot be changed. |
string
|
"string"
|
{
"personalDetails": {
"address": {
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"line5": "string",
"postCode": "string",
"country": "England",
"foreignCountry": "string"
},
"maritalStatus": "Single",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"alternativeEmail": "string",
"previousSurName": "string",
"email": "string",
"emailPayslip": true,
"pdfPassword": "string",
"pdfPasswordType": "InitialsAndDob",
"emailStatement": true,
"photoUrl": "string",
"telephone": "string",
"photoSasUrl": "string",
"mobile": "string",
"dateOfBirth": "2025-06-28",
"gender": "Male",
"niNumber": "string",
"passportNumber": "string",
"partnerDetails": {
"firstName": "string",
"initials": "string",
"lastName": "string",
"niNumber": "string"
}
},
"employmentDetails": {
"cis": {
"verification": {
"manuallyEntered": true,
"matchInsteadOfVerify": true,
"number": "string",
"date": "2025-06-28",
"taxStatus": "Gross",
"verificationResponse": "error too many levels"
},
"type": "SoleTrader",
"utr": "string",
"tradingName": "string",
"companyUtr": "string",
"companyNumber": "string",
"vatRegistered": true,
"vatNumber": "string",
"vatRate": 0.0,
"reverseChargeVAT": true
},
"department": {
"code": "string",
"title": "string",
"color": "string",
"accountingCode": "string"
},
"cisSubContractor": true,
"payrollCode": "string",
"jobTitle": "string",
"workplacePostcode": "string",
"onHold": true,
"onFurlough": true,
"furloughStart": "2025-06-28",
"furloughEnd": "2025-06-28",
"furloughCalculationBasis": "ActualPaidAmount",
"furloughCalculationBasisAmount": 0.0,
"partialFurlough": true,
"furloughHoursNormallyWorked": 0.0,
"furloughHoursOnFurlough": 0.0,
"isApprentice": true,
"apprenticeshipStartDate": "2025-06-28",
"apprenticeshipEndDate": "2025-06-28",
"workingPattern": "string",
"forcePreviousPayrollCode": "string",
"starterDetails": {
"startDate": "2025-06-28",
"starterDeclaration": "A",
"overseasEmployerDetails": {
"overseasEmployer": true,
"overseasSecondmentStatus": "None",
"eeaCitizen": true,
"epm6Scheme": true
},
"pensionerPayroll": {
"inReceiptOfPension": true,
"bereaved": true,
"amount": 0.0,
"startDate": "2025-06-28"
}
},
"directorshipDetails": {
"isDirector": true,
"startDate": "2025-06-28",
"leaveDate": "2025-06-28",
"niAlternativeMethod": true
},
"leaverDetails": {
"hasLeft": true,
"leaveDate": "2025-06-28",
"isDeceased": true,
"paymentAfterLeaving": true,
"p45Sent": true,
"payAccruedBalance": true,
"paymentMethodAfterLeaving": "RegularPayMethod"
},
"roles": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"isWorkingInFreePort": true,
"isWorkingInInvestmentZone": true,
"veteranDetails": {
"isVeteran": true,
"firstCivilianEmploymentDate": "2025-06-28"
},
"continuousEmploymentDate": "2025-06-28"
},
"autoEnrolment": {
"lastAssessment": {
"assessmentDate": "2025-06-28"
},
"ukWorker": "No",
"daysToDeferAssessment": 0,
"deferByMonthsNotDays": true,
"exempt": true,
"aeExclusionCode": "NotKnown",
"aePostponementLetterSent": true
},
"leaveSettings": {
"useDefaultHolidayType": true,
"useDefaultAllowanceResetDate": true,
"useDefaultAllowance": true,
"useDefaultAccruePaymentInLieu": true,
"useDefaultAccruePaymentInLieuRate": true,
"useDefaultAccruePaymentInLieuAllGrossPay": true,
"useDefaultHolidayAccrualBasis": true,
"useDefaultAccruePaymentInLieuPayAutomatically": true,
"useDefaultAccrueHoursPerDay": true,
"useDefaultMaximumAccruePeriod": true,
"allowanceResetDate": "2025-06-28",
"allowance": 0.0,
"adjustment": 0.0,
"holidayType": "Days",
"accrueSetAmount": true,
"accrueHoursPerDay": 0.0,
"showAllowanceOnPayslip": true,
"showAhpOnPayslip": true,
"accruePaymentInLieuRate": 0.0,
"accruePaymentInLieuAllGrossPay": true,
"accruePaymentInLieuPayAutomatically": true,
"occupationalSicknessUniqueId": "string",
"accruedPaymentAdjustment": 0.0,
"accruedHoursAdjustment": 0.0,
"holidayAccrualBasis": "RegularPayOnly",
"holidayAccrualDefaultRateType": "HourlyRate",
"aggregatedServiceDate": "2025-06-28",
"useAggregatedServiceDate": true,
"accruePayCodeSetUniqueId": "string",
"maximumAccruePeriod": 0.0,
"holidayLeaveAccrualCustomRateType": "HourlyRate",
"useDefaultHolidayAccrualDefaultRateType": true
},
"rightToWork": {
"checked": true,
"documentType": "Other",
"documentRef": "string",
"documentExpiry": "2025-06-28",
"note": "string"
},
"bankDetails": {
"bankName": "string",
"bankBranch": "string",
"bankReference": "string",
"accountName": "string",
"accountNumber": "string",
"sortCode": "string",
"note": "string",
"buildingSocietyRollNumber": "string"
},
"payOptions": {
"regularPayLines": [
{
"analysisCategoryCodesJson": "string",
"value": 0.0,
"rate": 0.0,
"multiplier": 0.0,
"description": "string",
"code": "string",
"tags": [
"string"
],
"childId": "string",
"isNetToGross": true,
"targetNetToGrossValue": 0.0,
"netToGrossDiscrepancy": 0.0,
"effectiveFrom": "2025-06-28",
"effectiveTo": "2025-06-28",
"isAutoGeneratedBasicPayLine": true,
"percentageOfEffectiveDays": 0.0,
"totalWorkingDays": 0.0,
"autoAdjustForLeave": true,
"isAutomaticBackPay": true,
"ignoreInitialBackPay": true,
"contributesToBasicPay": true,
"calculateAsWhenPaid": true,
"totalPaidDays": 0.0,
"roleId": "string",
"earnedFrom": "2025-06-28",
"earnedTo": "2025-06-28",
"annualValue": 0.0,
"department": "string",
"costCentre": "string",
"departmentId": "string",
"costCentreId": "string",
"analysisCategoriesCodes": [
{
"analysisCategory": "string",
"analysisCategoryCode": "string",
"analysisCategoryId": "string",
"analysisCategoryCodeId": "string"
}
],
"analysisCategoryCodeIds": [
"string"
],
"paySpineId": "string",
"paySpineGradeId": "string",
"spinalPointId": "string",
"londonAllowanceId": 0,
"fullTimeAnnualValue": 0.0
}
],
"period": "Custom",
"ordinal": 0,
"method": "Cash",
"withholdTaxRefundIfPayIsZero": true,
"taxAndNi": {
"niTable": "string",
"secondaryClass1NotPayable": true,
"postgradLoan": true,
"postgraduateLoanStartDate": "2025-06-28",
"postgraduateLoanEndDate": "2025-06-28",
"studentLoan": "None",
"studentLoanStartDate": "2025-06-28",
"studentLoanEndDate": "2025-06-28",
"taxCode": "string",
"week1Month1": true,
"foreignTaxCredit": true
},
"fpsFields": {
"offPayrollWorker": true,
"irregularPaymentPattern": true,
"nonIndividual": true,
"excludeFromRtiSubmissions": true,
"hoursNormallyWorked": "LessThan16"
},
"tags": [
"string"
],
"basis": "Hourly",
"nationalMinimumWage": true,
"payCode": "string",
"mileageVehicleType": "Car",
"mapsMiles": 0,
"payAmount": 0.0,
"payAmountMultiplier": 0.0,
"baseHourlyRate": 0.0,
"baseDailyRate": 0.0,
"autoAdjustForLeave": true,
"niTable": "string"
},
"tags": [
"string"
],
"holidaySchemeUniqueId": "string",
"aggregatedServiceDate": "2025-06-28",
"evcId": "string",
"defaultPensionSchemeUniqueId": "string",
"defaultPensionSchemeName": "string",
"defaultWorkerGroupUniqueId": "string",
"defaultWorkerGroupName": "string",
"sourceSystemId": "string"
}- none -
- none -