Name / Description | Type / Format | Example | |
---|---|---|---|
lines
|
PayrollAnalysisEmployeeRoleBreakdownReportLine[]
|
{PayrollAnalysisEmployeeRoleBreakdownReportLine}
|
|
payCodes
|
PayCode[]
|
{PayCode}
|
|
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-22"
|
|
endDate
|
string
date
|
"2024-12-22"
|
|
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
|
{
"lines": [
{
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"fullEmployee": {
"holidaySchemeUniqueId": "string",
"aggregatedServiceDate": "2024-12-22",
"leaveHolidayAccrualDefaultRateType": "HourlyRate",
"id": "string",
"personalDetails": {
"address": "error too many levels",
"maritalStatus": "Single",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"alternativeEmail": "string",
"previousSurName": "string",
"email": "string",
"emailPayslip": true,
"pdfPassword": "string",
"pdfPasswordType": "InitialsAndDob",
"emailStatement": true,
"photoUrl": "string",
"photoSasUrl": "string",
"telephone": "string",
"mobile": "string",
"dateOfBirth": "2024-12-22",
"statePensionAge": 0,
"gender": "Male",
"niNumber": "string",
"passportNumber": "string",
"partnerDetails": "error too many levels"
},
"employmentDetails": {
"cisSubContractor": true,
"payrollCode": "string",
"jobTitle": "string",
"onHold": true,
"onFurlough": true,
"furloughStart": "2024-12-22",
"furloughEnd": "2024-12-22",
"furloughCalculationBasis": "ActualPaidAmount",
"furloughCalculationBasisAmount": 0.0,
"partialFurlough": true,
"furloughHoursNormallyWorked": 0.0,
"furloughHoursOnFurlough": 0.0,
"isApprentice": true,
"apprenticeshipStartDate": "2024-12-22",
"apprenticeshipEndDate": "2024-12-22",
"workingPattern": "string",
"forcePreviousPayrollCode": "string",
"starterDetails": "error too many levels",
"directorshipDetails": "error too many levels",
"leaverDetails": "error too many levels",
"cis": "error too many levels",
"department": "error too many levels",
"roles": "error too many levels",
"isWorkingInFreePort": true,
"veteranDetails": "error too many levels",
"continuousEmploymentDate": "2024-12-22",
"includeSecondedInfoOnStarter": true,
"isWorkingInInvestmentZone": true
},
"autoEnrolment": {
"state": "Automatic",
"stateDate": "2024-12-22",
"ukWorker": "No",
"daysToDeferAssessment": 0,
"postponementDate": "2024-12-22",
"deferByMonthsNotDays": true,
"exempt": true,
"aeExclusionCode": "NotKnown",
"aePostponementLetterSent": true,
"lastAssessment": "error too many levels"
},
"leaveSettings": {
"useDefaultHolidayType": true,
"useDefaultAllowanceResetDate": true,
"useDefaultAllowance": true,
"useDefaultAccruePaymentInLieu": true,
"useDefaultAccruePaymentInLieuRate": true,
"useDefaultHolidayAccrualBasis": true,
"useDefaultAccruePaymentInLieuPayAutomatically": true,
"useDefaultAccrueHoursPerDay": true,
"useDefaultMaximumAccruePeriod": true,
"allowanceResetDate": "2024-12-22",
"allowance": 0.0,
"adjustment": 0.0,
"allowanceUsed": 0.0,
"allowanceUsedPreviousPeriod": 0.0,
"allowanceRemaining": 0.0,
"holidayType": "Days",
"accrueSetAmount": true,
"accrueHoursPerDay": 0.0,
"showAllowanceOnPayslip": true,
"showAhpOnPayslip": true,
"accruePaymentInLieuRate": 0.0,
"accruePaymentInLieuAllGrossPay": true,
"accruePaymentInLieuPayAutomatically": true,
"accruePayCodeSetUniqueId": "string",
"maximumAccruePeriod": 0.0,
"holidayAccrualBasis": "RegularPayOnly",
"holidayAccrualDefaultRateType": "HourlyRate",
"occupationalSicknessUniqueId": "string",
"accruedPaymentLiability": 0.0,
"accruedPaymentAdjustment": 0.0,
"accruedPaymentPaid": 0.0,
"accruedPaymentBalance": 0.0,
"accruedHoursAmount": 0.0,
"accruedHoursAdjustment": 0.0,
"accruedHoursPaid": 0.0,
"accruedHoursAmountLastPeriod": 0.0,
"paidHoursAmountLastPeriod": 0.0,
"accruedHoursBalance": 0.0,
"aggregatedServiceDate": "2024-12-22",
"useAggregatedServiceDate": true,
"useDefaultHolidayAccrualDefaultRateType": true,
"unauthorisedLeaveProRataRule": "WorkingPattern",
"holidayLeaveProRataRule": "WorkingPattern",
"sickLeaveProRataRule": "WorkingPattern",
"parentalLeaveProRataRule": "WorkingPattern",
"bereavementLeaveProRataRule": "WorkingPattern"
},
"rightToWork": {
"checked": true,
"documentType": "Other",
"documentRef": "string",
"documentExpiry": "2024-12-22",
"note": "string"
},
"bankDetails": {
"bankName": "string",
"bankBranch": "string",
"bankReference": "string",
"accountName": "string",
"accountNumber": "string",
"sortCode": "string",
"note": "string",
"buildingSocietyRollNumber": "string"
},
"tags": [
"string"
],
"payOptions": {
"period": "Custom",
"ordinal": 0,
"method": "Cash",
"withholdTaxRefundIfPayIsZero": true,
"taxAndNi": "error too many levels",
"fpsFields": "error too many levels",
"tags": [
"string"
],
"basis": "Hourly",
"nationalMinimumWage": true,
"payCode": "string",
"mileageVehicleType": "Car",
"mapsMiles": 0,
"payAmount": 0.0,
"payAmountMultiplier": 0.0,
"baseHourlyRate": 0.0,
"baseDailyRate": 0.0,
"basicPay": 0.0,
"autoAdjustForLeave": true,
"niTable": "string",
"regularPayLines": "error too many levels",
"excludedRegularPayLines": "error too many levels"
},
"status": "Current",
"aeNotEnroledWarning": true,
"sourceSystemId": "string",
"evcId": "string"
},
"employeeRole": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"department": {
"code": "string",
"color": "string",
"title": "string",
"primary": true,
"weighting": 0.0,
"employeeRoleUniqueId": "string"
},
"gross": 0.0,
"niableGross": 0.0,
"net": 0.0,
"takeHome": 0.0,
"employerNic": 0.0,
"showQtyColumn": true,
"lines": [
{
"qty": 0.0,
"code": "string",
"value": 0.0
}
],
"ersPension": 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,
"payee": "string"
}
],
"employer": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"periodTo": 0,
"startPeriodName": "string",
"endPeriodName": "string",
"startDate": "2024-12-22",
"endDate": "2024-12-22",
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
}
- none -
- none -