Skip to content
UltimateTeam.ai Docs

Cash flow details

GET
/api/v1/dashboard/runway
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/dashboard/runway?period=90d' \
  --header 'X-API-Key: <X-API-Key>'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
period
Period

Projection horizon: 7d, 30d, or 90d

string
default: 90d

Projection horizon: 7d, 30d, or 90d

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
RunwayDashboardResponse

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

object
data
required
RunwayDashboardData

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
Cash Actions
Array<object>
CashActionItem

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
Action Type
string
amount
Amount
integer
0
description
required
Description
string
id
required
Id
string
priority
Priority
string
default: medium
urgency
Urgency
string
default: this_week
current_cash
Any of:
integer
daily_burn
Any of:
integer
daily_revenue
Any of:
integer
data_status
Data Status
string
default: unavailable
projection
Projection
Array<object>
CashProjectionPoint

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
Date
string
inflows
Inflows
integer
0
outflows
Outflows
integer
0
projected_balance
Projected Balance
integer
0
reason
Any of:
string
runway_days
Any of:
integer
status
Status
string
default: unknown
working_capital
WorkingCapitalView
object
completed_at
Any of:
string format: date-time
currency
Any of:
string
observed_at
Any of:
string format: date-time
reason
Any of:
string
recommendations_only
Recommendations Only
boolean
default: true
report
Any of:
WorkingCapitalReport

Immutable native output; USD is the supported accounting contract.

object
ap_deferrals
required
Ap Deferrals
Array<object>
PaymentTimingRecommendation
object
amount_usd
required
Amount Usd
number
float_days_gained
required
Float Days Gained
integer
original_due_date
required
Original Due Date
string format: date
safe_defer_to
required
Safe Defer To
string format: date
vendor
required
Vendor
string
currency
required
Currency
string
Allowed value: USD
estimated_float_gain_usd
required
Estimated Float Gain Usd
number
late_payers
required
Late Payers
Array<object>
LatePayerRecommendation
object
average_days_overdue
required
Average Days Overdue
number
discount_note
required
Discount Note
string
overdue_invoice_count
required
Overdue Invoice Count
integer
>= 2
recipient_name
required
Recipient Name
string
recommend_discount
required
Recommend Discount
boolean
total_overdue_usd
required
Total Overdue Usd
number
observed_at
required
Observed At
string format: date-time
recommendations_only
required
Recommendations Only
boolean
report_date
required
Report Date
string format: date
source_connection_id
required
Source Connection Id
string format: uuid
summary
required
Summary
string
tenant_id
required
Tenant Id
string format: uuid
total_ar_at_risk_usd
required
Total Ar At Risk Usd
number
source_connection_id
Any of:
string format: uuid
status
Status
string
default: unavailable
Allowed values: ready stale unavailable superseded
task_id
Any of:
string format: uuid
meta
ApiMeta

Standard metadata included in every API response.

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

object
request_id
Request Id

Unique identifier for request tracing

string
timestamp
Timestamp

UTC timestamp of the response

string format: date-time
Example
{
  "data": {
    "cash_actions": [
      {
        "amount": 0,
        "priority": "medium",
        "urgency": "this_week"
      }
    ],
    "data_status": "unavailable",
    "projection": [
      {
        "inflows": 0,
        "outflows": 0,
        "projected_balance": 0
      }
    ],
    "reason": "Accounting observations are unavailable",
    "status": "unknown",
    "working_capital": {
      "reason": "No eligible completed CFO cash report is available",
      "recommendations_only": true,
      "report": {
        "currency": "USD",
        "recommendations_only": true
      },
      "status": "ready"
    }
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}