---
title: "Get Cashflow"
method: GET
path: "/insights/v2/assets/cashflows"
tags: ["Assets"]
---

# Get Cashflow

`GET /insights/v2/assets/cashflows`

## Request

- Base URL: `https://sandbox.leantech.me`
- URL: `https://sandbox.leantech.me/insights/v2/assets/cashflows`
- Auth: HTTP bearer

The Cashflow API provides access to **Personal** and **Business** cash flow data. For personal accounts, it offers insights into monthly cash inflows, outflows, and net cash flow. For business accounts, it offers detailed insights on revenue, expenses, and net cash flow.
You can use this API to evaluate financial stability, manage cash flow effectively, and assess the account holder's ability to meet financial obligations.

## Query parameters

- `entity_id` string, uuid, required
- `async` boolean
- `start_date` string, date, required

## Response `200`

OK

- CashFlowResult
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required: The status of the request
  - `results_id` string, uuid, required: The unique identifier for the request
  - `message` string, required: A message describing the status of the request
  - `meta` object, nullable: Meta information about the request
  - `timestamp` string, date-time, required: The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable: Granular status code
    - `status_additional_info` string, nullable: Additional information about the status
  - `insights` CashFlow
    - `total` object
      - `inwards` CashFlowCategoryAmountCount[]
        - `category` string: The category of the cash flow
        - `amount` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer: The count of transactions in this category
      - `outwards` CashFlowCategoryAmountCount[]
        - `category` string: The category of the cash flow
        - `amount` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer: The count of transactions in this category
      - `net` CashFlowNet
        - `overall_amount` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `net_cashflow` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
    - `monthly_totals` CashFlowMonthlyTotal[]
      - `month` integer: The month of the reporting period
      - `year` integer: The year of the reporting period
      - `is_month_complete` boolean: Indicates whether the data for this month is complete
      - `inwards` CashFlowCategoryAmountCount[]
        - `category` string: The category of the cash flow
        - `amount` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer: The count of transactions in this category
      - `outwards` CashFlowCategoryAmountCount[]
        - `category` string: The category of the cash flow
        - `amount` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer: The count of transactions in this category
      - `net` CashFlowNet
        - `overall_amount` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `net_cashflow` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
    - `credit_debit_behaviour` CreditDebitBehaviour
      - `periods` CreditDebitBehaviourPeriod[], required
        - `period` string, required: The time period
        - `grand_average_credit_amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `grand_average_credit_count` integer, required: The average credit transaction count
        - `grand_average_debit_amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `grand_average_debit_count` integer, required: The average debit transaction count
        - `grand_average_credit_debit_amount_ratio` number, required: The ratio of credit to debit amounts
        - `grand_average_credit_debit_count_ratio` number, required: The ratio of credit to debit transaction counts
        - `total_volume_of_credit` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `total_volume_of_debit` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `total_volume_of_credit_debit_ratio` number, required: The ratio of total credit to debit volumes
    - `big_payments` BigPayments
      - `periods` BigPaymentsPeriod[], required
        - `period` string, required: The time period
        - `average_max_monthly_credit_amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `average_max_monthly_debit_amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `average_max_monthly_credit_debit_amount_ratio` number, required: The ratio of credit to debit amounts

## Other responses

- `202`: Accepted
- `501`: Not Implemented

---

[API](https://skmtc.dev/leantech/apis/insights-api-account-controls.md) - [All operations](https://skmtc.dev/leantech/apis/insights-api-account-controls/llms.txt) - [OpenAPI document](https://skmtc.dev/leantech/apis/insights-api-account-controls/revisions/6a904c24f1e4?raw)