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
Contains the filename for application/octet-stream, HTML or other text content depending on Type.
For the deprecated application/pdf type, this contains a link to the PDF file; its end-of-life date is 1st February 2027. |
string
|
"string"
|
|
model
|
BankPaymentInstruction
|
{BankPaymentInstruction}
|
|
stream
Contains PDF bytes when Type is application/octet-stream.
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"originator": {
"bankName": "string",
"bankBranch": "string",
"bankReference": "string",
"accountName": "string",
"accountNumber": "string",
"sortCode": "string",
"note": "string",
"buildingSocietyRollNumber": "string"
},
"bankPayments": [
{
"type": "Employee",
"payee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"date": "2026-11-20",
"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",
"serviceUserNumber": "string",
"bureauNumber": "string",
"allowsMultiDate": true
},
"stream": "string"
}
- none -
- none -