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
|
AdvancedVarianceReport
|
{AdvancedVarianceReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"lines": [
{
"employeeCode": "string",
"employeeName": "string",
"department": "string",
"costCentre": "string",
"primaryGrossTotal": 0.0,
"secondaryGrossTotal": 0.0,
"primaryGrossTaxable": 0.0,
"secondaryGrossTaxable": 0.0,
"primaryNetPay": 0.0,
"secondaryNetPay": 0.0,
"primaryTax": 0.0,
"secondaryTax": 0.0,
"primaryEmployeeNi": 0.0,
"secondaryEmployeeNi": 0.0,
"primaryEmployerNi": 0.0,
"secondaryEmployerNi": 0.0,
"primaryStudentOrPgLoan": 0.0,
"secondaryStudentOrPgLoan": 0.0,
"payCodeVarianceLines": [
{
"code": "string",
"primaryValue": 0.0,
"secondaryValue": 0.0
}
]
}
],
"payCodes": [
{
"title": "string",
"code": "string",
"defaultValue": 0.0,
"isDeduction": true,
"isNiable": true,
"isTaxable": true,
"isPensionable": true,
"isAttachable": true,
"isRealTimeClass1aNiable": true,
"isNotContributingToHolidayPay": true,
"isQualifyingEarningsForAe": true,
"isNotTierable": true,
"isTcp_Tcls": true,
"isTcp_Pp": true,
"isTcp_Op": true,
"flexibleDrawdown": "None",
"isAutoAdjust": true,
"calculationType": "FixedAmount",
"multiplierType": "None",
"dailyRateMultiplier": 0.0,
"hourlyRateMultiplier": 0.0,
"isSystemCode": true,
"isControlCode": true,
"isNotional": true,
"payee": "string"
}
],
"primaryPeriodName": "string",
"secondaryPeriodName": "string",
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}
- none -
- none -