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.

FA Alerts allows administrators to create, update, and delete alert threshold rules for financial metrics, triggering notifications when monitored values cross defined thresholds. Route: /fa/settings/alerts.

Overview

The FA Alerts page is accessible at /fa/settings/alerts and requires permission fa.settings.view. The component (AlertThresholdsPage) fetches alert thresholds via useAlertThresholds and displays them in a DataTable with columns for Name, Metric Type, Operator, Threshold Value, and actions. Supported metric types (from METRIC_LABELS): cash_balance, ar_aging_90, ar_aging_total, budget_variance, ap_aging_90, custom. Operators (from OPERATOR_LABELS): lt (<), gt (>), lte (≤), gte (≥), eq (=). Create, edit, and delete operations use useCreateAlertThreshold, useUpdateAlertThreshold, and useDeleteAlertThreshold. Editing opens AlertThresholdForm in a panel or dialog (formOpen state). Create requires PermissionGate around the New Alert button.

Who it’s for

Requires permission fa.settings.view.

Before you start

  • You must have fa.settings.view permission.
  • Identify the financial metric you want to monitor and the threshold value.

Steps

  1. Navigate to Finance → Settings → Alerts (/fa/settings/alerts).
  2. Review existing alert thresholds in the DataTable.
  3. To create a new alert, click New Alert (requires appropriate permission) and complete AlertThresholdForm.
  4. To edit an existing alert, click the edit action; AlertThresholdForm opens pre-populated.
  5. To delete an alert, use the delete action in the row.

Key concepts

ConceptDescription
useAlertThresholdsHook fetching all configured alert threshold records
AlertThresholdFormForm for creating or editing an alert threshold
METRIC_LABELSSupported metric types: cash_balance, ar_aging_90, ar_aging_total, budget_variance, ap_aging_90, custom
OPERATOR_LABELSComparison operators: lt, gt, lte, gte, eq

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/AlertThresholdsPage.tsx