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

Name / Description Type / Format Example
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
model FurloughReport {FurloughReport}
  "type": "string",
  "content": "string",
  "model": {
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    "taxYear": "Year2017",
    "payPeriod": "Custom",
    "period": 0,
    "startDate": "2020-07-14",
    "endDate": "2020-07-14",
    "companyName": "string",
    "employerReference": "string",
    "companyCrn": "string",
    "ctUtr": "string",
    "saUtr": "string",
    "claimPeriodStartDate": "2020-07-14",
    "claimPeriodEndDate": "2020-07-14",
    "numberOfEmployeesBeingFurloughed": 0,
    "totalClaimAmount": 0.0,
    "totalGrossPay": 0.0,
    "amountClaimedForGrossPayToEmployeesOnFurloughForThePeriod": 0.0,
    "amountClaimedForEmployerNICsContributionsForFurloughedEmployees": 0.0,
    "amountClaimedForEmployersAutoEnrolmentPensionCostsForFurloughedEmployees": 0.0,
    "lines": [
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        "employeesFullName": "string",
        "employeesNINO": "string",
        "employeesPayrollReferenceNumber": "string",
        "furloughedDays": 0,
        "daysInPeriod": 0,
        "grossPay": 0.0,
        "grossPayClaim": 0.0,
        "niClaim": 0.0,
        "pensionClaim": 0.0,
        "totalClaim": 0.0,
        "furloughStart": "2020-07-14",
        "furloughEnd": "2020-07-14",
        "department": "string"
    "bankAccountNumber": "string",
    "bankSortCode": "string",
    "bankAccountHoldersFirstName": "string",
    "bankAccountHoldersLastName": "string",
    "bankAccountHoldersAddress": "string",
    "buildingSocietyRollNumber": "string",
    "companyAddress": "string",
    "contactName": "string",
    "contactNumber": "string"
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations