GrossToNetReport

Name / Description Type / Format Example
forCis boolean true
lines GrossToNetReportLine[] {GrossToNetReportLine}
cisLines GrossToNetReportCisLine[] {GrossToNetReportCisLine}
employer Item {Item}
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal integer int32 0
period integer int32 0
periodTo integer int32 0
startPeriodName string "string"
endPeriodName string "string"
startDate string date "2024-12-05"
endDate string date "2024-12-05"
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"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024"
title string "string"
isDraft boolean true
{
  "forCis": true,
  "lines": [
    {
      "niNumber": "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,
      "lastName": "string",
      "isNewStarter": true,
      "isLeaver": true,
      "employee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "payrollCode": "string",
      "department": "string"
    }
  ],
  "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,
      "lastName": "string"
    }
  ],
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "payPeriod": "Custom",
  "ordinal": 0,
  "period": 0,
  "periodTo": 0,
  "startPeriodName": "string",
  "endPeriodName": "string",
  "startDate": "2024-12-05",
  "endDate": "2024-12-05",
  "report": "GrossToNet",
  "taxYear": "Year2017",
  "title": "string",
  "isDraft": true
}
Consumed by Operations

- none -

Returned by Operations

- none -