cashcat_get
Generic read-only access to any CashCat REST GET endpoint with optional auto-pagination. Description: Read any CashCat REST GET endpoint (accounts, categories, groups, assignments, transactions, transfers, budget-left).Parameters
The REST API endpoint to query. Must be one of:
accountsassignmentscategoriescategories/budget-leftgroupstransactionstransfers
Query parameters passed through to the selected endpoint. Each endpoint accepts different query parameters based on its REST API specification.Values can be strings, numbers, or booleans.
If
true, automatically follows cursor pagination until max_rows is reached or all data is retrieved.If false, returns only the first page of results.Maximum number of rows to return when
paginate_all is true.- Minimum:
1 - Maximum:
10000
Response
Whenpaginate_all is false:
paginate_all is true:
cashcat_financial_overview
Advisory-friendly financial snapshot including net worth, budget health, overspending analysis, and monthly cashflow. Description: Get an advisory-friendly snapshot: net worth, budget health, overspending, and monthly cashflow.Parameters
Optional month in
YYYY-MM format.If omitted, defaults to the current month (or the month derived from as_of_date).Optional as-of date in
YYYY-MM-DD format for balance calculations.Must be in the same month as month if both are provided.Maximum rows to fetch per endpoint when building summaries.
- Minimum:
100 - Maximum:
10000
Number of recent transactions and transfers to include in the response.
- Minimum:
1 - Maximum:
200
Response
cashcat_full_context
Fetch a broad, structured financial context bundle across all major endpoints for deep analysis and advice. Description: Fetch a broad, structured financial context bundle across all major endpoints for deep analysis/advice.Parameters
Optional month in
YYYY-MM format.Cannot be used together with start_date and end_date.Optional start date in
YYYY-MM-DD format for transaction and transfer windows.Cannot be used together with month.Optional end date in
YYYY-MM-DD format for transaction and transfer windows.Cannot be used together with month. Must be after start_date.Optional balance as-of date in
YYYY-MM-DD format.Include accounts with balances in the response.
Include categories in the response.
Include groups with budget totals in the response.
Include budget assignments in the response.
Include transactions in the response.
Include transfers in the response.
Include budget-left calculations in the response.
Maximum rows to fetch per endpoint.
- Minimum:
100 - Maximum:
10000