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 "Monthly" "FourWeekly" "Fortnightly" "Weekly"
period integer int32 0
from string date-time "2019-11-13T23:42:10"
to string date-time "2019-11-13T23:42:10"
payments PayRunPayment[] {PayRunPayment}
{
  "taxYear": "Year2017",
  "payPeriod": "Monthly",
  "period": 0,
  "from": "2019-11-13T23:42:10",
  "to": "2019-11-13T23:42:10",
  "payments": [
    {
      "type": "Employee",
      "payee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "date": "2019-11-13T23:42:10",
      "method": "Cash",
      "amount": 0.0,
      "reference": "string",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string"
      },
      "bacsHash": "string"
    }
  ]
}
Consumed by Operations

- none -

Returned by Operations

- none -