summary
Get a summary of all budgets with spending data.Parameters
No parameters required.Response
Returns an array of budget summaries with spending analytics.array
Array of budget summary objects
string
Budget ID
string
Budget amount
string
Category ID
string
Category name
string
Category icon
string | null
Parent category ID if this is a subcategory
string | null
Parent category name
string
Average spending over the past year
string
Average spending over the last 3 months
string
Year-to-date spending
string
Last month’s spending
string
Current month’s spending
string
Projected spending for the month
Date
Budget creation timestamp
Date
Budget last update timestamp
details
Get detailed budget information including monthly averages.Parameters
string
required
Budget ID
Date
required
Start date for the analysis period
Date
required
End date for the analysis period
Response
object
Budget summary object (same structure as summary endpoint)
array
Array of monthly average spending data
string
Month identifier (e.g., “2024-01”)
string
Average spending for that month
create
Create a new budget for a category.Parameters
string
required
ID of the category to budget for
string
required
Budget amount as a string numeric literal (e.g., “500.00”)
Response
string
Created budget ID
string
Category ID
string
Budget amount
Date
Creation timestamp
Date
Last update timestamp
update
Update an existing budget.Parameters
string
required
Budget ID to update
string
required
Category ID
string
required
Updated budget amount
Response
Returns the updated budget object.delete
Delete a budget.Parameters
string
required
Budget ID to delete