Overview

Fixed six-completed-month Net burn card

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.

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

Query parameters

entityIdstring uuid required

Concrete legal entity the actor is authorized to read.

live'true' | 'false'

Home Live mode. true appends the month in progress as a seventh slot and returns inProgress { month, postedThrough }; endMonth becomes that month. The average stays the six completed months. Omitted or false is the six completed months only. Any other value is a 422.

Response

Net-burn card envelope

successtrue required

Changes

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