Overview

Posted P&L expense breakdown over completed months

Home "Expenses by category" card (F18). Signed net posted expense activity per category over a server-resolved completed-month window (never the current partial month), covering every P&L expense family (COGS, operating expense, depreciation/amortization, interest, income tax, other expense) with signed contra/refund effects. Exact minor-unit strings. A zero or negative signed total returns rows and total without percentages; a window the posted-books month census does not fully cover, mixed-currency, truncated, or entity-unattributable coverage returns available:false with a reason (never a partial total).

get/companies/{companyId}/metrics/expense-breakdown

Request

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

Query parameters

entityIdstring uuid required

Concrete legal entity the actor is authorized to read.

months1 | 3 | 6 | 12 required

Completed-month window size. Values outside 1|3|6|12 are a 422; there is no silent fallback.

live'true' | 'false'

Home Live mode. true ends the window at the month in progress (it takes the window's last slot, so 1 is the month to date) and sets authority.postedThrough to the day the figures run to. Omitted or false is the completed-month window. Any other value is a 422.

Response

Expense-breakdown metric envelope

successtrue required

Changes

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