Assets

Get Cashflow

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.

get/insights/v2/assets/cashflows

Request

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

Query parameters

entity_idstring uuid required

The entity_id you're querying for.

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it''s recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

start_datestring date required

The start date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

Response

The status of the request

results_idstring uuid required

The unique identifier for the request

messagestring required

A message describing the status of the request

metaobject nullable

Meta information about the request

timestampstring date-time required

The datetime of when the request was made

Example response

{
  "insights": {
    "total": {
      "inwards": [
        {
          "amount": {
            "currency": "AED"
          }
        }
      ],
      "outwards": [
        {
          "amount": {
            "currency": "AED"
          }
        }
      ],
      "net": {
        "overall_amount": {
          "currency": "AED"
        },
        "net_cashflow": {
          "currency": "AED"
        }
      }
    },
    "monthly_totals": [
      {
        "inwards": [
          {
            "amount": {
              "currency": "AED"
            }
          }
        ],
        "outwards": [
          {
            "amount": {
              "currency": "AED"
            }
          }
        ],
        "net": {
          "overall_amount": {
            "currency": "AED"
          },
          "net_cashflow": {
            "currency": "AED"
          }
        }
      }
    ],
    "credit_debit_behaviour": {
      "periods": [
        {
          "grand_average_credit_amount": {
            "currency": "AED"
          },
          "grand_average_debit_amount": {
            "currency": "AED"
          },
          "total_volume_of_credit": {
            "currency": "AED"
          },
          "total_volume_of_debit": {
            "currency": "AED"
          }
        }
      ]
    },
    "big_payments": {
      "periods": [
        {
          "average_max_monthly_credit_amount": {
            "currency": "AED"
          },
          "average_max_monthly_debit_amount": {
            "currency": "AED"
          }
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.