| Name / Description | Type / Format | Example | |
|---|---|---|---|
id
|
string
uuid
|
"string"
|
|
jobTitle
Job Title of the Role
|
string
|
"string"
|
|
isPrimary
Set to True if this is Primary role of the Employee
|
boolean
|
true
|
|
reference
|
string
|
"string"
|
|
startDate
|
string
date
|
"2025-11-04"
|
|
endDate
|
string
date
|
"2025-11-04"
|
|
basis
|
string
|
"NotApplicable"
"Permanent"
"Temporary"
"FixedTerm"
"ZeroHours"
"Casual"
"Supply"
|
|
type
|
string
|
"NotApplicable"
"Teacher"
"Support"
"Other"
|
|
displayName
|
string
|
"string"
|
|
payOptions
|
Contract.PayOptionsBaseResponse
|
{Contract.PayOptionsBaseResponse}
|
|
workingPattern
|
Contract.WorkingPatternResponse
|
{Contract.WorkingPatternResponse}
|
|
occupationalMaternityPolicyUniqueId
|
string
uuid
|
"string"
|
|
occupationalSicknessPolicyUniqueId
|
string
uuid
|
"string"
|
|
defaultPensionSchemeUniqueId
|
string
uuid
|
"string"
|
|
defaultWorkerGroupUniqueId
|
string
uuid
|
"string"
|
{
"id": "string",
"jobTitle": "string",
"isPrimary": true,
"reference": "string",
"startDate": "2025-11-04",
"endDate": "2025-11-04",
"basis": "NotApplicable",
"type": "NotApplicable",
"displayName": "string",
"payOptions": {
"regularPayLines": [
{
"id": "string",
"attachmentOrderId": "string",
"pensionId": "string",
"leaveId": "string",
"loanId": "string",
"leaveStatutoryDaysPaid": 0.0,
"leaveStatutoryWeeksPaid": 0.0,
"initialBackPayPublicPayRunId": "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-11-04",
"effectiveTo": "2025-11-04",
"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-11-04",
"earnedTo": "2025-11-04",
"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
}
],
"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"
},
"workingPattern": {
"id": "string",
"title": "string",
"mon": 0.0,
"tue": 0.0,
"wed": 0.0,
"thu": 0.0,
"fri": 0.0,
"sat": 0.0,
"sun": 0.0,
"contractedWeeks": 0.0,
"fullTimeContractedWeeks": 0.0,
"fullTimeContractedHours": 0.0,
"bankHolidays": "None",
"proRataRule": "WorkingDaysInPeriod",
"bankHolidayDates": [
"string"
],
"workingPatternHoursType": "HoursPerDay",
"isDefault": true,
"displayName": "string",
"totalHours": 0.0,
"workingPatternType": "Standard",
"effectiveFrom": "2025-11-04",
"shiftWorkingPatternDays": [
{
"day": 0,
"isWorkingDay": true,
"hours": 0.0
}
]
},
"occupationalMaternityPolicyUniqueId": "string",
"occupationalSicknessPolicyUniqueId": "string",
"defaultPensionSchemeUniqueId": "string",
"defaultWorkerGroupUniqueId": "string"
}- none -
- none -