> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Budget Wizard

> Step-by-step wizard for creating a new budget, including header setup, optional template copy, line entry, and review before submission.

Budget Wizard is a multi-step wizard that guides authorized users through creating a new budget record, optionally copying from an existing template. Route: `/fa/budgets/wizard`

## Overview

The wizard uses the platform `ModuleWizardRenderer` infrastructure. It reads optional pre-populated state passed via `location.state` (e.g., when launching from the Template Library with `fromTemplate: true`). The four documented steps are: Budget Header, Copy Template (optional), Enter Budget Lines, and Review & Submit. On completion the user is navigated to the new budget detail page. On abandonment the user is returned to the budgets list.

Alternate entry: `/fa/budgets/new` redirects here.

## Who it's for

Requires permission: `fa.budgets.create`

## Before you start

* You must hold the `fa.budgets.create` permission.
* Fiscal periods and funds should already be configured so they are available during line entry.
* Optionally, budget templates can be pre-created to speed up line population.

## Steps

<Steps>
  <Step title="Navigate to the wizard">
    Go to `/fa/budgets/wizard` or click **Create Budget** from the Budgets list.
  </Step>

  <Step title="Complete Budget Header">
    Enter required header information for the budget record.
  </Step>

  <Step title="Copy Template (optional)">
    Select an existing budget template to pre-populate budget lines. Skip this step to enter lines manually.
  </Step>

  <Step title="Enter Budget Lines">
    Add or edit individual line items.
  </Step>

  <Step title="Review & Submit">
    Review the complete budget. Submit to trigger the approval workflow, or save as draft.
  </Step>
</Steps>

## Key concepts

* **`ModuleWizardRenderer`** — Platform wizard infrastructure that manages step navigation and validation.
* **`BudgetVersionType`** — Type discriminator for the budget record created by this wizard.
* **`useSubmitBudgetForApproval`** — Hook called on final submission to route the budget through the approval flow.
* **`location.state.fromTemplate`** — When `true`, pre-populates `budget_lines` from the passed template structure.

## Related

<Columns cols={2}>
  <Card title="Finance & Revenue" icon="building-columns" href="/fa/overview">
    Finance & Revenue core overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index" />
</Columns>

<Note>
  This page documents shipped product behavior. It is not medical, legal, or
  billing advice. Verify against your organization's policies and applicable
  regulations before using it for clinical, compliance, or billing decisions.
  Protected health information (PHI) shown in the product is governed by your
  tenant's access controls and is never exposed in this documentation.
</Note>

<Accordion title="Documentation sources">
  * src/routes/fa.tsx
  * src/cores/fa/wizards/budget-creation/BudgetCreationWizardPage.tsx
  * src/cores/fa/wizards/budget-creation/types.ts
  * src/cores/fa/hooks/useBudgets.ts
</Accordion>