Skip to content

Open-source personal finance manager. Self-hosted, privacy-first.

fix: serialize legacy payee types (#875)

WolfGanG651a23870e5c
diff --git a/backend/app/schemas/payee.py b/backend/app/schemas/payee.py
index 2aaffbff..3428f264 100644
--- a/backend/app/schemas/payee.py
+++ b/backend/app/schemas/payee.py
@@ -3,7 +3,7 @@ from datetime import date as _Date, datetime
from decimal import Decimal
from typing import Literal, Optional
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, field_validator
from app.fiscal.registry import TaxIdKind
from app.schemas.category import CategoryRead
@@ -71,6 +71,14 @@ class PayeeRead(BaseModel):
user_id: uuid.UUID
name: str
type: Optional[PayeeType] = None
+
+ @field_validator("type", mode="before")
+ @classmethod
+ def coerce_legacy_type(cls, value: Optional[str]) -> Optional[str]:
+ if value is not None and value not in ("person", "company"):
+ return None
+ return value
+
# Read-only. Exposed so a client picker can tell the handful of
# counterparties somebody entered on purpose from the hundreds sync
# created from card descriptors.
diff --git a/backend/tests/test_payees_api.py b/backend/tests/test_payees_api.py
index fea6c099..51bcc326 100644
--- a/backend/tests/test_payees_api.py
+++ b/backend/tests/test_payees_api.py
@@ -7,6 +7,7 @@ from httpx import AsyncClient
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.account import Account
+from app.models.payee import Payee
from app.models.transaction import Transaction
from app.models.user import User
@@ -78,6 +79,37 @@ async def test_list_payees(client: AsyncClient, auth_headers):
assert names == {"Alpha", "Beta"}
+async def test_list_payees_coerces_legacy_types_to_null(
+ client: AsyncClient,
+ auth_headers,
+ session: AsyncSession,
+ test_user: User,
+ test_workspace,
+):
+ legacy_types = ("transfer", "employer", "merchant")
+ session.add_all(
+ [
+ Payee(
+ id=uuid.uuid4(),
+ user_id=test_user.id,
+ workspace_id=test_workspace.id,
+ name=f"Legacy {legacy_type}",
+ type=legacy_type,
+ )
+ for legacy_type in legacy_types
+ ]
+ )
+ await session.commit()
+
+ resp = await client.get("/api/payees", headers=auth_headers)
+
+ assert resp.status_code == 200
+ assert {payee["name"]: payee["type"] for payee in resp.json()} == {
+ f"Legacy {legacy_type}": None for legacy_type in legacy_types
+ }
+
+
@pytest.mark.asyncio
async def test_list_payees_filters(client: AsyncClient, auth_headers):
mcd = await _create_payee(client, auth_headers, "McDonalds", type="company", notes="Burgers")