PaySchedulePeriodEvent

An Event within a PaySchedulePeriod. The event could be scheduled x days before PaymentDate.

Name / Description Type / Format Example
lines AdvancedVarianceReportLine[] {AdvancedVarianceReportLine}
payCodes PayCode[] {PayCode}
primaryPeriodName string "string"
secondaryPeriodName string "string"
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" "EmployeeLoanExport" "CombinedPensionContributions" "CyclicReenrolment"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024" "Year2025" "Year2026"
title string "string"
isDraft boolean true
{
  "lines": [
    {
      "employeeCode": "string",
      "employeeName": "string",
      "department": "string",
      "costCentre": "string",
      "primaryGrossTotal": 0.0,
      "secondaryGrossTotal": 0.0,
      "primaryGrossTaxable": 0.0,
      "secondaryGrossTaxable": 0.0,
      "primaryNetPay": 0.0,
      "secondaryNetPay": 0.0,
      "primaryTax": 0.0,
      "secondaryTax": 0.0,
      "primaryEmployeeNi": 0.0,
      "secondaryEmployeeNi": 0.0,
      "primaryEmployerNi": 0.0,
      "secondaryEmployerNi": 0.0,
      "primaryStudentOrPgLoan": 0.0,
      "secondaryStudentOrPgLoan": 0.0,
      "payCodeVarianceLines": [
        {
          "code": "string",
          "primaryValue": 0.0,
          "secondaryValue": 0.0
        }
      ]
    }
  ],
  "payCodes": [
    {
      "title": "string",
      "code": "string",
      "defaultValue": 0.0,
      "isDeduction": true,
      "isNiable": true,
      "isTaxable": true,
      "isPensionable": true,
      "isAttachable": true,
      "isRealTimeClass1aNiable": true,
      "isNotContributingToHolidayPay": true,
      "isQualifyingEarningsForAe": true,
      "isNotTierable": true,
      "isTcp_Tcls": true,
      "isTcp_Pp": true,
      "isTcp_Op": true,
      "flexibleDrawdown": "None",
      "isAutoAdjust": true,
      "calculationType": "FixedAmount",
      "multiplierType": "None",
      "dailyRateMultiplier": 0.0,
      "hourlyRateMultiplier": 0.0,
      "isSystemCode": true,
      "isControlCode": true,
      "isNotional": true,
      "isStandAloneLumpSum": true,
      "isPensionExcessLumpSum": true,
      "payee": "string",
      "isAdjustment": true
    }
  ],
  "primaryPeriodName": "string",
  "secondaryPeriodName": "string",
  "report": "GrossToNet",
  "taxYear": "Year2017",
  "title": "string",
  "isDraft": true
}
Consumed by Operations

- none -

Returned by Operations

- none -