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
After finalising a PayRun, employees need to actually be paid.
This model is returned by the Reports API and is used to provide details of a payment that needs to be made. |
PayrunPaymentsReport
|
{PayrunPaymentsReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"payments": [
{
"type": "Employee",
"payee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"date": "2024-11-21",
"method": "Cash",
"amount": 0.0,
"reference": "string",
"employerPaymentReference": "string",
"bankDetails": {
"bankName": "string",
"bankBranch": "string",
"bankReference": "string",
"accountName": "string",
"accountNumber": "string",
"sortCode": "string",
"note": "string",
"buildingSocietyRollNumber": "string"
},
"bacsHash": "string",
"bacsSubReference": "string",
"isBankDetailValid": true
}
],
"status": "Queued",
"statusMessage": "string",
"link": "string",
"connectedExternalDataProvider": {
"name": "string",
"id": "SmartPension_Employer",
"authScheme": "OAuth1",
"logoUrl": "string",
"iconUrl": "string",
"connected": true,
"connectedAs": "string",
"requiresConfig": true,
"deferralUrl": "string",
"types": []
},
"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"
}