`recurring_expenses`#

Lunch Money - Recurring Expenses

https://lunchmoney.dev/#recurring-expenses

`RecurringExpenseParamsGet` #

Bases: LunchableModel

https://lunchmoney.dev/#get-recurring-expenses

Parameters:

Name	Type	Description	Default
`start_date`	`date`		required
`debit_as_negative`	`bool \| None`		`None`

Source code in lunchable/models/recurring_expenses.py

class RecurringExpenseParamsGet(LunchableModel):
    """
    https://lunchmoney.dev/#get-recurring-expenses
    """

    start_date: datetime.date
    debit_as_negative: Optional[bool] = None

`RecurringExpensesClient` #

Bases: LunchMoneyAPIClient

Lunch Money Recurring Expenses Interactions

Source code in lunchable/models/recurring_expenses.py

class RecurringExpensesClient(LunchMoneyAPIClient):
    """
    Lunch Money Recurring Expenses Interactions
    """

    def get_recurring_expenses(
        self,
        start_date: Optional[datetime.date] = None,
        debit_as_negative: Optional[bool] = None,
    ) -> List[RecurringExpensesObject]:
        """
        Get Recurring Expenses

        **DEPRECATED** - Use [LunchMoney.get_recurring_items()][lunchable.LunchMoney.get_recurring_items]
        instead.

        Retrieve a list of recurring expenses to expect for a specified period.

        Every month, a different set of recurring expenses is expected. This is because recurring
        expenses can be once a year, twice a year, every 4 months, etc.

        If a recurring expense is listed as “twice a month”, then that recurring expense will be
        returned twice, each with a different billing date based on when the system believes that
        recurring expense transaction is to be expected. If the recurring expense is listed as
        “once a week”, then that recurring expense will be returned in this list as many times as
        there are weeks for the specified month.

        In the same vein, if a recurring expense that began last month is set to “Every 3
        months”, then that recurring expense will not show up in the results for this month.

        Parameters
        ----------
        start_date : Optional[datetime.date]
            Date to search. By default will return the first day of the current month
        debit_as_negative: bool
            Pass in true if you'd like expenses to be returned as negative amounts and credits as
            positive amounts.

        Returns
        -------
        List[RecurringExpensesObject]
        """
        warnings.warn(
            message=(
                "`LunchMoney.get_recurring_expenses` is deprecated, "
                "use `LunchMoney.get_recurring_items` instead"
            ),
            category=DeprecationWarning,
            stacklevel=2,
        )
        if start_date is None:
            start_date = datetime.datetime.now().date().replace(day=1)
        params = RecurringExpenseParamsGet(
            start_date=start_date, debit_as_negative=debit_as_negative
        ).model_dump(exclude_none=True)
        response_data = self.make_request(
            method=self.Methods.GET,
            url_path=[APIConfig.LUNCH_MONEY_RECURRING_EXPENSES],
            params=params,
        )
        recurring_expenses = response_data.get(APIConfig.LUNCH_MONEY_RECURRING_EXPENSES)
        recurring_expenses_objects = [
            RecurringExpensesObject.model_validate(item) for item in recurring_expenses
        ]
        logger.debug(
            "%s RecurringExpensesObjects retrieved", len(recurring_expenses_objects)
        )
        return recurring_expenses_objects

`get_recurring_expenses(start_date=None, debit_as_negative=None)` #

Get Recurring Expenses

DEPRECATED - Use LunchMoney.get_recurring_items() instead.

Retrieve a list of recurring expenses to expect for a specified period.

Every month, a different set of recurring expenses is expected. This is because recurring expenses can be once a year, twice a year, every 4 months, etc.

If a recurring expense is listed as “twice a month”, then that recurring expense will be returned twice, each with a different billing date based on when the system believes that recurring expense transaction is to be expected. If the recurring expense is listed as “once a week”, then that recurring expense will be returned in this list as many times as there are weeks for the specified month.

In the same vein, if a recurring expense that began last month is set to “Every 3 months”, then that recurring expense will not show up in the results for this month.

Parameters:

Name	Type	Description	Default
`start_date`	`Optional[date]`	Date to search. By default will return the first day of the current month	`None`
`debit_as_negative`	`Optional[bool]`	Pass in true if you'd like expenses to be returned as negative amounts and credits as positive amounts.	`None`

Returns:

Type	Description
`List[RecurringExpensesObject]`

Source code in lunchable/models/recurring_expenses.py

def get_recurring_expenses(
    self,
    start_date: Optional[datetime.date] = None,
    debit_as_negative: Optional[bool] = None,
) -> List[RecurringExpensesObject]:
    """
    Get Recurring Expenses

    **DEPRECATED** - Use [LunchMoney.get_recurring_items()][lunchable.LunchMoney.get_recurring_items]
    instead.

    Retrieve a list of recurring expenses to expect for a specified period.

    Every month, a different set of recurring expenses is expected. This is because recurring
    expenses can be once a year, twice a year, every 4 months, etc.

    If a recurring expense is listed as “twice a month”, then that recurring expense will be
    returned twice, each with a different billing date based on when the system believes that
    recurring expense transaction is to be expected. If the recurring expense is listed as
    “once a week”, then that recurring expense will be returned in this list as many times as
    there are weeks for the specified month.

    In the same vein, if a recurring expense that began last month is set to “Every 3
    months”, then that recurring expense will not show up in the results for this month.

    Parameters
    ----------
    start_date : Optional[datetime.date]
        Date to search. By default will return the first day of the current month
    debit_as_negative: bool
        Pass in true if you'd like expenses to be returned as negative amounts and credits as
        positive amounts.

    Returns
    -------
    List[RecurringExpensesObject]
    """
    warnings.warn(
        message=(
            "`LunchMoney.get_recurring_expenses` is deprecated, "
            "use `LunchMoney.get_recurring_items` instead"
        ),
        category=DeprecationWarning,
        stacklevel=2,
    )
    if start_date is None:
        start_date = datetime.datetime.now().date().replace(day=1)
    params = RecurringExpenseParamsGet(
        start_date=start_date, debit_as_negative=debit_as_negative
    ).model_dump(exclude_none=True)
    response_data = self.make_request(
        method=self.Methods.GET,
        url_path=[APIConfig.LUNCH_MONEY_RECURRING_EXPENSES],
        params=params,
    )
    recurring_expenses = response_data.get(APIConfig.LUNCH_MONEY_RECURRING_EXPENSES)
    recurring_expenses_objects = [
        RecurringExpensesObject.model_validate(item) for item in recurring_expenses
    ]
    logger.debug(
        "%s RecurringExpensesObjects retrieved", len(recurring_expenses_objects)
    )
    return recurring_expenses_objects

`RecurringExpensesObject` #

Bases: LunchableModel

Recurring Expenses Object

https://lunchmoney.dev/#recurring-expenses-object

Parameters:

Name	Type	Description	Default
`id`	`int`	Unique identifier for recurring expense	required
`start_date`	`date \| None`	Denotes when recurring expense starts occurring in ISO 8601 format. If null, then this recurring expense will show up for all time before end_date	`None`
`end_date`	`date \| None`	Denotes when recurring expense stops occurring in ISO 8601 format. If null, then this recurring expense has no set end date and will show up for all months after start_date	`None`
`cadence`	`str`	One of: [monthly, twice a month, once a week, every 3 months, every 4 months, twice a year, yearly]	required
`payee`	`str`	Payee of the recurring expense	required
`amount`	`float`	Amount of the recurring expense in numeric format to 4 decimal places	required
`currency`	`str`	Three-letter lowercase currency code for the recurring expense in ISO 4217 format	required
`description`	`str \| None`	If any, represents the user-entered description of the recurring expense	`None`
`billing_date`	`date`	Expected billing date for this recurring expense for this month in ISO 8601 format	required
`type`	`str`	This can be one of two values: cleared (The recurring expense has been reviewed by the user), suggested (The recurring expense is suggested by the system; the user has yet to review/clear it)	required
`original_name`	`str \| None`	If any, represents the original name of the recurring expense as denoted by the transaction that triggered its creation	`None`
`source`	`str`	This can be one of three values: manual (User created this recurring expense manually from the Recurring Expenses page), transaction (User created this by converting a transaction from the Transactions page), system (Recurring expense was created by the system on transaction import). Some older recurring expenses may not have a source.	required
`plaid_account_id`	`int \| None`	If any, denotes the plaid account associated with the creation of this " recurring expense (see Plaid Accounts)	`None`
`asset_id`	`int \| None`	If any, denotes the manually-managed account (i.e. asset) associated with the creation of this recurring expense (see Assets)	`None`
`category_id`	`int \| None`	If any, denotes the unique identifier for the associated category to this recurring expense	`None`

Source code in lunchable/models/recurring_expenses.py

class RecurringExpensesObject(LunchableModel):
    """
    Recurring Expenses Object

    https://lunchmoney.dev/#recurring-expenses-object
    """

    id: int = Field(description=_RecurringExpensesDescriptions.id)
    start_date: Optional[datetime.date] = Field(
        None, description=_RecurringExpensesDescriptions.start_date
    )
    end_date: Optional[datetime.date] = Field(
        None, description=_RecurringExpensesDescriptions.end_date
    )
    cadence: str = Field(description=_RecurringExpensesDescriptions.cadence)
    payee: str = Field(description="Payee of the recurring expense")
    amount: float = Field(description=_RecurringExpensesDescriptions.amount)
    currency: str = Field(
        max_length=3, description=_RecurringExpensesDescriptions.currency
    )
    description: Optional[str] = Field(
        None, description=_RecurringExpensesDescriptions.description
    )
    billing_date: datetime.date = Field(
        description=_RecurringExpensesDescriptions.billing_date
    )
    type: str = Field(description=_RecurringExpensesDescriptions.type)
    original_name: Optional[str] = Field(
        None, description=_RecurringExpensesDescriptions.original_name
    )
    source: str = Field(description=_RecurringExpensesDescriptions.source)
    plaid_account_id: Optional[int] = Field(
        None, description=_RecurringExpensesDescriptions.plaid_account_id
    )
    asset_id: Optional[int] = Field(
        None, description=_RecurringExpensesDescriptions.asset_id
    )
    category_id: Optional[int] = Field(
        None, description=_RecurringExpensesDescriptions.category_id
    )

recurring_expenses#

RecurringExpenseParamsGet #

RecurringExpensesClient #

get_recurring_expenses(start_date=None, debit_as_negative=None) #

RecurringExpensesObject #

`recurring_expenses`#

`RecurringExpenseParamsGet` #

`RecurringExpensesClient` #

`get_recurring_expenses(start_date=None, debit_as_negative=None)` #

`RecurringExpensesObject` #