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
|
PaySpineReport
|
{PaySpineReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"lines": [
{
"spineName": "string",
"fullTimeHours": 0.0,
"fullTimeWeeks": 0.0,
"salaryFormula": "string",
"hourlyDivisor": 0.0,
"hourlyDecimals": 0,
"dailyDivisor": 0.0,
"dailyDecimals": 0,
"annualDecimals": 0,
"annualRoundingRule": "RoundOff",
"incrementRule": "Manual",
"requiresLondonAllowance": true,
"gradeEffectiveDate": "2024-11-21",
"pointEffectiveDate": "2024-11-21",
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payrollCode": "string",
"department": "string"
}
],
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}