Portfolio

Cross-company reads for keys that reach more than one company: one overview call over a membership-checked scope (all, byrå team, or explicit ids) instead of one call per company.

Endpoints

GET /api/v1/portfolio/overview: Cross-company overview: unbooked, inbox and next deadline per company the key can reach.

`GET` /api/v1/portfolio/overview

portfolio.overview · scope companies:read

Cross-company overview: unbooked, inbox and next deadline per company the key can reach.

One read over many companies: for every company in scope, the unbooked bank transactions, the unconsumed inbox documents, the next open deadline with its urgency, the latest booked date and the open deadlines (earliest first, at most 10). Rows are urgency-sorted: overdue deadline first, then the largest unbooked pile. The scope is every non-archived company the key user is a member of (default), the key user's byrå team (team=true), or an explicit comma-separated companies list; exclude removes ids from any of them. The scope is capped at 25 companies per call: scope.truncated says so and scope.remaining_company_ids lists the rest so the next call can pass them as companies. The filters (deadline_kind, deadline_within_days, min_unbooked, min_inbox) narrow the rows; summary.companies is the scope size and summary.matched the rows left.

Use when: The key reaches several companies and you need to know where to work first: which companies have VAT due this week, who has unbooked transactions piling up, whose inbox is waiting.

Don't use for: A single company (GET /api/v1/companies/{companyId} plus its per-resource lists), or discovering company ids: GET /api/v1/companies lists them without the numbers.

Pitfalls

Unknown, archived or non-member ids in companies do not fail the call: they come back in scope.unresolved with a 200. Check it before trusting an empty result.
team=true with no byrå team returns an empty scope and team: null, not an error. A byrå member without client companies also gets an empty scope, with team set.
More than 25 companies in scope: the response is truncated (scope.truncated) and scope.remaining_company_ids carries the ids beyond the cap. Call again with companies=<those ids>.
deadline_kind matches deadlines.tax_deadline_type, so custom deadlines (no tax type) never match a kind; deadline_within_days alone looks at the next deadline of any kind, custom included.
next_deadline is the earliest open deadline of ANY kind even when deadline_kind is set; read deadlines[] for the one that matched.
Counts follow the same predicates as the app (unbooked: is_business unset and not ignored; inbox: a document that has become nothing yet), so they equal what the user sees in Att göra.

Risk: low · Idempotent: yes · Reversible: no · Dry-run supported: no

Query parameters

Name	Type	Required	Description
`companies`	string	no	Comma-separated company ids to read, in this order. Omitted: every company the key can access.
`team`	"true" \| "false"	no	true: only the companies on the key user's byrå team. Cannot be combined with companies.
`exclude`	string	no	Comma-separated company ids to leave out.
`deadline_kind`	"vat" \| "agi" \| "f_skatt" \| "inkomstdeklaration" \| "arsredovisning" \| "any"	no	Keep companies with an open deadline of this kind: vat (moms incl. OSS/IOSS), agi (arbetsgivardeklaration), f_skatt (F-skatt and skatteinbetalning), inkomstdeklaration, arsredovisning (incl. arsstamma), any (any tax deadline).
`deadline_within_days`	number	no	Keep companies whose deadline (of deadline_kind, else the next of any kind) is due within N days, overdue included.
`min_unbooked`	number	no	Keep companies with at least this many unbooked bank transactions.
`min_inbox`	number	no	Keep companies with at least this many unconsumed inbox documents.

Response fields

Name	Type
`team`	object \| null
`scope`	object
`summary`	object
`companies`	object[]

Example response

{
  "data": {
    "team": {
      "id": "2a7a9e8c-4c2e-4a68-9a1a-4f0f6f3f2a10",
      "name": "Siffra Redovisning"
    },
    "scope": {
      "truncated": false,
      "remaining_company_ids": [],
      "unresolved": []
    },
    "summary": {
      "companies": 2,
      "matched": 2,
      "unbooked_total": 14,
      "inbox_total": 3,
      "overdue": 1,
      "action_needed": 0
    },
    "companies": [
      {
        "company_id": "8fd5b1f4-0000-4000-8000-000000000001",
        "name": "Acme AB",
        "org_number": "556677-8899",
        "entity_type": "aktiebolag",
        "role": "member",
        "team_id": "2a7a9e8c-4c2e-4a68-9a1a-4f0f6f3f2a10",
        "unbooked_count": 11,
        "inbox_count": 3,
        "next_deadline": {
          "title": "Momsdeklaration",
          "due_date": "2026-09-12",
          "tax_deadline_type": "moms_quarterly",
          "urgency": "overdue"
        },
        "last_booked_date": "2026-08-28",
        "deadlines": [
          {
            "title": "Momsdeklaration",
            "due_date": "2026-09-12",
            "tax_deadline_type": "moms_quarterly",
            "urgency": "overdue"
          },
          {
            "title": "Arbetsgivardeklaration",
            "due_date": "2026-10-12",
            "tax_deadline_type": "arbetsgivardeklaration",
            "urgency": "upcoming"
          }
        ]
      },
      {
        "company_id": "8fd5b1f4-0000-4000-8000-000000000002",
        "name": "Beta Konsult",
        "org_number": null,
        "entity_type": "enskild_firma",
        "role": "member",
        "team_id": "2a7a9e8c-4c2e-4a68-9a1a-4f0f6f3f2a10",
        "unbooked_count": 3,
        "inbox_count": 0,
        "next_deadline": null,
        "last_booked_date": "2026-09-15",
        "deadlines": []
      }
    ]
  },
  "meta": {
    "request_id": "req_…",
    "api_version": "2026-05-12"
  }
}

Portfolio

Endpoints

GET /api/v1/portfolio/overview

`GET` /api/v1/portfolio/overview