---
title: "Fixed six-completed-month Net burn card"
method: GET
path: "/companies/{companyId}/metrics/net-burn"
tags: ["Overview"]
---

# Fixed six-completed-month Net burn card

`GET /companies/{companyId}/metrics/net-burn`

## Request

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

Home "Net burn by month" card (F19). Always the previous six completed months — no range parameter. Six stable month slots (observed / authoritative_zero / unavailable), each numeric slot an exact signed net-burn minor-unit string from the canonical posted-operating-net-burn series, plus an aggregate six-month average that includes authoritative zeros and is unavailable with a missingMonths diagnostic when any window month lacks coverage — the denominator is never silently reduced. missingMonths names only months the posted books do NOT cover, so a fully covered window that carries no currency authority (books present, zero operating lines) is unavailable with an EMPTY missingMonths rather than one naming months the census covered. A series-level failure propagates verbatim as the average's reason (entity_scope_unavailable, truncated, mixed_currency, incomplete_provenance, failed), distinct from honest insufficient_history.

## Query parameters

- `entityId` string, uuid, required
- `live` 'true' | 'false'

## Response `200`

Net-burn card envelope

- NetBurnCardResponse
  - `success` true, required
  - `data` object, required
    - `months` 6, required
    - `startMonth` string, required
    - `endMonth` string, required
    - `slots` object[], required: Six completed months, oldest first; a live=true read appends the month in progress as a seventh slot.
      - `month` string, required
      - `state` 'observed' | 'authoritative_zero' | 'unavailable' | 'padding', required
      - `money` ExactMoney: Exact money value: signed integer minor units as a string (never a float), with explicit currency and minor-unit exponent.
        - `amountMinor` string, required: Signed integer minor units, e.g. "80000" = $800.00 at exponent 2.
        - `currency` string, required
        - `minorUnitExponent` integer, required
    - `inProgress` object: Live reads only (live=true). The appended month and the day its figures run to. The average never includes it.
      - `month` string, required
      - `postedThrough` string, date, required
    - `average` object, required
      - `available` boolean, required
      - `reason` string
      - `value` ExactMoney: Exact money value: signed integer minor units as a string (never a float), with explicit currency and minor-unit exponent.
        - `amountMinor` string, required: Signed integer minor units, e.g. "80000" = $800.00 at exponent 2.
        - `currency` string, required
        - `minorUnitExponent` integer, required
      - `diagnostic` object
        - `missingMonths` string[]
      - `authority` object
        - `companyId` string, uuid
        - `entityId` string, uuid
        - `basis` 'posted_operating_net_burn'
        - `asOf` string
        - `startMonth` string
        - `endMonth` string
        - `monthKeys` string[]
      - `completeness` MetricCompleteness, required: Coverage assertion for a per-metric value/authority contract. An available metric carries all three booleans as true.
        - `windowComplete` boolean, required
        - `sourceComplete` boolean, required
        - `provenanceComplete` boolean, required
        - `historyCompleteFrom` string
        - `booksAsOf` string
        - `sourceGeneration` string

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member
- `422`: Request failed validation
- `503`: The legal-entity scope authority could not be read

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)