List budgets — budgets

Parameters

Query

status string

Filter by status: draft, active, closed

fiscal_year integer

Filter by fiscal year

search string

Search by budget name

offset integer

Number of records to skip

limit integer default: 50

Maximum records to return

include_total_count boolean default: False

Include total count (expensive - avoid if possible)

Responses

Schema: BudgetListResponse

items array · BudgetResponse requiredBudgetResponse

List of items

17 fields

id string required: Budget UUID.
name string required: Budget name.
fiscal_year integer required: Fiscal year.
start_date string · date required: Budget period start date.
end_date string · date required: Budget period end date.
status BudgetStatusEnum requiredBudgetStatusEnum: Budget status: draft, active, or closed.
period_type BudgetPeriodTypeEnum requiredBudgetPeriodTypeEnum: Period granularity.
description string: Budget description.
notes string: Additional notes.
line_count integer: Number of budget lines.
total_budgeted_revenue integer: Total budgeted revenue in cents.
total_budgeted_expenses integer: Total budgeted expenses in cents.
budgeted_net_income integer: Budgeted net income (revenue - expenses) in cents.
source_scenario_id string: CFO projection scenario UUID that generated this budget.
business_id string required: Business UUID.
created_at string · date-time required: Creation timestamp.
updated_at string · date-time required: Last update timestamp.

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields