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
|
FurloughReport
|
{FurloughReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"maxClaimPerEmployee": 0.0,
"percentageOfNIAndPensionToClaim": 0.0,
"govtContribRate": 0.0,
"companyName": "string",
"employerReference": "string",
"companyCrn": "string",
"ctUtr": "string",
"saUtr": "string",
"claimPeriodStartDate": "2024-11-21",
"claimPeriodEndDate": "2024-11-21",
"numberOfEmployeesBeingFurloughed": 0,
"totalClaimAmount": 0.0,
"totalGrossPay": 0.0,
"amountClaimedForGrossPayToEmployeesOnFurloughForThePeriod": 0.0,
"amountClaimedForEmployerNICsContributionsForFurloughedEmployees": 0.0,
"amountClaimedForEmployersAutoEnrolmentPensionCostsForFurloughedEmployees": 0.0,
"lines": [
{
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"employeesFullName": "string",
"employeesNINO": "string",
"employeesPayrollReferenceNumber": "string",
"furloughedDays": 0,
"daysInPeriod": 0,
"hoursNormallyWorked": 0.0,
"hoursFurloughed": 0.0,
"percentageOfFurloughedDaysWorked": 0.0,
"grossPay": 0.0,
"grossPayClaim": 0.0,
"niClaim": 0.0,
"pensionClaim": 0.0,
"totalClaim": 0.0,
"furloughStart": "2024-11-21",
"furloughEnd": "2024-11-21",
"department": "string"
}
],
"bankAccountNumber": "string",
"bankSortCode": "string",
"bankAccountHoldersFirstName": "string",
"bankAccountHoldersLastName": "string",
"bankAccountHoldersAddress": "string",
"buildingSocietyRollNumber": "string",
"companyAddress": "string",
"contactName": "string",
"contactNumber": "string",
"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"
}