Firm

Read the firm status board overview

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.

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

Response

Current firm overview

firmNamestring required
mrrCentsinteger 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.

arpcCentsinteger required

Current MRR divided by the companies counted in it, in integer cents.

activeCompanyCountinteger required
attentionCountinteger required

Number of companies with at least one attention item

criticalCountinteger required
bankFeedHealthPctinteger required
reauthCountinteger required
openRequestCountinteger required
generatedAtstring date-time required

Changes

No recorded changes to this operation across all 5 revisions of this API.