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
|
P32
|
{P32}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"isQuarterly": true,
"hmrcLiabilities": [
{
"title": "string",
"taxYear": "Year2017",
"periodEnding": "2024-12-22",
"periodComplete": true,
"recoverableAmountsEpsCreated": true,
"apprenticeshipLevyEpsCreated": true,
"payRuns": [
{
"taxYear": "Year2017",
"taxMonth": 0,
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"startDate": "2024-12-22",
"endDate": "2024-12-22",
"paymentDate": "2024-12-22",
"employeeCount": 0,
"subContractorCount": 0,
"nonRtiEmployeeCount": 0,
"totals": "error too many levels",
"payslipScheduledDateTime": "2024-12-22",
"state": "Opening",
"isClosed": true,
"isRolledBack": true,
"dateClosed": "2024-12-22T02:56:28",
"autoPilotCloseDate": "2024-12-22",
"entries": "error too many levels"
}
],
"tax": 0.0,
"cisDeductions": 0.0,
"postgradLoanDeductions": 0.0,
"studentLoanDeductions": 0.0,
"employeeNic": 0.0,
"employerNic": 0.0,
"realTimeClass1ANic": 0.0,
"smp": 0.0,
"smpNic": 0.0,
"spp": 0.0,
"sppNic": 0.0,
"sap": 0.0,
"sapNic": 0.0,
"shpp": 0.0,
"shppNic": 0.0,
"spbp": 0.0,
"spbpNic": 0.0,
"eligibleForEmploymentAllowance": true,
"employmentAllowanceClaim": 0.0,
"employmentAllowanceClaimAuto": true,
"liableForApprenticeshipLevy": true,
"apprenticeshipLevy": 0.0,
"apprenticeshipLevyAuto": true,
"liabilityArisingInPeriod": 0.0,
"dueInPreviousPeriods": 0.0,
"paidInPreviousPeriods": 0.0,
"employmentAllowanceClaimInPreviousPeriods": 0.0,
"receivedFromHMRCToRefundTax": 0.0,
"receivedFromHMRCToPayStatutoryPay": 0.0,
"cisDeductionsSuffered": 0.0,
"adjustment": 0.0,
"netLiabilityForPeriod": 0.0,
"totalPaid": 0.0,
"payments": [
{
"amount": 0.0,
"date": "2024-12-22",
"id": "string"
}
],
"fpsList": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"allowLinkedEps": true,
"id": "string"
}
],
"employerOpeningBalances": {
"smpRecovered": 0.0,
"sppRecovered": 0.0,
"sapRecovered": 0.0,
"shPPRecovered": 0.0,
"spbpRecovered": 0.0,
"nicCompensationOnSMP": 0.0,
"nicCompensationOnSPP": 0.0,
"nicCompensationOnSAP": 0.0,
"nicCompensationOnShPP": 0.0,
"nicCompensationOnSPBP": 0.0,
"cisDeductionsSuffered": 0.0,
"apprenticeshipLevy": 0.0,
"employmentAllowance": 0.0
},
"openingBalancesTotals": {
"employeesWithOpeningBalancesCount": 0,
"taxYear": "Year2017",
"previousEmployerGross": 0.0,
"previousEmployerTax": 0.0,
"currentEmployerGross": 0.0,
"currentEmployerTax": 0.0,
"currentEmployerNet": 0.0,
"studentLoanDeductions": 0.0,
"postgradLoanDeductions": 0.0,
"empeePenContribnsPaid": 0.0,
"empeePenContribnsNotPaid": 0.0,
"smp": 0.0,
"spp": 0.0,
"sap": 0.0,
"shpp": 0.0,
"spbp": 0.0,
"realTimeClass1ANi": 0.0,
"terminationPayments": 0.0,
"mapsMiles": 0,
"benefitsTaxedViaPayroll": 0.0,
"nicSummaries": [
{
"taxYear": "Year2017",
"paymentDate": "2024-12-22",
"niTable": "string",
"asDirector": true,
"grossEarningsForNics": 0.0,
"earningsAtLel": 0.0,
"earningsAboveLelToPt": 0.0,
"earningsAbovePtToSt": 0.0,
"earningsAbovePtToUap": 0.0,
"earningsAboveStToUel": 0.0,
"earningsAboveStToFust": 0.0,
"earningsAboveFustToUel": 0.0,
"earningsAboveUapToUel": 0.0,
"earningsAboveUel": 0.0,
"employeeNics": 0.0,
"employeeNiRebate": 0.0,
"employerNics": 0.0,
"employerNiRebate": 0.0,
"hasValues": true,
"id": "string",
"isNiYtdOverride": true,
"childId": "string",
"employee": "error too many levels"
}
],
"foreignTaxCredit": 0.0,
"foreignTaxCreditReclaimed": 0.0,
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
},
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}