Get budget

GET /api/v1/budgets/{budget_id}

Get a budget with all its line items.

Operation ID: get_budget_api_v1_budgets__budget_id__get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

budget_id string required

Responses

200 Successful Response

Schema: BudgetDetailResponse

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.

lines array · BudgetLineResponse BudgetLineResponse

Budget line items.

23 fields
id string required

Budget line UUID.

budget_id string required

Parent budget UUID.

ledger_id string required

Ledger account UUID.

ledger_name string

Ledger account name.

ledger_type string

Ledger account type (revenue, expense, etc.).

jan_amount integer required

January budget amount in cents.

feb_amount integer required

February budget amount in cents.

mar_amount integer required

March budget amount in cents.

apr_amount integer required

April budget amount in cents.

may_amount integer required

May budget amount in cents.

jun_amount integer required

June budget amount in cents.

jul_amount integer required

July budget amount in cents.

aug_amount integer required

August budget amount in cents.

sep_amount integer required

September budget amount in cents.

oct_amount integer required

October budget amount in cents.

nov_amount integer required

November budget amount in cents.

dec_amount integer required

December budget amount in cents.

annual_amount integer required

Total annual budget amount in cents.

quarterly_amounts object required

Amounts by quarter (q1, q2, q3, q4).

notes string

Line notes.

business_id string required

Business UUID.

created_at string · date-time required

Creation timestamp.

updated_at string · date-time required

Last update timestamp.

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