LEleantech
Cashflow Patterns (NEW)

Get Cash Flow

Detects recurring inflow and outflow transactions and groups them into structured patterns, surfacing frequency, expected timing, and whether each pattern is ongoing, new, or stopped.

get/insights/v3/cashflow-patterns

Request

  • Base URL
    https://sandbox.leantech.me
  • URL
    https://sandbox.leantech.me/insights/v3/cashflow-patterns
  • Auth
    HTTP bearer

Query parameters

entity_idstring uuid required

The entity_id you're querying for.

start_datestring date

The start date in UTC (in the format YYYY-MM-DD) of the analysis window. When omitted, defaults to the earliest transaction available for the entity.

end_datestring date

The end date in UTC (in the format YYYY-MM-DD) of the analysis window (inclusive — transactions on this date are included). When omitted, defaults to the current time.

Response

OK

status'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED' required

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

type'income' | 'employment' | 'cashflow' | 'credits-obligations' | 'non-credits-obligations' | 'expenses' | 'cash-balances' | 'freelancer-cashflow' | 'cashflow-patterns' | 'credit-assessments' | 'account-controls' | 'credit-obligations' | 'spending'

type of insight

Example response

{
  "insights": {
    "cashflow_patterns": [
      {
        "total_amount": {
          "currency": "AED"
        },
        "monthly_totals": [
          {
            "month": "2026-01",
            "amount": {
              "currency": "AED"
            }
          }
        ]
      }
    ]
  }
}

Changes

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