Open-source personal finance manager. Self-hosted, privacy-first.
from pydantic import BaseModel
class ReportBreakdown(BaseModel):
key: str
label: str
value: float
color: str
class ReportDataRange(BaseModel):
"""Oldest and newest transaction dates the workspace has (issue #765)."""
min_date: str | None = None
max_date: str | None = None
class ReportSummary(BaseModel):
primary_value: float
change_amount: float
change_percent: float | None
breakdowns: list[ReportBreakdown]
class ReportCompositionItem(BaseModel):
key: str
label: str
value: float
color: str
group: str
class ReportDataPoint(BaseModel):
date: str
value: float
breakdowns: dict[str, float]
change: float | None = None
composition: list[ReportCompositionItem] = []
class ReportMeta(BaseModel):
type: str
series_keys: list[str]
currency: str
interval: str
forecast_start_date: str | None = None
baseline_active: bool = False
baseline_lookback_days: int | None = None
# Cash flow only. ``runway_date`` is the first day (YYYY-MM-DD) the
# projected balance goes below zero, or None when it stays at or above
# zero through the horizon. ``lowest_balance`` is the minimum projected
# balance from today to the end of the horizon, on ``lowest_balance_date``.
runway_date: str | None = None
lowest_balance: float | None = None
lowest_balance_date: str | None = None
class CategoryTrendItem(BaseModel):
key: str
label: str
color: str
total: float
group: str
series: list[ReportDataPoint]
class ReportResponse(BaseModel):
summary: ReportSummary
trend: list[ReportDataPoint]
meta: ReportMeta
composition: list[ReportCompositionItem] = []
category_trend: list[CategoryTrendItem] = []