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.

Name / Description Type / Format Example
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal integer int32 0
period integer int32 0
from string date "2020-07-13"
to string date "2020-07-13"
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"
{
  "taxYear": "Year2017",
  "payPeriod": "Custom",
  "ordinal": 0,
  "period": 0,
  "from": "2020-07-13",
  "to": "2020-07-13",
  "payments": [
    {
      "type": "Employee",
      "payee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "date": "2020-07-13",
      "method": "Cash",
      "amount": 0.0,
      "reference": "string",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string"
      },
      "bacsHash": "string"
    }
  ],
  "status": "Queued",
  "statusMessage": "string",
  "link": "string"
}
Consumed by Operations

- none -

Returned by Operations

- none -