Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Cashflow Patterns (New)

Get Cash Flow Patterns

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

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

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

type of insight

Example response

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