Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Name / Description Type / Format Example
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
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.
PayrunPaymentsReport {PayrunPaymentsReport}
  "type": "string",
  "content": "string",
  "model": {
    "payments": [
        "type": "Employee",
        "payee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        "date": "2022-08-12",
        "method": "Cash",
        "amount": 0.0,
        "reference": "string",
        "bankDetails": {
          "bankName": "string",
          "bankBranch": "string",
          "bankReference": "string",
          "accountName": "string",
          "accountNumber": "string",
          "sortCode": "string",
          "note": "string"
        "bacsHash": "string",
        "bacsSubReference": "string"
    "status": "Queued",
    "statusMessage": "string",
    "link": "string",
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    "payPeriod": "Custom",
    "ordinal": 0,
    "period": 0,
    "periodTo": 0,
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2022-08-12",
    "endDate": "2022-08-12",
    "report": "GrossToNet",
    "taxYear": "Year2017"
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
PayRun Payments