HolidayReportReportResponse

Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Name / Description Type / Format Example
type
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
content
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
model HolidayReport {HolidayReport}
stream
byte array
string byte "string"
{
  "type": "string",
  "content": "string",
  "model": {
    "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-03-19",
          "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-03-19",
          "useAggregatedServiceDate": true,
          "useDefaultHolidayAccrualDefaultRateType": true
        }
      }
    ],
    "report": "GrossToNet",
    "taxYear": "Year2017",
    "title": "string",
    "isDraft": true
  },
  "stream": "string"
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Holiday