Books hub overview (today's balances, last completed month)
Demo-parity customer route for an explicitly allowlisted active or test company. /qa callers additionally require the QA application marker and persisted test lifecycle. Returns a single-screen summary of the company's financial position. Balances are as of today (read at the current UTC month end, so they tie to the Assets and Liabilities sub-ledgers); revenue and expenses cover the last completed calendar month (UTC). Revenue is operating revenue (other income and 4999 Uncategorized Income excluded). Includes headline asset / liability / revenue / expense figures plus composition segments and P&L spark series for the trailing months. All monetary amounts are in cents (integer). Every amount comes from the selected entity's posted books. A liability balance is never mirrored into a synthetic asset segment. A company that has never closed a GL period still gets its real balances (#2411).
Request
- Base URL: https://api.medianfi.com/api/v1
- URL: https://api.medianfi.com/api/v1/companies/{companyId}/books/overview
- Auth: HTTP bearer
Query parameters
Concrete legal entity to read. Mutually exclusive with reportingScopeId/scopeAsOf. Omission is accepted only when the actor is authorized to exactly one concrete entity.
Response
Books overview payload
Changes
No recorded changes to this operation across all 1 revision of this API.