---
title: "Current posted-books cash per legal entity"
method: GET
path: "/companies/{companyId}/metrics/cash-by-entity"
tags: ["Overview"]
---

# Current posted-books cash per legal entity

`GET /companies/{companyId}/metrics/cash-by-entity`

## Request

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

Returns the Home "Cash by entity" card: the cumulative POSTED journal-line cash balance per non-group legal entity, as of today. This is inherently the cross-entity read (no `entityId` param); rows are filtered to the entities the actor holds grants for. Honesty gates return available:false with a reason instead of a misleading card: `single_entity` (the card is only meaningful across entities), `no_accessible_entities`, `no_cash_accounts`.

## Response `200`

Cash-by-entity payload

- CashByEntityResponse
  - `success` true, required
  - `data` CashByEntityData, required
    - `available` boolean, required
    - `reason` 'single_entity' | 'no_accessible_entities' | 'no_cash_accounts': Present only when available is false. single_entity: the company has at most one non-group legal entity (the card is only meaningful across entities). no_accessible_entities: the actor's entity grants cover none of the entities. no_cash_accounts: the company has no cash GL accounts.
    - `entities` CashByEntityRow[], required: One row per authorized non-group legal entity; empty when available is false.
      - `entityId` string, uuid, required
      - `name` string, required
      - `balanceCents` integer, required: Cumulative posted cash balance for the entity, in cents, expressed in the entity's functional currency (never the company presentation currency).
      - `currency` string, required: The entity's functional currency (ISO 4217). The card formats each row with its own currency so foreign-functional entities are not mislabeled with the presentation symbol.
    - `asOf` string, date, required: YYYY-MM-DD the balances are posted through (today).

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member

---

[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)