---
title: "Read the firm status board overview"
method: GET
path: "/firm/overview"
tags: ["Firm"]
---

# Read the firm status board overview

`GET /firm/overview`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/firm/overview`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Returns firm MRR and ARPC with their source and freshness, active-company health and work rollups, Plaid health, open client requests, recent notifications, Tally usage/model status, and recorded daily MRR snapshots. Only complete MRR totals are recorded in the daily history. Stale mirrored Stripe fees are refreshed after the response.

## Response `200`

Current firm overview

- object
  - `firmName` string, required
  - `mrrCents` integer, required: Current monthly recurring revenue in integer cents. With Stripe connected, only Stripe-billed fees count; unlinked, unread, and usage-based companies are left out and reported in mrrStatus.
  - `mrrStatus` object: Source, completeness, and freshness of mrrCents. Absent on snapshots built before the Stripe fee mirror.
    - `source` 'stripe' | 'engagement'
    - `complete` boolean
    - `countedCompanyCount` integer
    - `notLinkedCompanyCount` integer
    - `pendingCompanyCount` integer
    - `variableCompanyCount` integer
    - `syncedAt` string, date-time, nullable
    - `stale` boolean
  - `arpcCents` integer, required: Current MRR divided by the companies counted in it, in integer cents.
  - `activeCompanyCount` integer, required
  - `attentionItems` object[], required
    - `id` string, required
    - `companyOrganizationId` string, uuid, required
    - `companyName` string, required
    - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
    - `title` string, required
    - `detail` string, nullable, required
    - `href` string, required
  - `attentionCount` integer, required: Number of companies with at least one attention item
  - `criticalCount` integer, required
  - `workByStage` object, required
    - `setup` integer, required
    - `ask` integer, required
    - `book` integer, required
    - `rec` integer, required
    - `review` integer, required
    - `report` integer, required
  - `workItemsByStage` object, required
    - `setup` object[], required
      - `id` string, required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
      - `title` string, required
      - `detail` string, nullable, required
      - `href` string, required
    - `ask` object[], required
      - `id` string, required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
      - `title` string, required
      - `detail` string, nullable, required
      - `href` string, required
    - `book` object[], required
      - `id` string, required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
      - `title` string, required
      - `detail` string, nullable, required
      - `href` string, required
    - `rec` object[], required
      - `id` string, required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
      - `title` string, required
      - `detail` string, nullable, required
      - `href` string, required
    - `review` object[], required
      - `id` string, required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
      - `title` string, required
      - `detail` string, nullable, required
      - `href` string, required
    - `report` object[], required
      - `id` string, required
      - `companyOrganizationId` string, uuid, required
      - `companyName` string, required
      - `section` 'setup' | 'ask' | 'book' | 'rec' | 'review' | 'report', required
      - `title` string, required
      - `detail` string, nullable, required
      - `href` string, required
  - `companyHealth` object, required
    - `healthy` integer, required
    - `atRisk` integer, required
    - `critical` integer, required
  - `bankFeedHealthPct` integer, required
  - `reauthCount` integer, required
  - `openRequestCount` integer, required
  - `companies` object[], required
    - `id` string, uuid, required
    - `name` string, required
    - `contactName` string, nullable, required
    - `contactEmail` string, nullable, required
    - `monthlyFeeCents` integer, nullable, required
    - `ytdProfitCents` integer, nullable, required
    - `health` 'healthy' | 'at_risk' | 'critical', required
    - `openWorkCount` integer, required
    - `href` string, required
    - `status` 'on_track' | 'needs_attention' | 'behind' | 'needs_setup', required
    - `feeds` object, required
      - `current` integer, nullable, required
      - `total` integer, nullable, required
      - `issues` object[], required
        - `summary` string, required
        - `detail` string, required
        - `action` string, required
    - `recs` object, required
      - `current` integer, nullable, required
      - `total` integer, nullable, required
      - `issues` object[], required
        - `summary` string, required
        - `detail` string, required
        - `action` string, required
    - `coding` object, required
      - `count` integer, nullable, required
      - `issues` object[], required
        - `summary` string, required
        - `detail` string, required
        - `action` string, required
    - `statements` object, required
      - `current` integer, nullable, required
      - `total` integer, nullable, required
      - `issues` object[], required
        - `summary` string, required
        - `detail` string, required
        - `action` string, required
    - `requests` object, required
      - `count` integer, nullable, required
      - `oldestOpenDays` integer, nullable, required
      - `issues` object[], required
        - `summary` string, required
        - `detail` string, required
        - `action` string, required
  - `recentActivity` object[], required
    - `id` string, uuid, required
    - `title` string, required
    - `detail` string, nullable, required
    - `createdAt` string, date-time, required
  - `tallyUsage` object, required
    - `periodKey` string, required
    - `limitCents` integer, required
    - `spentCents` integer, required
    - `remainingCents` integer, required
    - `percentUsed` integer, required
    - `resetDate` string, date-time, required
    - `state` string, required
  - `integrationStatuses` object, required
    - `plaid` object, required
      - `status` 'operational' | 'degraded', required
      - `connectionCount` integer, required
      - `healthyCount` integer, required
      - `reauthCount` integer, required
    - `tally` object, required
      - `status` 'operational' | 'degraded', required
      - `modelName` string, required
      - `state` string, required
  - `mrrSnapshots` object[], required
    - `date` string, date, required
    - `mrrCents` integer, required
    - `activeCompanyCount` integer, required
  - `generatedAt` string, date-time, required

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)