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
|
PayrollAnalysisCostBreakdownReport
|
{PayrollAnalysisCostBreakdownReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"lines": [
{
"payrollCode": "string",
"lastName": "string",
"department": {
"key": "string",
"value": 0.0
},
"costCentre": {
"key": "string",
"value": 0.0
},
"employeeRoleAnalysisCategory": {},
"lines": [
{
"qty": 0.0,
"code": "string",
"value": 0.0
}
],
"totalPay": 0.0,
"niablePay": 0.0,
"pensionPay": 0.0,
"niPercent": 0.0,
"ersNi": 0.0,
"pensionPercent": 0.0,
"ersPension": 0.0,
"taxablePay": 0.0,
"taxablePercent": 0.0,
"employeeNi": 0.0,
"taxPaid": 0.0,
"studentLoan": 0.0,
"employeePension": 0.0,
"employeePensionContributionSalarySacrifice": 0.0,
"employeePensionContributionReliefAtSource": 0.0,
"pensionSummaryCostBreakdowns": [
{
"pensionRule": "ReliefAtSource",
"payCodes": [
"string"
],
"amount": 0.0,
"pensionableEarnings": 0.0,
"employeePensionContribution": 0.0,
"employerPensionContribution": 0.0
}
],
"roleId": "string"
}
],
"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"
}
],
"employeesPayRunTotals": [
{
"payrollCode": "string",
"grossForNi": 0.0,
"grossPensionPay": 0.0,
"employerPensionContribution": 0.0,
"employerNi": 0.0,
"grossTaxablePay": 0.0,
"employeeNi": 0.0,
"tax": 0.0,
"studentLoanRecovered": 0.0,
"employeePension": 0.0,
"employeePensionContributionReliefAtSource": 0.0,
"employeePensionContributionSalarySacrifice": 0.0
}
],
"employer": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"periodTo": 0,
"startPeriodName": "string",
"endPeriodName": "string",
"startDate": "2024-11-21",
"endDate": "2024-11-21",
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}- none -
- none -