VarianceReportReportResponse

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 VarianceReport {VarianceReport}
{
  "type": "string",
  "content": "string",
  "model": {
    "showDifferenceAsPercentage": true,
    "minimumChangePercentage": 0.0,
    "primary": {
      "employer": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "taxYear": "Year2017",
      "payPeriod": "Monthly",
      "ordinal": 0,
      "startPeriodName": "string",
      "endPeriodName": "string",
      "startDate": "2020-07-10",
      "endDate": "2020-07-10",
      "forCis": true,
      "lines": [
        {
          "employee": {
            "id": "string",
            "name": "string",
            "metadata": {},
            "url": "string"
          },
          "payrollCode": "string",
          "department": "string",
          "totalGross": 0.0,
          "taxableGross": 0.0,
          "netPay": 0.0,
          "tax": 0.0,
          "employeeNi": 0.0,
          "employerNi": 0.0,
          "employeePension": 0.0,
          "employerPension": 0.0,
          "studentOrPgLoan": 0.0,
          "statutoryPayments": 0.0,
          "attachments": 0.0,
          "otherDeductions": 0.0
        }
      ],
      "cisLines": [
        {
          "employee": {
            "id": "string",
            "name": "string",
            "metadata": {},
            "url": "string"
          },
          "payrollCode": "string",
          "department": "string",
          "totalGross": 0.0,
          "labour": 0.0,
          "materials": 0.0,
          "taxableGross": 0.0,
          "cisDeduction": 0.0,
          "umbrellaFee": 0.0,
          "vat": 0.0,
          "payment": 0.0
        }
      ]
    },
    "secondary": {
      "employer": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "taxYear": "Year2017",
      "payPeriod": "Monthly",
      "ordinal": 0,
      "startPeriodName": "string",
      "endPeriodName": "string",
      "startDate": "2020-07-10",
      "endDate": "2020-07-10",
      "forCis": true,
      "lines": [
        {
          "employee": {
            "id": "string",
            "name": "string",
            "metadata": {},
            "url": "string"
          },
          "payrollCode": "string",
          "department": "string",
          "totalGross": 0.0,
          "taxableGross": 0.0,
          "netPay": 0.0,
          "tax": 0.0,
          "employeeNi": 0.0,
          "employerNi": 0.0,
          "employeePension": 0.0,
          "employerPension": 0.0,
          "studentOrPgLoan": 0.0,
          "statutoryPayments": 0.0,
          "attachments": 0.0,
          "otherDeductions": 0.0
        }
      ],
      "cisLines": [
        {
          "employee": {
            "id": "string",
            "name": "string",
            "metadata": {},
            "url": "string"
          },
          "payrollCode": "string",
          "department": "string",
          "totalGross": 0.0,
          "labour": 0.0,
          "materials": 0.0,
          "taxableGross": 0.0,
          "cisDeduction": 0.0,
          "umbrellaFee": 0.0,
          "vat": 0.0,
          "payment": 0.0
        }
      ]
    },
    "joiners": [
      {
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "payrollCode": "string",
        "department": "string",
        "totalGross": 0.0,
        "taxableGross": 0.0,
        "netPay": 0.0,
        "tax": 0.0,
        "employeeNi": 0.0,
        "employerNi": 0.0,
        "employeePension": 0.0,
        "employerPension": 0.0,
        "studentOrPgLoan": 0.0,
        "statutoryPayments": 0.0,
        "attachments": 0.0,
        "otherDeductions": 0.0
      }
    ],
    "leavers": [
      {
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "payrollCode": "string",
        "department": "string",
        "totalGross": 0.0,
        "taxableGross": 0.0,
        "netPay": 0.0,
        "tax": 0.0,
        "employeeNi": 0.0,
        "employerNi": 0.0,
        "employeePension": 0.0,
        "employerPension": 0.0,
        "studentOrPgLoan": 0.0,
        "statutoryPayments": 0.0,
        "attachments": 0.0,
        "otherDeductions": 0.0
      }
    ],
    "hasDepartments": true,
    "commonLines": [
      {
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "payrollCode": "string",
        "department": "string",
        "totalGross": 0.0,
        "taxableGross": 0.0,
        "netPay": 0.0,
        "tax": 0.0,
        "employeeNi": 0.0,
        "employerNi": 0.0,
        "employeePension": 0.0,
        "employerPension": 0.0,
        "studentOrPgLoan": 0.0,
        "statutoryPayments": 0.0,
        "attachments": 0.0,
        "otherDeductions": 0.0
      }
    ],
    "hasVariances": true
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Variance Report