Overview

Get home page insights (cash, burn, runway, reconciliation)

Returns the metrics surfaced on the customer home page for one authorized concrete legal entity. The new liveCashBalance / glCashBalance / reconciliationDeltaCents fields are additive; legacy fields (cashBalance, burnRate, runway, mrr) remain for backward compatibility. Gated behind HOME_INSIGHTS_V2_COMPANY_IDS at the service layer; callers always receive the legacy fields regardless of the gate.

get/companies/{companyId}/overview

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/overview
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid

Concrete legal entity to read on Home. Omission is accepted only when the actor is authorized to exactly one concrete entity. Consolidated or group scope is not silently collapsed to an arbitrary entity.

startDatestring date

Inclusive period start (YYYY-MM-DD). Must be supplied together with endDate.

endDatestring date

Inclusive period end (YYYY-MM-DD). Must be supplied together with startDate.

monthsinteger

Length of the monthlyRevenue chart series in months (clamped 1-12). Governs the series length ONLY — every other overview figure (headlines, burn, runway, breakdowns) keeps its own window. Invalid values fall back to the default.

Response

Overview payload

successtrue required

Example response

{
  "data": {
    "monthlyRevenueInProgress": {
      "month": "Sep 2026"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.