PayrollAnalysisEmployeeRoleBreakdownReportLine

Name / Description Type / Format Example
employee Item {Item}
fullEmployee Employee {Employee}
employeeRole Item {Item}
department
Used to represent an Employees membership of a Department
DepartmentMembership {DepartmentMembership}
gross number double 0.0
niableGross number double 0.0
net number double 0.0
takeHome number double 0.0
employerNic number double 0.0
showQtyColumn boolean true
lines PayrollAnalysisEmployeeRoleBreakdownReportLineValue[] {PayrollAnalysisEmployeeRoleBreakdownReportLineValue}
ersPension number double 0.0
{
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "fullEmployee": {
    "holidaySchemeUniqueId": "string",
    "aggregatedServiceDate": "2024-07-13",
    "leaveHolidayAccrualDefaultRateType": "HourlyRate",
    "id": "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",
      "photoSasUrl": "string",
      "telephone": "string",
      "mobile": "string",
      "dateOfBirth": "2024-07-13",
      "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": "2024-07-13",
      "furloughEnd": "2024-07-13",
      "furloughCalculationBasis": "ActualPaidAmount",
      "furloughCalculationBasisAmount": 0.0,
      "partialFurlough": true,
      "furloughHoursNormallyWorked": 0.0,
      "furloughHoursOnFurlough": 0.0,
      "isApprentice": true,
      "apprenticeshipStartDate": "2024-07-13",
      "apprenticeshipEndDate": "2024-07-13",
      "workingPattern": "string",
      "forcePreviousPayrollCode": "string",
      "starterDetails": {
        "startDate": "2024-07-13",
        "starterDeclaration": "A",
        "overseasEmployerDetails": "error too many levels",
        "pensionerPayroll": "error too many levels"
      },
      "directorshipDetails": {
        "isDirector": true,
        "startDate": "2024-07-13",
        "leaveDate": "2024-07-13",
        "niAlternativeMethod": true
      },
      "leaverDetails": {
        "hasLeft": true,
        "leaveDate": "2024-07-13",
        "isDeceased": true,
        "paymentAfterLeaving": true,
        "p45Sent": true,
        "payAccruedBalance": true
      },
      "cis": {
        "type": "SoleTrader",
        "utr": "string",
        "tradingName": "string",
        "companyUtr": "string",
        "companyNumber": "string",
        "vatRegistered": true,
        "vatNumber": "string",
        "vatRate": 0.0,
        "reverseChargeVAT": true,
        "verification": "error too many levels"
      },
      "department": {
        "code": "string",
        "title": "string",
        "color": "string",
        "employeeCount": 0,
        "accountingCode": "string",
        "hasJournalOverrides": true
      },
      "roles": [
        {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        }
      ],
      "isWorkingInFreePort": true,
      "veteranDetails": {
        "isVeteran": true,
        "firstCivilianEmploymentDate": "2024-07-13"
      },
      "continuousEmploymentDate": "2024-07-13",
      "includeSecondedInfoOnStarter": true,
      "isWorkingInInvestmentZone": true
    },
    "autoEnrolment": {
      "state": "Automatic",
      "stateDate": "2024-07-13",
      "ukWorker": "No",
      "daysToDeferAssessment": 0,
      "postponementDate": "2024-07-13",
      "deferByMonthsNotDays": true,
      "exempt": true,
      "aeExclusionCode": "NotKnown",
      "aePostponementLetterSent": true,
      "lastAssessment": {
        "assessmentDate": "2024-07-13T21:33:15",
        "employeeState": "Automatic",
        "age": 0,
        "ukWorker": "No",
        "payPeriod": "Custom",
        "ordinal": 0,
        "earningsInPeriod": 0.0,
        "qualifyingEarningsInPeriod": 0.0,
        "aeExclusionCode": "NotKnown",
        "status": "Eligible",
        "reason": "string",
        "action": "error too many levels",
        "startReportingType": "UsePayRun",
        "endReportingType": "UsePayRun",
        "startPayRunEntryId": 0,
        "endPayRunEntryId": 0,
        "employee": "error too many levels",
        "id": "string"
      }
    },
    "leaveSettings": {
      "useDefaultHolidayType": true,
      "useDefaultAllowanceResetDate": true,
      "useDefaultAllowance": true,
      "useDefaultAccruePaymentInLieu": true,
      "useDefaultAccruePaymentInLieuRate": true,
      "useDefaultHolidayAccrualBasis": true,
      "useDefaultAccruePaymentInLieuPayAutomatically": true,
      "useDefaultAccrueHoursPerDay": true,
      "useDefaultMaximumAccruePeriod": true,
      "allowanceResetDate": "2024-07-13",
      "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,
      "accruePayCodeSetUniqueId": "string",
      "maximumAccruePeriod": 0.0,
      "holidayAccrualBasis": "RegularPayOnly",
      "holidayAccrualDefaultRateType": "HourlyRate",
      "occupationalSicknessUniqueId": "string",
      "accruedPaymentLiability": 0.0,
      "accruedPaymentAdjustment": 0.0,
      "accruedPaymentPaid": 0.0,
      "accruedPaymentBalance": 0.0,
      "accruedHoursAmount": 0.0,
      "accruedHoursAdjustment": 0.0,
      "accruedHoursPaid": 0.0,
      "accruedHoursAmountLastPeriod": 0.0,
      "paidHoursAmountLastPeriod": 0.0,
      "accruedHoursBalance": 0.0,
      "aggregatedServiceDate": "2024-07-13",
      "useAggregatedServiceDate": true,
      "useDefaultHolidayAccrualDefaultRateType": true
    },
    "rightToWork": {
      "checked": true,
      "documentType": "Other",
      "documentRef": "string",
      "documentExpiry": "2024-07-13",
      "note": "string"
    },
    "bankDetails": {
      "bankName": "string",
      "bankBranch": "string",
      "bankReference": "string",
      "accountName": "string",
      "accountNumber": "string",
      "sortCode": "string",
      "note": "string",
      "buildingSocietyRollNumber": "string"
    },
    "tags": [
      "string"
    ],
    "payOptions": {
      "period": "Custom",
      "ordinal": 0,
      "method": "Cash",
      "withholdTaxRefundIfPayIsZero": true,
      "taxAndNi": {
        "niTable": "string",
        "secondaryClass1NotPayable": true,
        "postgradLoan": true,
        "postgraduateLoanStartDate": "2024-07-13",
        "postgraduateLoanEndDate": "2024-07-13",
        "studentLoan": "None",
        "studentLoanStartDate": "2024-07-13",
        "studentLoanEndDate": "2024-07-13",
        "taxCode": "string",
        "week1Month1": true,
        "foreignTaxCredit": true
      },
      "fpsFields": {
        "offPayrollWorker": true,
        "irregularPaymentPattern": true,
        "nonIndividual": 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,
      "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-07-13",
          "effectiveTo": "2024-07-13",
          "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-07-13",
          "earnedTo": "2024-07-13",
          "periodFrom": "2024-07-13",
          "periodTo": "2024-07-13",
          "annualValue": 0.0,
          "parentId": "string",
          "isAutoCalculatedBackPayLine": true,
          "isZeroHoursTeachersBackPayLine": true,
          "analysisCategoriesCodes": "error too many levels",
          "analysisCategoryCodeIds": [
            "string"
          ],
          "paySpineId": "string",
          "paySpineGradeId": "string",
          "spinalPointId": "string",
          "londonAllowanceId": 0,
          "fullTimeAnnualValue": 0.0,
          "paySpine": "string",
          "payGrade": "string",
          "spinePoint": "string"
        }
      ]
    },
    "status": "Current",
    "aeNotEnroledWarning": true,
    "sourceSystemId": "string",
    "evcId": "string"
  },
  "employeeRole": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "department": {
    "code": "string",
    "color": "string",
    "title": "string",
    "primary": true,
    "weighting": 0.0,
    "employeeRoleUniqueId": "string"
  },
  "gross": 0.0,
  "niableGross": 0.0,
  "net": 0.0,
  "takeHome": 0.0,
  "employerNic": 0.0,
  "showQtyColumn": true,
  "lines": [
    {
      "qty": 0.0,
      "code": "string",
      "value": 0.0
    }
  ],
  "ersPension": 0.0
}
Consumed by Operations

- none -

Returned by Operations

- none -