Rhythm 2.0 Specifications

Appearance

CAP-ACC-CLS-014Retain the evidence and history of each close

Markdown

CAP-ACC-CLS-014

Retain the evidence and history of each close

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-ACC-CLS-04
Exercised by
FAS-ACC-CLS-04-01, FAS-ACC-CLS-04-02, FAS-ACC-CLS-04-03, FAS-ACC-CLS-04-04, FAS-ACC-CLS-04-05, JNY-ACC-CLS-003
Key concepts
CON-ACC-CLS-004
Actors
ACT-ACC-007, ACT-ACC-015, ACT-ACC-016
Journeys
JNY-ACC-CLS-001
Depends on
CAP-ACC-CLS-008
Related
CAP-ACC-CLS-006, CAP-ACC-CLS-011, CAP-ACC-CLS-016
Proved by
ATS-ACC-CLS-014

Implementation

Executable suites
TST-ACC-CLS-017, TST-ACC-CLS-018, TST-ACC-CLS-021, TST-ACC-CLS-031, TST-ACC-CLS-032

KindCapabilityProduct areaAccountingModuleMonth-End ClosingRevision1

Read atservices-accounting f47cb263react-console baf6dae3

Retain the evidence and history of each close ​

Purpose ​

Reviewers can recover the evaluation, reconciliation context and later reopening history of a completed close.

How It Works ​

Finalization stores a snapshot alongside the successful period change. It keeps the revalidation result rather than evaluating readiness again for the record. Reconciliation information and close outputs remain part of that captured evidence. Reviewers reach the record from run history or the successful run. The response combines retained information with linked reopening history. Reopening does not update the original snapshot. An incomplete close or reopen has no close record. Database protections prevent updates to the snapshot and deletion of records still referenced by it. Workspace policies separate customer histories. Linked reopen history currently stops at the oldest one hundred runs without a continuation.

Relationships ​

  • Close execution writes the retained snapshot.
  • Reconciliation readiness supplies its payment context.
  • Reopening links subsequent correction requests.
  • Export and erasure carry or remove these retained records.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Close-time evidence remains available for later review.Reopening adds history without replacing the original snapshot.
Surfaces
consoleapi

Controls

21 controls apply, from the corpus control catalogue.

TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-006 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-DAT-001 TC-DAT-004 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005

Permissions

KeyChecked atScope
accounting.fiscal-periods.readapitenant

Business Rules

8 rules, 7 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
Each successful close records one immutable snapshot containing its evaluated readiness, reconciliation context, close outputs and acknowledged warnings.
origin: fiscal-close design L13 (a snapshot at close added)
proved by ATS-ACC-CLS-014-01, ATS-ACC-CLS-014-06, TST-ACC-CLS-018, TST-ACC-CLS-021
invariantdatabase, servicetest
services-accounting:modules/fiscal-close/tests/integration/db/fiscal-close.table.integration.spec.js#refuses the application role any update of a snapshot, which is written once
02must prove
Proposed
The snapshot must identify its run’s period, and each stored document must be an object smaller than 512 kilobytes.
proved by ATS-ACC-CLS-014-01, ATS-ACC-CLS-014-08, TST-ACC-CLS-018, TST-ACC-CLS-021, TST-ACC-CLS-031
validationdatabasetest
services-accounting:modules/fiscal-close/tests/integration/db/fiscal-close.table.integration.spec.js#refuses a snapshot that names a period other than its run’s, by the run’s foreign key
03must prove
Proposed
The close record combines the run, captured readiness and reconciliation, exception participants, audit entries and linked reopen runs.
origin: fiscal-close design L12 (close runs, readiness at close and audit persisted)
proved by ATS-ACC-CLS-014-02, ATS-ACC-CLS-014-06, TST-ACC-CLS-017
policyservicetest
services-accounting:modules/fiscal-close/tests/e2e/fiscal-close-runs.e2e.spec.js#answers the completed close’s record
04must prove
Proposed
A record is available only for a successful close with a snapshot; reopen and incomplete-close requests return not found.
proved by ATS-ACC-CLS-014-03
validationserviceobserved
services-accounting:modules/fiscal-close/services/runs/close-run-view.ts:closeRecordOf
05must prove
Proposed
The run’s kind, period, requester and request time are fixed, a reopen has a reason, and finished status requires a finish time no earlier than the request.
proved by ATS-ACC-CLS-014-04, TST-ACC-CLS-018
invariantdatabasetest
services-accounting:modules/fiscal-close/tests/integration/db/fiscal-close.table.integration.spec.js#refuses changing a run’s kind, which is written once
06must prove
Proposed
Referenced periods cannot be deleted while runs remain, and runs cannot be deleted while snapshots refer to them.
proved by ATS-ACC-CLS-014-04, ATS-ACC-CLS-014-06, TST-ACC-CLS-018
invariantdatabasetest
services-accounting:modules/fiscal-close/tests/integration/db/fiscal-close.table.integration.spec.js#refuses deleting a period a run names
07must prove
Proposed
Workspace policies isolate reading and writing of runs and snapshots.
proved by ATS-ACC-CLS-014-05, ATS-ACC-CLS-014-06, TST-ACC-CLS-018, TST-ACC-CLS-032
invariantdatabasetest
services-accounting:modules/fiscal-close/tests/integration/db/fiscal-close.table.integration.spec.js#hides the run and the snapshot from another tenant
08
Proposed
The record returns at most one hundred linked reopen runs in oldest-first order without pagination.
proved by ATS-ACC-CLS-014-07
policyserviceobserved
services-accounting:modules/fiscal-close/services/persistence/period-close-runs.ts:listReopenRunsOfCloseRun

Scenarios

IdGivenWhenThenProvenance
01A close captured an accepted exception and was subsequently reopened.An auditor reads the original close record.The captured evaluation and exception participants remain available with the linked reopen and reason.test
services-accounting:modules/fiscal-close/tests/e2e/fiscal-close-runs.e2e.spec.js#lists the reopen in the close’s record
02A close already has its snapshot.A writer attempts to replace or duplicate it.Database protections refuse both attempts.test
services-accounting:modules/fiscal-close/tests/integration/services/persistence/period-close-snapshots.integration.spec.js#refuses a second snapshot of the run

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software