Skip to main content

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.

Close Setup Wizard guides authorized users through creating a new financial close period, applying a checklist template, and adding initial tasks via the ModuleWizardRenderer infrastructure. Route: /fa/close/setup

​
Overview

The wizard uses ModuleWizardRenderer and on completion: creates a close period via useCreateClosePeriod, copies a selected checklist template to that period via useCopyChecklistToPeriod, and creates individual tasks via useCreateCloseTask. A progress bar (<Progress />) reflects wizard execution state. A realtime broadcast is sent on fa_events / close_period_started upon completion. On success the user is navigated to the new period’s detail page.

​
Who it’s for

Requires permission: fa.close.create

​
Before you start

  • You must hold the fa.close.create permission.
  • Checklist templates should already exist at /fa/close/templates to be selectable during setup.
  • A fiscal period configuration should be in place.

​
Steps

1

Navigate to Close Setup Wizard

Go to /fa/close/setup or click the setup action from the Close Periods page.
2

Complete wizard steps

Follow the ModuleWizardRenderer steps — enter period configuration, select a checklist template, and optionally add tasks.
3

Submit

Confirm on the final review step. The wizard creates the close period, copies the checklist, and creates tasks in sequence.
4

Review the new period

On success, navigate to the new period’s detail page at /fa/close/:id.

​
Key concepts

  • FinancialCloseSetupWizardData — Type for wizard form data.
  • WizardExecutionResult — Return type of the wizard completion mutation.
  • useCopyChecklistToPeriod — Hook that copies a template’s tasks to the newly created period.
  • useRealtimeBroadcast — Platform hook for broadcasting close_period_started on fa_events channel.

Finance & Revenue

Finance & Revenue core overview.

Governance & parity

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.
  • src/routes/fa.tsx
  • src/cores/fa/wizards/financial-close-setup/FinancialCloseSetupWizardPage.tsx
  • src/cores/fa/wizards/financial-close-setup/types.ts
  • src/cores/fa/close/index.ts