HolidayReport

Schema

Name / Description Type / Format Example
accrualsReport boolean true
accrualsHrsReport boolean true
employer Item {Item}
lines HolidayReportLine[] {HolidayReportLine}
report string "GrossToNet" "GrossToNetCis" "PayrunPayments" "Furlough" "PensionContribs" "Journal" "HourlyPay" "UmbrellaReconciliation" "UmbrellaStatement" "StatutoryPay" "CostAnalysis" "CostOfEmployment" "FullSummaryOfPay" "P11" "P11d" "P30" "P32" "P45" "P60" "EmployeeExport" "RightToWork" "AeoStatement" "HolidayAllowances" "HolidayPayAccruals" "AeAssessments" "CisStatement" "SubcontractorSummary" "PayrollAnalysis" "VarianceReport" "P11Detailed" "NiLetterValidation" "Ytd" "TaxCodeChanges" "EmployeeBenefits" "MemberEnrolment" "AttachmentOrders" "NiYtd" "ApprenticeshipLevy" "TeachersPensionEoy" "MaternitySchedule" "PaySpine" "SpinePoint" "PayGrades" "PaySpineAllowances" "AverageHolidayPayRate" "EmployeeRoleExport" "HolidayPayAccrualsHours" "GenderPayGap" "PensionMemberships" "PayElement" "LoanBalances" "EmployeeLeave" "AdvancedVarianceReport"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024"
title string "string"
isDraft boolean true

JSON Example 

{
  "accrualsReport": true,
  "accrualsHrsReport": true,
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "lines": [
    {
      "employee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "payrollCode": "string",
      "department": "string",
      "dayRate": 0.0,
      "leaveSettings": {
        "useDefaultHolidayType": true,
        "useDefaultAllowanceResetDate": true,
        "useDefaultAllowance": true,
        "useDefaultAccruePaymentInLieu": true,
        "useDefaultAccruePaymentInLieuRate": true,
        "useDefaultHolidayAccrualBasis": true,
        "useDefaultAccruePaymentInLieuPayAutomatically": true,
        "useDefaultAccrueHoursPerDay": true,
        "useDefaultMaximumAccruePeriod": true,
        "allowanceResetDate": "2024-12-31",
        "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-12-31",
        "useAggregatedServiceDate": true,
        "useDefaultHolidayAccrualDefaultRateType": true,
        "unauthorisedLeaveProRataRule": "WorkingPattern",
        "holidayLeaveProRataRule": "WorkingPattern",
        "sickLeaveProRataRule": "WorkingPattern",
        "parentalLeaveProRataRule": "WorkingPattern",
        "bereavementLeaveProRataRule": "WorkingPattern"
      }
    }
  ],
  "report": "GrossToNet",
  "taxYear": "Year2017",
  "title": "string",
  "isDraft": true
}

References

Contained in Models
HolidayReportReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -