Overview

Monthly burn headline, hero series, and Runway composite

F04 hero contract. Returns the trailing-three-completed-month signed net Monthly burn headline (basis posted_operating_net_burn, exact minor-unit strings, month keys and numerator/denominator included so reconciliation never depends on rounded values), a hero sparkline series of one trailing-three-month value ending at each of the last twelve completed months, and the Runway composite (finite | depleted | non_burning, or unavailable — never negative months) over posted-books current cash. Requires one concrete authorized legal entity, resolved like /metrics/saas.

get/companies/{companyId}/metrics/burn-runway

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/metrics/burn-runway
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid

Optional concrete legal-entity scope for entity-scopable Home reads. Omitted means company-wide; when present it must be a legal entity the actor is authorized to read (the raw value is never trusted).

Response

Burn and runway payload

successtrue required

Example response

{
  "data": {
    "headline": {
      "diagnostic": {
        "missingMonths": [
          "2026-05"
        ]
      },
      "authority": {
        "startMonth": "2026-05",
        "endMonth": "2026-07",
        "monthKeys": [
          "2026-05"
        ]
      }
    },
    "series": {
      "value": {
        "slots": [
          {
            "month": "2026-05"
          }
        ]
      },
      "diagnostic": {
        "slots": [
          {
            "month": "2026-05"
          }
        ]
      }
    }
  }
}

Changes

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