PayrunPaymentsReport

After finalising a PayRun, employees need to actually be paid.
This model is returned by the Reports API and is used to provide details of a payment that needs to be made.

Schema

Name / Description Type / Format Example
payments PayRunPayment[] {PayRunPayment}
status string "Queued" "Sent" "Failed" "Processing"
statusMessage
A message to elaborate on the Status
 string "string"
link
If available, a link to the payments in an ExternalDataProvider
 string "string"
connectedExternalDataProvider ExternalDataProvider {ExternalDataProvider}
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

JSON Example 

{
  "payments": [
    {
      "type": "Employee",
      "payee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "date": "2024-12-22",
      "method": "Cash",
      "amount": 0.0,
      "reference": "string",
      "employerPaymentReference": "string",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string",
        "buildingSocietyRollNumber": "string"
      },
      "bacsHash": "string",
      "bacsSubReference": "string",
      "isBankDetailValid": true
    }
  ],
  "status": "Queued",
  "statusMessage": "string",
  "link": "string",
  "connectedExternalDataProvider": {
    "name": "string",
    "id": "SmartPension_Employer",
    "authScheme": "OAuth1",
    "logoUrl": "string",
    "iconUrl": "string",
    "connected": true,
    "connectedAs": "string",
    "requiresConfig": true,
    "deferralUrl": "string",
    "types": []
  },
  "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
}

References

Contained in Models
PayrunPaymentsReportReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -