Rhythm 2.0 Specifications

Appearance

DOM-ACC-REC-002Outstanding Settlement Item

Markdown

DOM-ACC-REC-002

Outstanding Settlement Item

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Specified by
CON-ACC-REC-002

Design

Owned by
SVC-ACC-REC-reconciliation

KindDomain objectProduct areaAccountingModuleReconciliationRevision3

Read atservices-accounting f47cb263react-console baf6dae3

Outstanding Settlement Item ​

What It Models ​

A settlement item records a single processor money effect that may increase or reduce a later deposit. The same collection supplies matching candidates and the outstanding-money view.

Identity and Attributes ​

Effect keys prevent repeated observation from creating another item. Financial facts remain fixed, arrival dates are calculated when eligibility is established, and outstanding standing is derived for the requested day.

Relationships ​

Reconciliations hold items through claims and create manual items within their drafts. Concerns investigate missing arrivals; readiness uses the effects to explain clearing and period positions.

Invariants ​

The structured invariants distinguish service checks from database constraints. In particular, service logic fills eligibility dates once, while database triggers protect financial identity and external references.

How It Is Stored and Shared ​

Transactions records effects through Reconciliation’s transaction-bound port. Rhythm supplies timing seeds and holiday calendars; Books owns merchant overrides, and these records have no customer-defined fields.

Open Design Questions ​

Product must distinguish timing policy from operational defaults. Dispute references remain unchecked, and write-off has no implemented undo command.

Relationships

ToCardinalityOwnershipCrosses a serviceOn archive or delete
DOM-ACC-REC-003many-to-one active claim (any number of released claims)The explanation owns its holding references and preserves released history.no
DOM-ACC-REC-001many-to-many through the claiming reconciliationThe association is derived through the explanation or candidate read; neither record owns the other.no
DOM-ACC-REC-004one-to-many (at most one open overdue problem at a time)The concern retains its own references to affected records.no
DOM-ACC-REC-005many-to-one per periodAssessment reads the relationship without owning the underlying record.no

Invariants

InvariantProtectsEnforced atProvenance
INV-DOM-ACC-REC-002-01
A deterministic effect key identifies one item; a matching repeat reuses it and a materially different effect is refused.
service, databaseobserved
services-accounting:modules/reconciliation/db/settlement-items.table.ts:settlement_items_source_key_uq
INV-DOM-ACC-REC-002-02
Caller-recorded payment, refund and reversal effects share the document’s commit or rollback.
servicedocumented
services-accounting:docs/reconciliation/architecture.md#6. Reconciliation financial invariants (INV-20)
INV-DOM-ACC-REC-002-03
Effect kind constrains the sign, and an adjustment must be nonzero.
service, databaseobserved
services-accounting:modules/reconciliation/db/settlement-items.table.ts:settlement_items_signed_amount_check
INV-DOM-ACC-REC-002-04
Database triggers protect financial identity and supplied processor references; service commands fill eligibility dates once.
service, databaseobserved
services-accounting:modules/reconciliation/db/settlement-items.table.ts:settlement_items_write_once_trigger; services-accounting:modules/reconciliation/services/persistence/settlement-item-recordings.ts:markItemEligible
INV-DOM-ACC-REC-002-05
An item has one active claim across open and finalized reconciliations.
databasedocumented
services-accounting:docs/milestones/plans/ACCT-M8-plan.md#4. Assumptions (from the design; each becomes a rule in the catalog if not already)
INV-DOM-ACC-REC-002-06
Split commands require same-sign parts; deferred database checks require their total to equal the original.
service, databaseobserved
services-accounting:modules/reconciliation/db/settlement-items.table.ts:settlement_items_split_trigger
INV-DOM-ACC-REC-002-07
A manual effect uses a permitted fee, reserve or adjustment kind and retains text or evidence at commit.
databaseobserved
services-accounting:modules/reconciliation/db/settlement-items.table.ts:settlement_items_manual_evidence_trigger
INV-DOM-ACC-REC-002-08
Outstanding standing is derived for the requested day rather than persisted.
servicedocumented
services-accounting:docs/reconciliation/architecture.md#12.1 Decision: hybrid (persisted facts, derived timing)
INV-DOM-ACC-REC-002-09
Changing timing defaults leaves existing expected dates intact.
servicedocumented
services-accounting:docs/reconciliation/architecture.md#12.2 Expected settlement date

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