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
Contains the filename for application/octet-stream, HTML or other text content depending on Type.
For the deprecated application/pdf type, this contains a link to the PDF file; its end-of-life date is 1st February 2027. |
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}
|
|
stream
Contains PDF bytes when Type is application/octet-stream.
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"messageFunctionCode": "Enrol",
"version": "PAP10",
"messageFunctionCodeInt": 0,
"pensionProvider": {
"pensionProviderId": "string",
"employers": [
{
"pensionRule": "ReliefAtSource",
"employerId": "string",
"group": "string",
"subGroup": "string",
"payrollPeriod": "error too many levels",
"stagingDate": "2026-10-31",
"cyclicalReenrolmentDate": "2026-10-31",
"name": "string",
"postalAddress": "error too many levels",
"fullTimeContractedHours": 0.0,
"fullTimeContractedWeeks": 0.0,
"contractedWeeks": 0.0,
"id": 0
}
],
"accountNo": "string"
},
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}