Overview

Posted revenue by revenue GL account over completed months

Posted operating revenue for the selected entity over the resolved completed-month window (#2414, #2637). The chart of accounts carries the products (#3211): a product is an operating, credit-normal, non-contra revenue GL account, whether or not it carries a product key (J-364 keys name products for Stripe routing only). rows are those accounts with non-zero revenue, labelled by account name, and total ("Product revenue") is their sum. unattributedRevenue is 4999 Uncategorized Income only, and mappingComplete is always true. Refunds and discounts (contra or debit-normal revenue accounts) are refundsAndDiscounts, signed, and never a product. The tie-out holds exactly (J-367): total + unattributedRevenue + refundsAndDiscounts = operatingRevenue, the P&L operating revenue (Revenue accounts excluding other income and 4999) for the same entity and months. Amounts are exact minor units; no percentages are published. A window month with no posted books is available:false insufficient_history with the missing months named. The current partial month is never included. eligibility carries the company-level card visibility over the last 12 completed months (see RevenueByProductEligibility); it does not change the selected window's rows or census.

get/companies/{companyId}/metrics/revenue-by-product

Request

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

Query parameters

entityIdstring uuid required

Concrete legal-entity scope. REQUIRED — never a company roll-up, never a guessed entity.

months1 | 3 | 6 | 12

Completed calendar months in the window (1 = the previous full calendar month). Any other value returns 422.

Response

Revenue-by-product metric envelope

successtrue required

Changes

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