FpsReportResponse

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

Name / Description Type / Format Example
type
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
content
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
model Fps {Fps}
stream
byte array
string byte "string"
{
  "type": "string",
  "content": "string",
  "model": {
    "lateReason": "NoneGiven",
    "paymentDate": "2024-06-25",
    "overridePaymentDate": "2024-06-25",
    "employeeCount": 0,
    "isCorrection": true,
    "supersededCount": 0,
    "fullPaymentSubmission": {
      "employee": [
        {
          "payrunEntryId": "string",
          "employeeUniqueId": "string",
          "item": "error too many levels",
          "employeeDetails": "error too many levels",
          "employment": "error too many levels",
          "validationWarnings": "error too many levels"
        }
      ],
      "relatedTaxYear": "string"
    },
    "versions": [
      {
        "payRunEntryId": "string",
        "fpsId": "string"
      }
    ],
    "validationWarnings": [
      {
        "type": "MissingAddress",
        "employeeId": "string"
      }
    ],
    "iRmark": "string",
    "xml": "string",
    "taxYear": "Year2017",
    "employerReferences": {
      "officeNo": "string",
      "payeRef": "string",
      "aoRef": "string",
      "econ": "string",
      "cotaxRef": "string",
      "sautr": "string"
    },
    "govTalkSubmission": {
      "rawResponse": "string",
      "messageClass": "string",
      "pollInterval": 0,
      "lastPoll": "2024-06-25T14:33:33",
      "correlationId": "string",
      "url": "string",
      "status": "NotSubmitted",
      "message": "string",
      "iRmark": "string",
      "errorsJson": "string",
      "errors": [
        {
          "raisedBy": "string",
          "number": "string",
          "type": "string",
          "text": "string",
          "location": "string"
        }
      ],
      "submittedAt": "2024-06-25T14:33:33",
      "id": "string"
    },
    "id": "string"
  },
  "stream": "string"
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
FPS