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
A P11 Report summarises payments and deductions made to an employee.
Our Reports API can return this to you in many formats including as a PDF file If you request is as a JSOn object then it is represented using this model. |
P11
|
{P11}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"employerName": "string",
"payrollCode": "string",
"employerOfficeNo": "string",
"employerPayeRef": "string",
"firstname": "string",
"surname": "string",
"niNumber": "string",
"taxCode": "string",
"dateOfBirth": "2024-11-03",
"joinDate": "2024-11-03",
"leaveDate": "2024-11-03",
"lines": [
{
"date": "2024-11-03",
"period": "string",
"grossTaxablePay": 0.0,
"grossTaxablePayYTD": 0.0,
"tax": 0.0,
"taxYTD": 0.0,
"smpYTD": 0.0,
"sppYTD": 0.0,
"sapYTD": 0.0,
"shppYTD": 0.0,
"spbpYTD": 0.0,
"studentLoanYTD": 0.0,
"postgradLoanYTD": 0.0,
"niValues": [
{
"table": "string",
"period": 0.0,
"ytd": 0.0
}
]
}
],
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}