Part of the TaxYearConfig that our engine uses to calculate Mileage Allowance Payments.
It is used internally when our engine performs calculations.
You do not need to do anything with this model, it's provided purely for informational purposes.
| 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
|
PayrollAnalysisEmployeeRoleBreakdownReport
|
{PayrollAnalysisEmployeeRoleBreakdownReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"lines": [
{
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"fullEmployee": {
"holidaySchemeUniqueId": "string",
"aggregatedServiceDate": "2025-08-30",
"leaveHolidayAccrualDefaultRateType": "HourlyRate",
"defaultPensionSchemeUniqueId": "string",
"defaultPensionSchemeName": "string",
"defaultWorkerGroupUniqueId": "string",
"defaultWorkerGroupName": "string",
"id": "string",
"personalDetails": "error too many levels",
"employmentDetails": "error too many levels",
"autoEnrolment": "error too many levels",
"leaveSettings": "error too many levels",
"rightToWork": "error too many levels",
"bankDetails": "error too many levels",
"tags": [
"string"
],
"payOptions": "error too many levels",
"status": "Current",
"aeNotEnroledWarning": true,
"sourceSystemId": "string",
"evcId": "string"
},
"employeeRole": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"department": {
"code": "string",
"color": "string",
"title": "string",
"primary": true,
"weighting": 0.0,
"employeeRoleUniqueId": "string"
},
"gross": 0.0,
"niableGross": 0.0,
"net": 0.0,
"takeHome": 0.0,
"employerNic": 0.0,
"showQtyColumn": true,
"lines": [
{
"qty": 0.0,
"code": "string",
"value": 0.0
}
],
"ersPension": 0.0,
"taxablePay": 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,
"isStandAloneLumpSum": true,
"isPensionExcessLumpSum": true,
"payee": "string"
}
],
"employer": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"version": 0,
"periodTo": 0,
"startPeriodName": "string",
"endPeriodName": "string",
"startDate": "2025-08-30",
"endDate": "2025-08-30",
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}- none -
- none -