PapdisDocumentReportResponse

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
PAPDIS stands for 'Payroll and Pension Data Interface Standard'.
It is an industry standard for exchanging data between payroll software and pension providers.
Our system provides an export of data in this standard and these models are used to represent the data.
Whilst the relevant reporting API endpoint can provide this data as a JSON entity, it is usually represented in CSV or XML format which our API also provides.
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": "2020-07-10",
            "payPeriodEndDate": "2020-07-10",
            "contributionDeductionDate": "2020-07-10",
            "frequencyCode": "string",
            "taxPeriod": 0,
            "payReferenceStartDate": "2020-07-10",
            "payReferenceEndDate": "2020-07-10",
            "employees": [
              {
                "employeeId": "string",
                "name": {
                  "title": "string",
                  "forename1": "string",
                  "forename2": "string",
                  "surname": "string"
                },
                "identity": {
                  "employeeId": "string",
                  "birthDate": "2020-07-10",
                  "gender": "string",
                  "nationalInsuranceNumber": "string",
                  "employmentStartDate": "2020-07-10"
                },
                "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": "2020-07-10",
                  "statutoryLetterCode": "string",
                  "isIndividualAlreadyMemberOfQPS": true,
                  "deferralDate": "2020-07-10",
                  "enrolmentCommunicationsIssuedDate": "2020-07-10",
                  "workerExclusionCode": "string",
                  "reenrolmentIndicator": true,
                  "optOutWindowEndDate": "2020-07-10"
                },
                "contribution": {
                  "employerContributionsAmount": 0.0,
                  "employerContributionsPercent": 0.0,
                  "employeeContributionsAmount": 0.0,
                  "employeeContributionsPercent": 0.0,
                  "additionalVoluntaryContributionsAmount": 0.0,
                  "additionalVoluntaryContributionsPercent": 0.0,
                  "salarySacrificeIndicator": true
                },
                "exit": {
                  "exitDate": "2020-07-10",
                  "exitReasonCode": 0,
                  "aeOptOutDate": "2020-07-10",
                  "aeOptOutReference": "string"
                }
              }
            ]
          },
          "stagingDate": "2020-07-10",
          "cyclicalReenrolmentDate": "2020-07-10"
        }
      ]
    }
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
PAPDIS File