VUZDevelopers

Get cash flow insights and forecasts

GET
/analytics/insights/cash-flow

Retrieves detailed cash flow insights including forecasts and actionable recommendations.

Forecast Periods: 30, 60, and 90 days

Data Returned:

  • Expected incoming payments (based on open invoices + client payment patterns)
  • Expected outgoing (based on expense history)
  • Net cash flow forecast
  • Cash flow related insights and warnings
  • Collection opportunities

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

forecastDays?number

Forecast period in days (30, 60, or 90)

Default30

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/insights/cash-flow"
{  "currentBalance": 0,  "forecasts": [    {      "period": "string",      "days": 0,      "expectedIncoming": 0,      "expectedOutgoing": 0,      "netCashFlow": 0,      "projectedBalance": 0,      "openInvoicesCount": 0,      "confidence": 0    }  ],  "insights": [    {      "id": "string",      "type": "cash_flow",      "category": "cash_shortage",      "title": "string",      "titleEn": "string",      "description": "string",      "descriptionEn": "string",      "priority": "critical",      "score": 0,      "relatedEntityType": "client",      "relatedEntityId": "string",      "relatedEntityName": "string",      "actionLabel": "string",      "actionLabelEn": "string",      "actionUrl": "string",      "metrics": [        {          "key": "string",          "labelHe": "string",          "labelEn": "string",          "value": {},          "trend": "up",          "unit": "string"        }      ],      "icon": "string",      "generatedAt": "string",      "expiresAt": "string",      "dismissedAt": "string",      "isAiGenerated": false    }  ],  "totalReceivables": 0,  "totalOverdue": 0,  "avgCollectionDays": 0,  "currency": "string",  "calculatedAt": "string"}