❇️ [refactor][backend] Rename Payment model to Event

Author: tomy0000000

backend/alembic/versions/7365aeb08d01_rename_payment_table_to_event.py

@@ -0,0 +1,23 @@
+"""rename payment table to event
+
+Revision ID: 7365aeb08d01
+Revises: 9ef5b1dd411f
+Create Date: 2026-06-23 22:59:21.548939
+
+"""
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "7365aeb08d01"
+down_revision = "9ef5b1dd411f"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.rename_table("payment", "event")
+
+
+def downgrade():
+    op.rename_table("event", "payment")

backend/kayman/crud/payment.py

@@ -3,18 +3,18 @@
 
 from sqlmodel import Session, func, select
 
-from kayman.schemas.payment import (
-    Payment,
-    PaymentBase,
-    PaymentCreate,
+from kayman.schemas.event import (
+    Event,
+    EventBase,
+    EventCreate,
     PaymentEntry,
 )
 
 
 def create_payment(
-    session: Session, payment: PaymentCreate, commit: bool = True
-) -> PaymentBase:
-    db_payment = Payment.model_validate(payment)
+    session: Session, payment: EventCreate, commit: bool = True
+) -> EventBase:
+    db_payment = Event.model_validate(payment)
     session.add(db_payment)
     if commit:
         session.commit()
@@ -24,16 +24,16 @@ def create_payment(
     return db_payment
 
 
-def read_payment(session: Session, payment_id: int) -> Payment | None:
-    return session.get(Payment, payment_id)
+def read_payment(session: Session, payment_id: int) -> Event | None:
+    return session.get(Event, payment_id)
 
 
 def read_payments(
     session: Session, payment_date: date | None = None, category_id: int | None = None
-) -> Sequence[Payment]:
-    scalar = select(Payment).distinct()
+) -> Sequence[Event]:
+    scalar = select(Event).distinct()
     if payment_date:
-        scalar = scalar.where(func.date(Payment.timestamp) == payment_date)
+        scalar = scalar.where(func.date(Event.timestamp) == payment_date)
     if category_id:
         scalar = scalar.join(PaymentEntry).where(
             PaymentEntry.category_id == category_id

backend/kayman/crud/payment_entry.py

@@ -2,7 +2,7 @@
 
 from sqlmodel import Session
 
-from kayman.schemas.payment import PaymentEntry, PaymentEntryBase
+from kayman.schemas.event import PaymentEntry, PaymentEntryBase
 
 
 def create_payment_entries(

backend/kayman/logics/payment.py

@@ -1,7 +1,7 @@
 from decimal import Decimal
 
 from kayman.schemas.api_models import PaymentCreateDetailed
-from kayman.schemas.payment import PaymentType
+from kayman.schemas.event import PaymentType
 
 
 def validate_total(details: PaymentCreateDetailed) -> None:

backend/kayman/routers/payment.py

@@ -17,11 +17,11 @@
 from kayman.logics.account import update_balances_with_transactions
 from kayman.logics.payment import validate_total
 from kayman.schemas.api_models import PaymentCreateDetailed, PaymentReadDetailed
-from kayman.schemas.payment import (
-    Payment,
-    PaymentBase,
+from kayman.schemas.event import (
+    Event,
+    EventBase,
+    EventRead,
     PaymentEntryBase,
-    PaymentRead,
 )
 from kayman.schemas.transaction import TransactionBase
 
@@ -257,7 +257,7 @@ def create(
     *,
     session: Session = Depends(get_session),
     body: PaymentCreateDetailed = Body(openapi_examples=EXAMPLES["create"]),
-) -> PaymentBase:
+) -> EventBase:
     # Validate total
     try:
         validate_total(body)
@@ -266,7 +266,7 @@ def create(
 
     # Store payment
     db_payment = create_payment(session, body.payment, commit=False)
-    payment_id = PaymentRead.model_validate(db_payment).id
+    payment_id = EventRead.model_validate(db_payment).id
 
     # Store entries
     entries = []
@@ -313,7 +313,7 @@ def create(
 @payment_router.get(
     "/{payment_id}", name="Read Payment", response_model=PaymentReadDetailed
 )
-def read(*, session: Session = Depends(get_session), payment_id: int) -> PaymentBase:
+def read(*, session: Session = Depends(get_session), payment_id: int) -> EventBase:
     payment = read_payment(session, payment_id)
     if payment is None:
         raise HTTPException(status_code=404, detail="Payment not found")
@@ -326,12 +326,12 @@ def reads(
     session: Session = Depends(get_session),
     payment_date: date | None = None,
     category_id: int | None = None,
-) -> Sequence[PaymentBase]:
+) -> Sequence[EventBase]:
     return read_payments(session, payment_date, category_id)
 
 
-@payment_router.patch("", name="Update Payment", response_model=PaymentRead)
-def update(*, session: Session = Depends(get_session), payment: Payment) -> PaymentBase:
+@payment_router.patch("", name="Update Payment", response_model=EventRead)
+def update(*, session: Session = Depends(get_session), payment: Event) -> EventBase:
     session.merge(payment)
     session.commit()
     session.refresh(payment)
@@ -340,7 +340,7 @@ def update(*, session: Session = Depends(get_session), payment: Payment) -> Paym
 
 @payment_router.delete("/{id}", name="Delete Payment")
 def delete(*, session: Session = Depends(get_session), id: int) -> None:
-    payment = session.get(Payment, id)
+    payment = session.get(Event, id)
     if payment is None:
         raise HTTPException(status_code=404, detail="Payment not found")
     session.delete(payment)

backend/kayman/schemas/__init__.py

@@ -2,7 +2,7 @@
 from kayman.schemas.category import Category
 from kayman.schemas.clients import Client, Token
 from kayman.schemas.currency import Currency
-from kayman.schemas.payment import Payment, PaymentEntry
+from kayman.schemas.event import Event, PaymentEntry
 from kayman.schemas.transaction import Transaction
 from kayman.schemas.tw_invoice import Invoice, InvoiceCarrier, InvoiceDetail
 
@@ -11,10 +11,10 @@
     "Category",
     "Client",
     "Currency",
+    "Event",
     "Invoice",
     "InvoiceCarrier",
     "InvoiceDetail",
-    "Payment",
     "PaymentEntry",
     "Token",
     "Transaction",

backend/kayman/schemas/api_models.py

@@ -2,16 +2,16 @@
 
 from sqlmodel import SQLModel
 
-from kayman.schemas.payment import (
-    PaymentCreate,
+from kayman.schemas.event import (
+    EventCreate,
+    EventRead,
     PaymentEntryCreate,
     PaymentEntryRead,
-    PaymentRead,
 )
 from kayman.schemas.transaction import TransactionCreate, TransactionRead
 
 
-class PaymentReadDetailed(PaymentRead):
+class PaymentReadDetailed(EventRead):
     """Includes transactions and entries."""
 
     transactions: list[TransactionRead]
@@ -21,6 +21,6 @@ class PaymentReadDetailed(PaymentRead):
 class PaymentCreateDetailed(SQLModel):
     """Includes transactions and entries."""
 
-    payment: PaymentCreate
+    payment: EventCreate
     transactions: list[TransactionCreate]
     entries: list[PaymentEntryCreate]

backend/kayman/schemas/category.py

@@ -3,7 +3,7 @@
 from sqlmodel import Field, Relationship, SQLModel
 
 if TYPE_CHECKING:
-    from kayman.schemas.payment import PaymentEntry
+    from kayman.schemas.event import PaymentEntry
 
 
 class CategoryBase(SQLModel):

backend/kayman/schemas/currency.py

@@ -4,7 +4,7 @@
 
 if TYPE_CHECKING:
     from kayman.schemas.account import Account
-    from kayman.schemas.payment import PaymentEntry
+    from kayman.schemas.event import PaymentEntry
 
 
 class Currency(SQLModel, table=True):

backend/kayman/schemas/payment.py backend/kayman/schemas/event.pybackend/kayman/schemas/payment.py renamed to backend/kayman/schemas/event.py

@@ -31,7 +31,7 @@ class PaymentType(enum.Enum):
 #
 
 
-class PaymentBase(SQLModel):
+class EventBase(SQLModel):
     type: PaymentType = Field(
         sa_column=Column(sqlmodel.Enum(PaymentType), nullable=False)
     )
@@ -43,19 +43,19 @@ class PaymentBase(SQLModel):
     description: str | None = None
 
 
-class Payment(PaymentBase, table=True):
+class Event(EventBase, table=True):
     id: int | None = Field(primary_key=True, default=None)
     # Auto calculated for Expense or Income
     # Manually logged for Transfer or Exchange
     transactions: list["Transaction"] = Relationship(back_populates="payment")
     entries: list["PaymentEntry"] = Relationship(back_populates="payment")
 
 
-class PaymentCreate(PaymentBase):
+class EventCreate(EventBase):
     pass
 
 
-class PaymentRead(PaymentBase):
+class EventRead(EventBase):
     id: int
 
 
@@ -65,7 +65,7 @@ class PaymentRead(PaymentBase):
 
 
 class PaymentEntryBase(SQLModel):
-    payment_id: int = Field(foreign_key="payment.id")
+    payment_id: int = Field(foreign_key="event.id")
     category_id: int = Field(foreign_key="category.id")
     amount: Decimal
     quantity: int
@@ -81,7 +81,7 @@ class PaymentEntry(PaymentEntryBase, table=True):
         ),
     )
     id: int | None = Field(primary_key=True, default=None)
-    payment: Payment = Relationship(back_populates="entries")
+    payment: Event = Relationship(back_populates="entries")
     category: "Category" = Relationship(back_populates="entries")
     currency: "Currency" = Relationship(back_populates="entries")