Overview

Customer MRR movements history (accountant mirror)

Accountant-scoped mirror of GET /companies/{companyId}/metrics/mrr-movements. Unlike the customer mount, entityId is optional here — it defaults to the customer's single concrete entity. 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.

get/accountant/companies/{customerId}/metrics/mrr-movements

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/accountant/companies/{customerId}/metrics/mrr-movements
  • 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.

monthsinteger

Response

MRR movements envelope (same shape as the customer mount)

successtrue required

Example response

{
  "data": {
    "period": {
      "startMonth": "2025-08",
      "endMonth": "2026-07",
      "monthKeys": [
        "2026-07"
      ]
    },
    "historyCompleteFrom": "2025-11",
    "months": [
      {
        "month": "2026-06"
      }
    ],
    "coverageGaps": [
      "2026-09"
    ],
    "labelledGaps": [
      {
        "month": "2026-09"
      }
    ],
    "seam": {
      "month": "2026-10"
    }
  }
}

Changes

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