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 Period Detail provides a full view of a single financial close period identified by :id, including its checklists, tasks, documentation attachments, validation status, and lifecycle controls. Route: /fa/close/:id

​
Overview

The page loads the close period via useClosePeriodDetail, its checklists via useClosePeriodChecklists, tasks via useCloseTasksByPeriod, and attached documentation via useCloseDocumentationList. The ClosePeriodProgress component shows overall completion. The CloseChecklistSection renders each checklist with expandable tasks. The CloseStatusBadge reflects the current CloseStatus. Lifecycle actions include Start, Submit for Approval, Approve, Complete (with audit), and Reopen (with audit). Period types are: month (Monthly Close), quarter (Quarterly Close), year (Year-End Close).

​
Who it’s for

Requires permission: fa.close.view

​
Before you start

  • A close period must be created before it can be viewed here.
  • The Start action transitions the period from open to in-progress.
  • Task completion is required before attempting to submit for approval or complete.

​
Steps

1

Navigate to a close period

Go to /fa/close and click a period row, or navigate directly to /fa/close/:id.
2

Review progress and checklists

ClosePeriodProgress shows overall task completion. Expand checklist sections to see individual tasks.
3

Start the period (if not started)

Click Start to call useStartClosePeriod and transition the period to in-progress.
4

Complete tasks

Mark each checklist task complete via CloseTaskDetailDialog.
5

Submit for approval

Click Submit to call useSubmitClosePeriodForApproval.
6

Approve and complete

Approvers can approve via useApproveClosePeriod. Complete the period via useCompleteClosePeriodWithAudit.
7

Reopen if needed

Click Reopen to call useReopenClosePeriodWithAudit.

​
Key concepts

  • CloseStatus — Enum/type for period lifecycle states (open, in_progress, pending_approval, closed, etc.).
  • periodTypeLabels — Maps month, quarter, year to display labels.
  • PeriodCloseValidationWidget — Renders validation checks required before completion.
  • useCompleteClosePeriodWithAudit / useReopenClosePeriodWithAudit — Audit-trail hooks for lifecycle transitions.

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/ClosePeriodDetailPage.tsx
  • src/cores/fa/components/CloseChecklistSection.tsx
  • src/cores/fa/components/ClosePeriodProgress.tsx
  • src/cores/fa/components/CloseStatusBadge.tsx
  • src/cores/fa/components/PeriodCloseValidationWidget.tsx
  • src/cores/fa/hooks/usePeriodCloseWithAudit.ts