Skip to main content

GetDataImportsResponse

dataImports object[]nullable

Array of data imports

  • Array [
  • countReceivedinteger<int32>

    The number of transactions received

    The total nomber of transactions downloaded from the provider

    Example: 100
    countAddedinteger<int32>

    The number of added transactions

    The number transactions that were downloaded for the first time and added

    Example: 10
    countUpdatedinteger<int32>

    The number of updated transactions

    The number of transactions that were already downloaded before, but this download has new data for these transactions

    Example: 5
    bookingDateStartstring<date-time>nullable

    Booking date and time of the earliest imported transaction

    bookingDateEndstring<date-time>nullable

    Booking date and time of the latest imported transaction

    createdAtstring<date-time>

    Import date and time

    Example: 2024-03-24T13:05:15.000
    errorstringnullabledeprecated

    Error message

    Example: An error occurred when importing transactions
    statusstringrequired

    Data import status

    • Done - Import completed successfully
    • Importing - Currently importing
    • Failed - Import failed

    Possible values: non-empty

    Example: Done
    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
  • ]
  • idstringnullable

    Data import ID

    Example: 8fkjh5hr
    reportIdstringnullable

    Report ID

    Example: 6fidn2js
  • ]
  • pagination objectnullable

    Pagination info

    pageNumberinteger<int32>

    Returned page number

    Example: 1
    previousPageReferencestringnullable

    Reference to get the previous page

    nextPageReferencestringnullable

    Reference to get the next page

    previousPagestring<uri>nullable

    URL of the previous page

    nextPagestring<uri>nullable

    URL of the next page

    pageSizeinteger<int32>

    Number of items per page

    Example: 25
    pagesCountinteger<int32>nullable

    Total number of pages

    Example: 5
    totalCountinteger<int32>

    Total number of items

    Example: 125
    GetDataImportsResponse
    {
    "dataImports": [
    {
    "countReceived": 100,
    "countAdded": 10,
    "countUpdated": 5,
    "bookingDateStart": "2024-07-29T15:51:28.071Z",
    "bookingDateEnd": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-03-24T13:05:15.000",
    "status": "Done",
    "warnings": [
    {
    "type": "AccountCredentialsInvalid",
    "message": "string",
    "providerMessage": "string",
    "isUserActionRequired": true,
    "isTemporary": false
    }
    ],
    "errors": [
    {
    "type": "AccountCredentialsInvalid",
    "message": "string",
    "providerMessage": "string",
    "isUserActionRequired": true,
    "isTemporary": false
    }
    ],
    "id": "8fkjh5hr",
    "reportId": "6fidn2js"
    }
    ],
    "pagination": {
    "pageNumber": 1,
    "previousPageReference": "string",
    "nextPageReference": "string",
    "previousPage": "string",
    "nextPage": "string",
    "pageSize": 25,
    "pagesCount": 5,
    "totalCount": 125
    }
    }