Overview

Customer Home overview (accountant mirror)

Accountant-scoped read-only mirror of GET /companies/{companyId}/overview — the same service, so the accountant sees exactly the numbers the customer's Home board shows. Requires assignment to the customer (403 otherwise). Entity scope is resolved from the customer's own entity roster (accountants hold no per-user entity grants): an explicit entityId must be one of the customer's concrete (non-group) entities; absent, the customer's single concrete entity is used; a multi-entity customer without entityId gets 422 ENTITY_SELECTION_REQUIRED and a customer with no entity gets 422 ENTITY_SCOPE_UNAVAILABLE. With a concrete entity resolved, the overview's non-blocking balance refreshers never fire, so this read is side-effect-free.

get/accountant/companies/{customerId}/overview

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/accountant/companies/{customerId}/overview
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

entityIdstring uuid

Concrete legal entity to read on Home. Omission is accepted only when the actor is authorized to exactly one concrete entity. Consolidated or group scope is not silently collapsed to an arbitrary entity.

startDatestring date

Inclusive period start (YYYY-MM-DD). Must be supplied together with endDate.

endDatestring date

Inclusive period end (YYYY-MM-DD). Must be supplied together with startDate.

monthsinteger

Response

Overview payload (same shape as the customer mount)

successtrue required

Example response

{
  "data": {
    "monthlyRevenueInProgress": {
      "month": "Sep 2026"
    }
  }
}

Changes

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