Struct RunningBalanceTracker 

pub struct RunningBalanceTracker { /* private fields */ }

Tracks running balances for all accounts across companies.

Implementations

impl RunningBalanceTracker

pub fn new_with_currency_and_framework( config: BalanceTrackerConfig, currency: String, framework: &str, ) -> Self

Creates a new balance tracker with the specified currency and accounting framework.

pub fn new_with_currency(config: BalanceTrackerConfig, currency: String) -> Self

Creates a new balance tracker with the specified currency (defaults to US GAAP).

pub fn new(config: BalanceTrackerConfig) -> Self

Creates a new balance tracker (defaults to USD and US GAAP).

pub fn new_with_framework(config: BalanceTrackerConfig, framework: &str) -> Self

Creates a new balance tracker for a specific accounting framework (defaults to USD).

pub fn with_defaults() -> Self

Creates a tracker with default configuration (US GAAP).

pub fn register_account_type( &mut self, account_code: &str, account_type: AccountType, )

Registers an account type for balance tracking.

pub fn register_account_types(&mut self, types: &[(String, AccountType)])

Registers multiple account types.

pub fn register_from_chart_prefixes(&mut self, prefixes: &[(&str, AccountType)])

Registers account types from a chart of accounts prefix pattern.

pub fn initialize_from_snapshot(&mut self, snapshot: &BalanceSnapshot)

Initializes balances from opening balance snapshot.

pub fn apply_entry( &mut self, entry: &JournalEntry, ) -> Result<(), ValidationError>

Applies a journal entry to the running balances.

pub fn apply_entries( &mut self, entries: &[JournalEntry], ) -> Vec<ValidationError>

Applies a batch of entries.

pub fn validate_balance_sheet( &mut self, company_code: &str, date: NaiveDate, entry_id: Option<&str>, ) -> Result<(), ValidationError>

Validates the balance sheet equation for a company.

pub fn get_snapshot( &self, company_code: &str, as_of_date: NaiveDate, ) -> Option<BalanceSnapshot>

Gets the current snapshot for a company.

pub fn get_all_snapshots(&self, as_of_date: NaiveDate) -> Vec<BalanceSnapshot>

Gets snapshots for all companies.

pub fn get_balance_changes( &self, company_code: &str, from_date: NaiveDate, to_date: NaiveDate, ) -> Vec<AccountPeriodActivity>

Gets balance changes for a period.

pub fn get_account_balance( &self, company_code: &str, account_code: &str, ) -> Option<&AccountBalance>

Gets balance for a specific account.

pub fn with_tb_anchor(self, anchor: TbAnchorPrior) -> Self

SP4.1 — Attach a TB anchor prior to this tracker. When set, enables account_drift() and drift_correction_needed(). Does not change the existing balance-tracking behaviour — purely additive.

pub fn set_tb_anchor(&mut self, anchor: TbAnchorPrior)

SP4.1 — Set the TB anchor prior on this tracker (mutable version).

pub fn account_drift(&self, company_code: &str) -> Vec<(String, f64)>

SP4.1 — Returns the per-account drift (current closing balance − target closing balance) for every account that appears in the TB anchor prior.

Positive drift means the synthetic account balance is higher than the target; negative means it is lower.

Returns an empty Vec when no TB anchor is loaded or no company has been tracked yet.

pub fn drift_correction_needed(&self, company_code: &str) -> bool

SP4.1 / SP5.1 — Returns true when the TB anchor is loaded and any single account’s absolute drift exceeds 2 × closing_stdev (or a fallback of 2% of |closing_balance| when stdev is zero), OR the aggregate absolute drift across all tracked accounts exceeds 0.5% of total_assets.

Thresholds were tuned to 2σ / 0.5% in SP5.1 (previously 3σ / 1%) so that the drift-correction pass fires on realistic synthetic runs where balances are shaped by priors but not pinned to the corpus median.

Returns false when no TB anchor is loaded (backwards-compatible behaviour — caller does not emit drift-correction entries).

pub fn build_drift_correction_je<R: RngExt>( &self, company_code: &str, posting_date: NaiveDate, rng: &mut R, ) -> Option<JournalEntry>

SP4.1 W8.1 — Build a balanced drift-correction JE that nudges the most-drifted accounts back toward their TB anchor targets.

The emitted JE:

• Has document_type = "SA" and source = Adjustment (period-end style).
• Includes at most 8 account lines (the worst drifters), plus one balancing line posted to suspense account “9999” when the selected lines don’t net to zero.
• Always satisfies total_debit == total_credit (mandatory for apply_entry).

Returns None when no TB anchor is loaded, when no drifts exceed the noise floor, or when the resulting JE would have fewer than 2 lines.

SP5.1: The net / balancing amount is now computed in Decimal (not f64) so that f64→Decimal precision loss cannot produce an “unbalanced” JE.

pub fn get_validation_errors(&self) -> &[ValidationError]

Gets all validation errors.

pub fn clear_validation_errors(&mut self)

Clears validation errors.

pub fn get_statistics(&self) -> &TrackerStatistics

Gets tracker statistics.

pub fn roll_forward(&mut self, _new_period_start: NaiveDate)

Rolls forward balances to a new period.

pub fn export_balances(&self, company_code: &str) -> Vec<(String, Decimal)>

Exports balances to a simple format.