PapdisDocument

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.

Name / Description Type / Format Example
messageFunctionCode string "Enrol" "InfoOnly" "AssessmentRequest" "AssessmentResponse" "WokerInstruction"
version string "PAP10" "PAP11"
messageFunctionCodeInt integer int32 0
pensionProvider PapdisPensionProvider {PapdisPensionProvider}
{
  "messageFunctionCode": "Enrol",
  "version": "PAP10",
  "messageFunctionCodeInt": 0,
  "pensionProvider": {
    "pensionProviderId": "string",
    "employers": [
      {
        "pensionRule": "ReliefAtSource",
        "employerId": "string",
        "group": "string",
        "subGroup": "string",
        "payrollPeriod": {
          "payPeriodStartDate": "2019-11-13T22:30:26",
          "payPeriodEndDate": "2019-11-13T22:30:26",
          "contributionDeductionDate": "2019-11-13T22:30:26",
          "frequencyCode": "string",
          "taxPeriod": 0,
          "payReferenceStartDate": "2019-11-13T22:30:26",
          "payReferenceEndDate": "2019-11-13T22:30:26",
          "employees": [
            {
              "employeeId": "string",
              "name": {
                "title": "string",
                "forename1": "string",
                "forename2": "string",
                "surname": "string"
              },
              "identity": {
                "employeeId": "string",
                "birthDate": "2019-11-13T22:30:27",
                "gender": "string",
                "nationalInsuranceNumber": "string",
                "employmentStartDate": "2019-11-13T22:30:27"
              },
              "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-13T22:30:27",
                "statutoryLetterCode": "string",
                "isIndividualAlreadyMemberOfQPS": true,
                "deferralDate": "2019-11-13T22:30:27",
                "enrolmentCommunicationsIssuedDate": "2019-11-13T22:30:27",
                "workerExclusionCode": "string",
                "reenrolmentIndicator": true,
                "optOutWindowEndDate": "2019-11-13T22:30:27"
              },
              "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-13T22:30:27",
                "exitReasonCode": 0,
                "aeOptOutDate": "2019-11-13T22:30:27",
                "aeOptOutReference": "string"
              }
            }
          ]
        },
        "stagingDate": "2019-11-13T22:30:27",
        "cyclicalReenrolmentDate": "2019-11-13T22:30:27"
      }
    ]
  }
}
Contained in Models
ReportResponse[PapdisDocument]
Consumed by Operations

- none -

Returned by Operations

- none -