Skip to content

domain.enums.transaction_type

src.domain.enums.transaction_type

Transaction type enumeration.

This module defines the high-level transaction type classification. Part of the two-level classification system (Type + Subtype).

Classes

TransactionType

Bases: str, Enum

High-level transaction category (normalized across providers).

We use simplified, normalized types rather than provider-specific ones. This allows consistent behavior across different providers while the subtype field captures the specific action.

Provider Mapping Examples

Schwab TRADE -> TRADE Schwab ACH_RECEIPT -> TRANSFER Schwab DIVIDEND_OR_INTEREST -> INCOME Chase buy/sell -> TRADE Chase dividend -> INCOME

Source code in src/domain/enums/transaction_type.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class TransactionType(str, Enum):
    """High-level transaction category (normalized across providers).

    We use simplified, normalized types rather than provider-specific ones.
    This allows consistent behavior across different providers while
    the subtype field captures the specific action.

    Provider Mapping Examples
    -------------------------
    Schwab TRADE -> TRADE
    Schwab ACH_RECEIPT -> TRANSFER
    Schwab DIVIDEND_OR_INTEREST -> INCOME
    Chase buy/sell -> TRADE
    Chase dividend -> INCOME
    """

    # Security transactions (executed trades)
    TRADE = "trade"  # Buy/sell/short/cover of any security

    # Cash movements
    TRANSFER = "transfer"  # Deposits, withdrawals, ACH, wire, etc.

    # Income (passive)
    INCOME = "income"  # Dividends, interest, distributions

    # Fees and charges
    FEE = "fee"  # Account fees, commissions, other charges

    # Other/Administrative
    OTHER = "other"  # Journal entries, adjustments, uncategorized

    @classmethod
    def security_related(cls) -> list["TransactionType"]:
        """Return types that may involve securities.

        Returns:
            List of transaction types that can involve securities.
            INCOME is included because dividends are tied to securities.

        Examples:
            >>> TransactionType.security_related()
            [TransactionType.TRADE, TransactionType.INCOME]
        """
        return [cls.TRADE, cls.INCOME]
Functions
security_related() -> list[TransactionType]

Return types that may involve securities.

Returns:

Type Description
list[TransactionType]

List of transaction types that can involve securities.
list[TransactionType]

INCOME is included because dividends are tied to securities.

Examples:

>>> TransactionType.security_related()
[TransactionType.TRADE, TransactionType.INCOME]
Source code in src/domain/enums/transaction_type.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
@classmethod
def security_related(cls) -> list["TransactionType"]:
    """Return types that may involve securities.

    Returns:
        List of transaction types that can involve securities.
        INCOME is included because dividends are tied to securities.

    Examples:
        >>> TransactionType.security_related()
        [TransactionType.TRADE, TransactionType.INCOME]
    """
    return [cls.TRADE, cls.INCOME]