GetReportsResponse

reports object[]nullable

Array of reports

Array [

idstringnullable

Report ID

Example: 8fkjh5hr

namestringnullable

Report name

Example: Payment report

elementStatistics objectnullable

Report statistics

countint32

Number of transactions in the report

Example: 123

firstdate-timenullabledeprecated

bookingDateStartdate-timenullable

The booking date and time of the earliest transaction in the report

lastdate-timenullabledeprecated

bookingDateEnddate-timenullable

The booking date and time of the latest transaction in the report

reportDatedate-timenullable

Report date

Example: 2022-03-24T10:01:01.000

reportPeriod objectnullable

Report period

startdate-timenullable

The earliest report period date and time

Example: 2023-10-30T10:01:11.123

enddate-timenullable

The latest report period date and time

Example: 2023-10-30T10:01:11.123

depositDatedate-timenullable

Deposit date

Example: 2022-03-24T00:00:00.000

createdAtdate-time

Report creation date and time

Example: 2022-03-24T10:01:01.000

modifiedAtdate-time

Last report modification date and time

Example: 2022-03-24T10:01:01.000

importedAtdate-timenullable

Import date

Example: 2022-03-24T00:00:00.000

stateReportState (string)

Report state

Possible values: [available, downloaded, importing, imported, download_error, import_error, skipped]

errorstringnullabledeprecated

Error

warnings object[]nullable

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

errors object[]nullable

Array [

typestringnullable

Type or general classification of the error.

Example: AccountCredentialsInvalid

messagestringnullable

Error message.

providerMessagestringnullable

Original error message from the PSP.

isUserActionRequiredboolean

Whether a user action is required to resolve the error.

Example: true

isTemporaryboolean

If the error is temporary.

Example: false

]

]

pagination objectnullable

Pagination info

pageNumberint32

Returned page number

Example: 1

previousPageReferencestringnullable

Reference to get the previous page

nextPageReferencestringnullable

Reference to get the next page

previousPageurinullable

URL of the previous page

nextPageurinullable

URL of the next page

pageSizeint32

Number of items per page

Example: 25

pagesCountint32nullable

Total number of pages

Example: 5

totalCountint32

Total number of items

Example: 125

GetReportsResponse

{
  "reports": [
    {
      "id": "8fkjh5hr",
      "name": "Payment report",
      "elementStatistics": {
        "count": 123,
        "bookingDateStart": "2024-07-29T15:51:28.071Z",
        "bookingDateEnd": "2024-07-29T15:51:28.071Z"
      },
      "reportDate": "2022-03-24T10:01:01.000",
      "reportPeriod": {
        "start": "2023-10-30T10:01:11.123",
        "end": "2023-10-30T10:01:11.123"
      },
      "depositDate": "2022-03-24T00:00:00.000",
      "createdAt": "2022-03-24T10:01:01.000",
      "modifiedAt": "2022-03-24T10:01:01.000",
      "importedAt": "2022-03-24T00:00:00.000",
      "state": "available",
      "warnings": [
        {
          "type": "AccountCredentialsInvalid",
          "message": "string",
          "providerMessage": "string",
          "isUserActionRequired": true,
          "isTemporary": false
        }
      ],
      "errors": [
        {
          "type": "AccountCredentialsInvalid",
          "message": "string",
          "providerMessage": "string",
          "isUserActionRequired": true,
          "isTemporary": false
        }
      ]
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "previousPageReference": "string",
    "nextPageReference": "string",
    "previousPage": "string",
    "nextPage": "string",
    "pageSize": 25,
    "pagesCount": 5,
    "totalCount": 125
  }
}