ReportResponse[PapdisDocument]

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
If the type is application.json then this will contain a JSON representation of the relevant model
PapdisDocument {PapdisDocument}
{
  "type": "string",
  "content": "string",
  "model": {
    "messageFunctionCode": "Enrol",
    "version": "PAP10",
    "messageFunctionCodeInt": 0,
    "pensionProvider": {
      "pensionProviderId": "string",
      "employers": [
        {
          "pensionRule": "ReliefAtSource",
          "employerId": "string",
          "group": "string",
          "subGroup": "string",
          "payrollPeriod": {
            "payPeriodStartDate": "2019-11-15T09:36:58",
            "payPeriodEndDate": "2019-11-15T09:36:58",
            "contributionDeductionDate": "2019-11-15T09:36:58",
            "frequencyCode": "string",
            "taxPeriod": 0,
            "payReferenceStartDate": "2019-11-15T09:36:58",
            "payReferenceEndDate": "2019-11-15T09:36:58",
            "employees": [
              {
                "employeeId": "string",
                "name": {
                  "title": "string",
                  "forename1": "string",
                  "forename2": "string",
                  "surname": "string"
                },
                "identity": {
                  "employeeId": "string",
                  "birthDate": "2019-11-15T09:36:58",
                  "gender": "string",
                  "nationalInsuranceNumber": "string",
                  "employmentStartDate": "2019-11-15T09:36:58"
                },
                "contact": {
                  "postalAddress": {
                    "address1": "string",
                    "address2": "string",
                    "address3": "string",
                    "address4": "string",
                    "postcode": "string",
                    "country": "string"
                  },
                  "emailAddress": "string",
                  "secondaryEmailAddress": "string"
                },
                "pay": {
                  "pensionableEarningsAmount": 0.0,
                  "totalGrossQualifyingEarningsAmount": 0.0
                },
                "assessment": {
                  "assessmentCode": 0,
                  "eventCode": 0,
                  "eventDate": "2019-11-15T09:36:58",
                  "statutoryLetterCode": "string",
                  "isIndividualAlreadyMemberOfQPS": true,
                  "deferralDate": "2019-11-15T09:36:58",
                  "enrolmentCommunicationsIssuedDate": "2019-11-15T09:36:58",
                  "workerExclusionCode": "string",
                  "reenrolmentIndicator": true,
                  "optOutWindowEndDate": "2019-11-15T09:36:58"
                },
                "contribution": {
                  "employerContributionsAmount": 0.0,
                  "employerContributionsPercent": 0.0,
                  "employeeContributionsAmount": 0.0,
                  "employeeContributionsPercent": 0.0,
                  "additionalVoluntaryContributionsAmount": 0.0,
                  "additionalVoluntaryContributionsPercent": 0.0,
                  "salarySacrificeIndicator": true
                },
                "exit": {
                  "exitDate": "2019-11-15T09:36:58",
                  "exitReasonCode": 0,
                  "aeOptOutDate": "2019-11-15T09:36:58",
                  "aeOptOutReference": "string"
                }
              }
            ]
          },
          "stagingDate": "2019-11-15T09:36:58",
          "cyclicalReenrolmentDate": "2019-11-15T09:36:58"
        }
      ]
    }
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
PAPDIS File