Skip to content

Cash flow details

GET
/api/v1/dashboard/runway

Detailed runway status with cash projections, daily burn, revenue, and recommended cash actions.

Authorizations

Responses

200

Successful Response

Response for GET /api/v1/dashboard/runway.

object
data
required

Detailed runway and cash flow payload.

Attributes: current_cash: Current cash balance in cents. runway_days: Estimated days of cash remaining. daily_burn: Average daily cash outflow in cents. daily_revenue: Average daily revenue in cents. projection: Day-by-day cash projection. cash_actions: Recommended cash management actions. status: Color-coded health level (green/yellow/orange/red).

object
cash_actions
Array<object>

A recommended cash action for the business owner.

Attributes: id: Unique action identifier. action_type: Category of the action. description: Plain-language explanation. amount: Estimated cash impact in cents. priority: Importance level (critical/high/medium/low). urgency: Time sensitivity (immediate/today/this_week/this_month).

object
action_type
required
string
amount
integer
description
required
string
id
required
string
priority
string
default: medium
urgency
string
default: this_week
current_cash
integer
daily_burn
integer
daily_revenue
integer
projection
Array<object>

A single day in the cash flow projection.

Attributes: date: Calendar date for this projection point. projected_balance: Expected end-of-day cash balance in cents. inflows: Expected inflows in cents. outflows: Expected outflows in cents.

object
date
required
string
inflows
integer
outflows
integer
projected_balance
integer
runway_days
integer
status
string
default: green
meta

Standard metadata included in every API response.

Attributes: request_id: Unique identifier for request tracing. timestamp: UTC timestamp of the response.

object
request_id

Unique identifier for request tracing

string
timestamp

UTC timestamp of the response

string format: date-time