# GetCategorizations (deprecated)

Endpoint: GET /v1/sessions/{sessionId}/categorizations
Version: 1.0
Security: keycloakAuthTest, keycloakAuthLive

## Path parameters:

  - `sessionId` (string, required)

## Response 200 fields (application/json):

  - `sources` (array,null)
    List of Data Provider sources indicating where the response data was obtained from.

  - `sources.sourceId` (string,null, required)
    Identifier of the Data Provider that provided the information.

  - `sources.status` (string, required)
    Current status of the source Data Provider, such as successful or failed.
    Enum: "UNKNOWN", "SUCCESS", "ERROR", "FORBIDDEN", "UNSUPPORTED_COUNTRY", "WAITING_FOR_CUSTOMER", "WAITING_FOR_PROVIDER", "PACKAGE_UPGRADE_REQUIRED", "ID_TAX_ONLY"

  - `sources.countryCode` (string,null)
    Three-letter ISO 3166-1 alpha-3 code representing the country of the source Data Provide.

  - `summary` (object,null)
    Summary of the categorized financial data.

  - `summary.periodWithIncomeMonths` (integer,null)
    Number of months within the analyzed period that include income transactions.

  - `summary.periodWithLiabilitiesMonths` (integer,null)
    Number of months within the analyzed period that include liability transactions.

  - `categorizations` (array,null)
    Detailed list of categorized financial transactions.

  - `categorizations.accounts` (array,null)
    List of accounts included in the categorization.

  - `categorizations.accounts.countryCode` (string,null)
    ISO 3166-1 alpha-3 country codeISO 3166-1 alpha-3 country code

  - `categorizations.accounts.bankName` (string,null)
    Name of the bank where the account is held.

  - `categorizations.accounts.accountNumber` (string,null)
    Number identifying the customer's bank account.

  - `categorizations.accounts.accountHolderNames` (array,null)
    Account holder full name. Account can have multiple holders

  - `categorizations.totalPeriodMonths` (integer,null)
    Total number of months covered in the categorization period.

  - `categorizations.totalPeriodReceivedMonths` (integer,null)
    Total number of months for which data was successfully received.

  - `categorizations.periodWithIncomeMonths` (integer,null)
    Number of months within the period that had income transactions.

  - `categorizations.periodWithLiabilitiesMonths` (integer,null)
    Number of months within the period that had liability transactions.

  - `categorizations.transactions` (array,null)
    List of categorized transactions within the period.

  - `categorizations.transactions.date` (string,null)
    Date of the transaction.

  - `categorizations.transactions.category` (string, required)
    Main category assigned to the transaction.
    Enum: "INCOMES", "OTHER_INCOMING_PAYMENTS", "LIABILITIES", "EXPENSES"

  - `categorizations.transactions.subCategory` (string, required)
    Subcategory providing more detailed classification of the transaction.
    Enum: "BANK_FEES", "BNPL", "CAR_LOAN", "CHILD_SUPPORT", "CONSUMER_LOAN", "CREDIT_CARD", "DISABILITY", "ENTERTAINMENT", "FOOD_AND_DRINK", "GAMBLING", "GENERAL_MERCHANDISE", "GENERAL_SERVICE", "GIG_ECONOMY", "GOVERNMENT", "GOVERNMENT_AND_NON_PROFIT", "HOME_IMPROVEMENT", "INTEREST_AND_DIVIDENDS", "INTEREST_PAYMENT", "INVESTMENT_AND_SAVINGS", "LOAN_DISBURSEMENT", "MEDICAL", "MORTGAGE_LOAN", "OTHER", "PERSONAL_CARE", "RENTAL", "RENT_AND_UTILITIES", "RETIREMENT", "SALARY", "STUDENT_LOAN", "TRANSFER_IN", "TRANSFER_OUT", "TRAVEL_AND_TRANSPORT", "UNEMPLOYMENT", "UNKNOWN"

  - `categorizations.transactions.amount` (object,null)
    Monetary amount of the transaction.

  - `categorizations.transactions.amount.amount` (number, required)
    Monetary value represented as a decimal number.

  - `categorizations.transactions.amount.currencyCode` (string,null, required)
    Currency code in ISO 4217 format (e.g., EUR, GBP).

  - `categorizations.transactions.counterpartyName` (string,null)
    Name of the counterparty involved in the transaction.

  - `categorizations.transactions.originalDescription` (string,null)
    Description text as inserted by the remitter.

  - `categorizations.overdraftLimits` (array,null)
    Overdraft limit information for the categorized accounts.

  - `categorizations.overdraftLimits.limit` (object,null, required)
    The overdraft limit assigned to the account.

  - `categorizations.overdraftLimits.accountNumber` (string,null)
    The bank account number associated with the overdraft limit.

## Response 400 fields (application/json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

  - `errors` (object,null)


## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 500 fields