Lunch Money V2 icon

Lunch Money V2

Interact with the Lunch Money v2 API — transactions, budgets, categories, accounts and more

Summary → Get Budget Summary

AI-generated

Summary

Retrieve a budget summary for a specified date range from Lunch Money, optionally including categories excluded from budgets, recurring item occurrences (and their past dates), totals, and rollover pool data.

Inputs

  • Start Date (required) — Start date of the summary period in YYYY-MM-DD format.
  • End Date (required) — End date of the summary period in YYYY-MM-DD format.
  • Include Exclude From Budgets — Include categories that are normally excluded from budgets in the summary.
  • Include Occurrences — Include recurring item occurrences in the budget summary.
  • Include Past Budget Dates — Include budget data from past periods; applicable only if recurring item occurrences are included.
  • Include Totals — Include totals in the budget summary.
  • Include Rollover Pool — Include rollover pool data in the summary.

Output shape

a JSON object representing the budget summary data for the given date range and options

The summary is retrieved via a GET request to the '/summary' endpoint with query parameters mapping directly to input fields. The structure of the returned summary mirrors the Lunch Money API's budget summary response format, providing detailed categorized budget information, totals, and rollover pool if requested.

Examples

Example 1: Get a budget summary for the year 2024 including totals and rollover pool data

Set Start Date to '2024-01-01', End Date to '2024-12-31', Include Totals to true, and Include Rollover Pool to true.

Links

Discussion