EmployeeRole

Name / Description Type / Format Example
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 "2024-06-24"
endDate string date "2024-06-24"
basis string "NotApplicable" "Permanent" "Temporary" "FixedTerm" "ZeroHours" "Casual" "Supply"
type string "NotApplicable" "Teacher" "Support" "Other"
payOptions EmployeeRolePayOptions {EmployeeRolePayOptions}
workingPatternId
Used when calculating payments for Leave.
If null then the default Working Pattern is used
string uuid "string"
occupationalMaternityPolicyUniqueId
Used for assigning occupational maternity policy
string uuid "string"
occupationalSicknessPolicyUniqueId
Used for assigning occupational sickness policy
string uuid "string"
employee Item {Item}
id
The unique id of the object
string uuid "string"
{
  "jobTitle": "string",
  "isPrimary": true,
  "reference": "string",
  "startDate": "2024-06-24",
  "endDate": "2024-06-24",
  "basis": "NotApplicable",
  "type": "NotApplicable",
  "payOptions": {
    "basis": "Hourly",
    "nationalMinimumWage": true,
    "payCode": "string",
    "mileageVehicleType": "Car",
    "mapsMiles": 0,
    "payAmount": 0.0,
    "payAmountMultiplier": 0.0,
    "baseHourlyRate": 0.0,
    "baseDailyRate": 0.0,
    "basicPay": 0.0,
    "autoAdjustForLeave": true,
    "niTable": "string",
    "regularPayLines": [
      {
        "value": 0.0,
        "rate": 0.0,
        "multiplier": 0.0,
        "description": "string",
        "attachmentOrderId": "string",
        "pensionId": "string",
        "leaveId": "string",
        "loanId": "string",
        "leaveStatutoryDaysPaid": 0.0,
        "leaveStatutoryWeeksPaid": 0.0,
        "code": "string",
        "tags": [
          "string"
        ],
        "childId": "string",
        "isNetToGross": true,
        "targetNetToGrossValue": 0.0,
        "netToGrossDiscrepancy": 0.0,
        "effectiveFrom": "2024-06-24",
        "effectiveTo": "2024-06-24",
        "department": "string",
        "costCentre": "string",
        "departmentId": "string",
        "costCentreId": "string",
        "isAutoGeneratedBasicPayLine": true,
        "percentageOfEffectiveDays": 0.0,
        "totalWorkingDays": 0.0,
        "isAutomaticBackPay": true,
        "ignoreInitialBackPay": true,
        "initialBackPayPublicPayRunId": "string",
        "autoAdjustForLeave": true,
        "contributesToBasicPay": true,
        "calculateAsWhenPaid": true,
        "totalPaidDays": 0.0,
        "roleId": "string",
        "employeeRoleReference": "string",
        "earnedFrom": "2024-06-24",
        "earnedTo": "2024-06-24",
        "periodFrom": "2024-06-24",
        "periodTo": "2024-06-24",
        "annualValue": 0.0,
        "parentId": "string",
        "isAutoCalculatedBackPayLine": true,
        "isZeroHoursTeachersBackPayLine": true,
        "analysisCategoriesCodes": [
          {
            "analysisCategory": "string",
            "analysisCategoryCode": "string",
            "analysisCategoryId": "string",
            "analysisCategoryCodeId": "string"
          }
        ],
        "analysisCategoryCodeIds": [
          "string"
        ],
        "paySpineId": "string",
        "paySpineGradeId": "string",
        "spinalPointId": "string",
        "londonAllowanceId": 0,
        "fullTimeAnnualValue": 0.0,
        "paySpine": "string",
        "payGrade": "string",
        "spinePoint": "string"
      }
    ],
    "id": "string"
  },
  "workingPatternId": "string",
  "occupationalMaternityPolicyUniqueId": "string",
  "occupationalSicknessPolicyUniqueId": "string",
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "id": "string"
}
Contained in Models

- none -