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.

Schema

Name / Description Type / Format Example
messageFunctionCode string "Enrol" "InfoOnly" "AssessmentRequest" "AssessmentResponse" "WokerInstruction"
version string "PAP10" "PAP11"
messageFunctionCodeInt integer int32 0
pensionProvider PapdisPensionProvider {PapdisPensionProvider}
report string "GrossToNet" "GrossToNetCis" "PayrunPayments" "Furlough" "PensionContribs" "Journal" "HourlyPay" "UmbrellaReconciliation" "UmbrellaStatement" "StatutoryPay" "CostAnalysis" "CostOfEmployment" "FullSummaryOfPay" "P11" "P11d" "P30" "P32" "P45" "P60" "EmployeeExport" "RightToWork" "AeoStatement" "HolidayAllowances" "HolidayPayAccruals" "AeAssessments" "CisStatement" "SubcontractorSummary" "PayrollAnalysis" "VarianceReport" "P11Detailed" "NiLetterValidation" "Ytd" "TaxCodeChanges" "EmployeeBenefits" "MemberEnrolment" "AttachmentOrders" "NiYtd" "ApprenticeshipLevy" "TeachersPensionEoy" "MaternitySchedule" "PaySpine" "SpinePoint" "PayGrades" "PaySpineAllowances" "AverageHolidayPayRate" "EmployeeRoleExport" "HolidayPayAccrualsHours" "GenderPayGap" "PensionMemberships" "PayElement" "LoanBalances" "EmployeeLeave" "AdvancedVarianceReport"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024"
title string "string"
isDraft boolean true

JSON Example 

{
  "messageFunctionCode": "Enrol",
  "version": "PAP10",
  "messageFunctionCodeInt": 0,
  "pensionProvider": {
    "pensionProviderId": "string",
    "employers": [
      {
        "pensionRule": "ReliefAtSource",
        "employerId": "string",
        "group": "string",
        "subGroup": "string",
        "payrollPeriod": {
          "payPeriodStartDate": "2024-11-21",
          "payPeriodEndDate": "2024-11-21",
          "contributionDeductionDate": "2024-11-21",
          "frequencyCode": "string",
          "taxPeriod": 0,
          "payReferenceStartDate": "2024-11-21",
          "payReferenceEndDate": "2024-11-21",
          "employees": "error too many levels"
        },
        "stagingDate": "2024-11-21",
        "cyclicalReenrolmentDate": "2024-11-21",
        "name": "string",
        "postalAddress": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "address4": "string",
          "postcode": "string",
          "country": "string"
        },
        "fullTimeContractedHours": 0.0,
        "fullTimeContractedWeeks": 0.0,
        "contractedWeeks": 0.0,
        "id": 0
      }
    ],
    "accountNo": "string"
  },
  "report": "GrossToNet",
  "taxYear": "Year2017",
  "title": "string",
  "isDraft": true
}

References

Contained in Models
PapdisDocumentReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -