Skip to main content

Report

Report view model

idstringnullable

Report ID

Example: 8fkjh5hr
namestringnullable

Report name

Example: Payment report
elementStatistics objectnullable

Report statistics

countinteger<int32>

Number of transactions in the report

Example: 123
firststring<date-time>nullabledeprecated
bookingDateStartstring<date-time>nullable

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

laststring<date-time>nullabledeprecated
bookingDateEndstring<date-time>nullable

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

reportDatestring<date-time>nullable

Report date

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

Report period

startstring<date-time>nullable

The earliest report period date and time

Example: 2023-10-30T10:01:11.123
endstring<date-time>nullable

The latest report period date and time

Example: 2023-10-30T10:01:11.123
depositDatestring<date-time>nullable

Deposit date

Example: 2022-03-24T00:00:00.000
createdAtstring<date-time>

Report creation date and time

Example: 2022-03-24T10:01:01.000
modifiedAtstring<date-time>

Last report modification date and time

Example: 2022-03-24T10:01:01.000
importedAtstring<date-time>nullable

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
  • ]
    • Report
    {
      "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
        }
      ]
    }