ExbReportResponse

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

Schema

Name / Description Type / Format Example
lines AveragePayGradesReportLine[] {AveragePayGradesReportLine}
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" "EmployeePayments"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024" "Year2025"
title string "string"
isDraft boolean true

JSON Example 

{
  "lines": [
    {
      "effectiveDate": "2025-09-13",
      "paySpineName": "string",
      "payGradeName": "string",
      "lowerGradePoint": "string",
      "upperGradePoint": "string",
      "upperPointAltMax": true,
      "employee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "payrollCode": "string",
      "department": "string"
    }
  ],
  "report": "GrossToNet",
  "taxYear": "Year2017",
  "title": "string",
  "isDraft": true
}

References

Contained in Models
PayGradesReportReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -