Budget vs Actual — budgets

Parameters

Path

budget_id string required

Query

start_date string · date required

Comparison period start date

end_date string · date required

Comparison period end date

Responses

200 Successful Response

Schema: BudgetVsActualResponse

budget_id string required

Budget UUID.

budget_name string required

Budget name.

business_id string required

Business UUID.

business_name string required

Business name.

start_date string · date required

Report period start.

end_date string · date required

Report period end.

generated_at string · date-time required

When report was generated.

revenue BudgetVsActualSection requiredBudgetVsActualSection

Revenue section.

6 fields

section_name string required: Section name (e.g., 'Revenue', 'Expenses').
items array · BudgetVsActualLineItem BudgetVsActualLineItem: Line items in this section
total_budget integer required: Total budgeted for section.
total_actual integer required: Total actual for section.
total_variance integer required: Total variance for section.
total_variance_percent number: Total variance percentage.

expenses BudgetVsActualSection requiredBudgetVsActualSection

Expenses section.

6 fields

section_name string required: Section name (e.g., 'Revenue', 'Expenses').
items array · BudgetVsActualLineItem BudgetVsActualLineItem: Line items in this section
total_budget integer required: Total budgeted for section.
total_actual integer required: Total actual for section.
total_variance integer required: Total variance for section.
total_variance_percent number: Total variance percentage.

budgeted_net_income integer required

Budgeted net income in cents.

actual_net_income integer required

Actual net income in cents.

net_income_variance integer required

Net income variance in cents.

net_income_variance_percent number

Net income variance %.

net_income_variance_type VarianceTypeEnum requiredVarianceTypeEnum

Favorable or unfavorable.

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object