Cashflow dashboard

GET

/api/v1/dashboard/cashflow

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/dashboard/cashflow \
  --header 'X-API-Key: <X-API-Key>'

• Production
• Local development

Current cash position, monthly burn, runway, 90-day projection, and recommended daily cash actions.

Authorizations

• ApiKeyAuth

Responses

200

Successful Response

Media typeapplication/json

CashflowDashboardResponse

Wrapper response for GET /dashboard/cashflow.

Attributes: data: The cashflow dashboard payload.

object

data

required

CashflowDashboardData

Cashflow dashboard payload.

Attributes: cash_position: Current cash balance in USD. monthly_burn: Average monthly burn rate in USD. runway_days: Estimated days of runway remaining. projection_90d: Projected cash balance in 90 days. daily_actions: Recommended cash management actions. status: Overall runway health status.

object

cash_position

Any of:

number

number

null

null

daily_actions

Daily Actions

Recommended actions

Array<string>

data_status

Data Status

string

default: unavailable

monthly_burn

Any of:

number

number

null

null

projection_90d

Any of:

number

number

null

null

reason

Any of:

string

string

null

null

runway_days

Any of:

integer

integer

null

null

status

Status

string

default: unknown

working_capital

WorkingCapitalView

object

completed_at

Any of:

string

string format: date-time

null

null

currency

Any of:

string

string

null

null

observed_at

Any of:

string

string format: date-time

null

null

reason

Any of:

string

string

null

null

recommendations_only

Recommendations Only

boolean

default: true

report

Any of:

WorkingCapitalReport

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

null

null

source_connection_id

Any of:

string

string format: uuid

null

null

status

Status

string

default: unavailable

Allowed values: ready stale unavailable superseded

task_id

Any of:

string

string format: uuid

null

null

Example

{
  "data": {
    "data_status": "unavailable",
    "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"
    }
  }
}