Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details
| Name / Description | Type / Format | Example | |
|---|---|---|---|
lines
|
PayRunSummaryLine[]
|
{PayRunSummaryLine}
|
|
date
The PaymentDate from the PayRun
|
string
date
|
"2025-12-13"
|
|
title
The status of the task for posting this journal to an ExternalDataProvider
|
string
|
"string"
|
|
status
|
string
|
"Queued"
"Sent"
"Failed"
"Processing"
|
|
statusMessage
A message to elaborate on the Status
|
string
|
"string"
|
|
link
If available, a link to the journal in the ExternalDataProvider
|
string
|
"string"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
"Year2025"
|
|
payPeriod
|
string
|
"Custom"
"Monthly"
"FourWeekly"
"Fortnightly"
"Weekly"
"Daily"
|
|
ordinal
|
integer
int32
|
0
|
|
period
|
integer
int32
|
0
|
|
mergeMatchingNominals
|
boolean
|
true
|
|
csvFormat
|
string
|
"Default"
"SapS4Hana"
"MappedOutput"
|
{
"lines": [
{
"nominalCode": "string",
"departmentCode": "string",
"nominalName": "string",
"description": "string",
"qty": 0.0,
"value": 0.0,
"payCode": {
"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"
},
"costCentreCode": "string",
"analysisCategories": [
{
"name": "string"
}
],
"analysisCategoryCodes": [
{
"code": "string",
"title": "string",
"color": "string",
"accountingCode": "string"
}
],
"employeeUniqueId": "string",
"journalNarrative": "string",
"pensionId": "string",
"employee": {
"holidaySchemeUniqueId": "string",
"aggregatedServiceDate": "2025-12-13",
"leaveHolidayAccrualDefaultRateType": "HourlyRate",
"defaultPensionSchemeUniqueId": "string",
"defaultPensionSchemeName": "string",
"defaultWorkerGroupUniqueId": "string",
"defaultWorkerGroupName": "string",
"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": "2025-12-13",
"statePensionAge": 0,
"gender": "Male",
"niNumber": "string",
"passportNumber": "string",
"partnerDetails": "error too many levels"
},
"employmentDetails": {
"cisSubContractor": true,
"payrollCode": "string",
"jobTitle": "string",
"workplacePostcode": "string",
"onHold": true,
"onFurlough": true,
"furloughStart": "2025-12-13",
"furloughEnd": "2025-12-13",
"furloughCalculationBasis": "ActualPaidAmount",
"furloughCalculationBasisAmount": 0.0,
"partialFurlough": true,
"furloughHoursNormallyWorked": 0.0,
"furloughHoursOnFurlough": 0.0,
"isApprentice": true,
"apprenticeshipStartDate": "2025-12-13",
"apprenticeshipEndDate": "2025-12-13",
"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": "2025-12-13",
"includeSecondedInfoOnStarter": true,
"isWorkingInInvestmentZone": true
},
"autoEnrolment": {
"state": "Automatic",
"stateDate": "2025-12-13",
"ukWorker": "No",
"daysToDeferAssessment": 0,
"postponementDate": "2025-12-13",
"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": "2025-12-13",
"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,
"holidayAccrualResetDate": "2025-12-13",
"aggregatedServiceDate": "2025-12-13",
"useAggregatedServiceDate": true,
"useDefaultHolidayAccrualDefaultRateType": true,
"unauthorisedLeaveProRataRule": "WorkingPattern",
"holidayLeaveProRataRule": "WorkingPattern",
"sickLeaveProRataRule": "WorkingPattern",
"parentalLeaveProRataRule": "WorkingPattern",
"bereavementLeaveProRataRule": "WorkingPattern"
},
"rightToWork": {
"checked": true,
"documentType": "Other",
"documentRef": "string",
"documentExpiry": "2025-12-13",
"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"
},
"unMappedNominalCode": "string"
}
],
"date": "2025-12-13",
"title": "string",
"status": "Queued",
"statusMessage": "string",
"link": "string",
"taxYear": "Year2017",
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"mergeMatchingNominals": true,
"csvFormat": "Default"
}- none -
- none -