---
title: "Income/expense per month, and the expense split by category and by shop"
method: GET
path: "/groups/{groupId}/finance/summary"
tags: ["Legacy (v1-compat)"]
---

# Income/expense per month, and the expense split by category and by shop

`GET /groups/{groupId}/finance/summary`

## Request

- Base URL: `https://whatareyoudo.ing/api/v1`
- URL: `https://whatareyoudo.ing/api/v1/groups/{groupId}/finance/summary`
- Auth: HTTP bearer

Aggregated over the whole window rather than over a page of the ledger, which is what the charts used to add up.

## Path parameters

- `groupId` string, uuid, required

## Query parameters

- `months` string
- `currency` string: The one currency to add up (ISO 4217). Defaults to the group's.

## Response `200`

OK

- CompatFinanceSummary
  - `currency` string, required
  - `months` string[], required: every month in the window, oldest first, including empty ones
  - `totals` object[], required
    - `month` string, required
    - `income` number, required
    - `expense` number, required
  - `categories` object[], required
    - `month` string, required: YYYY-MM, UTC
    - `id` string, uuid, nullable, required: category or shop id; null is the uncategorised bucket
    - `expense` number, required
  - `shops` object[], required
    - `month` string, required: YYYY-MM, UTC
    - `id` string, uuid, nullable, required: category or shop id; null is the uncategorised bucket
    - `expense` number, required
  - `partial` boolean, required: the window held more rows than one read may scan, so the figures are a floor

---

[API](https://skmtc.dev/whatareyoudo/apis/whatcha-api.md) · [All operations](https://skmtc.dev/whatareyoudo/apis/whatcha-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatareyoudo/apis/whatcha-api/revisions/48dd8a54abea?raw)