GrossToNetReport

Name / Description Type / Format Example
employer Item {Item}
taxYear string "Year2020" "Year2019" "Year2018" "Year2017"
payPeriod string "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
startPeriodName string "string"
endPeriodName string "string"
startDate string date-time "2020-01-17T15:29:59"
endDate string date-time "2020-01-17T15:29:59"
forCis boolean true
lines GrossToNetReportLine[] {GrossToNetReportLine}
cisLines GrossToNetReportCisLine[] {GrossToNetReportCisLine}
{
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "taxYear": "Year2020",
  "payPeriod": "Monthly",
  "startPeriodName": "string",
  "endPeriodName": "string",
  "startDate": "2020-01-17T15:29:59",
  "endDate": "2020-01-17T15:29:59",
  "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
    }
  ]
}
Contained in Models
ReportResponse[GrossToNetReport]
Consumed by Operations

- none -

Returned by Operations

- none -