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.

The Report Builder page (/fa/reports/builder) lists saved custom report definitions and provides controls to create new ones, run existing reports, and view version history.

​
Overview

The Report Builder displays existing custom report definitions for the organization. Supported report types observed in code include: trial_balance, balance_sheet, stmt_activities, cash_flow, functional_expenses, grant_compliance, cash_flow_direct, and functional_expenses_matrix. Each definition card shows its name and report type. From a card the user can run the report (navigating to the appropriate report page with pre-filled filters), open the version history sheet, or delete the definition. A new definition can be created via the New Report button.

​
Who it’s for

Requires permission: fa.custom-report-builder.view.

​
Before you start

  • You need the fa.custom-report-builder.view permission to access this page.
  • Ensure at least one fiscal period exists so that reports can be generated.

​
Steps

View saved report definitions
  1. Navigate to /fa/reports/builder.
  2. Browse the definition cards. Each card displays the report name and type.
Create a new report definition
  1. Click New Report.
  2. Follow the builder form to select a report type, fields, and filters.
  3. Save the definition.
Run a saved report
  1. Locate the definition card.
  2. Click Run to navigate to the underlying report page with the saved filters applied.
View version history
  1. Locate the definition card.
  2. Open the version history sheet to see prior saved versions.

​
Key concepts

  • Report definition: A saved configuration object (useReportDefinitions hook) that stores report type, filters, and column configuration.
  • Report type labels: Human-readable names mapped in the component — e.g., stmt_activities → “Statement of Activities”.

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/pages/CustomReportBuilderPage.tsx
  • src/cores/fa/hooks/useReportDefinitions.ts
  • src/cores/fa/components/ReportVersionHistorySheet.tsx