177 lines
6.1 KiB
Rust
177 lines
6.1 KiB
Rust
//! The receipt policy: server-side enforcement, not prose.
|
|
//!
|
|
//! Posting an entry whose debits are strictly greater than the configured
|
|
//! threshold requires at least one attached receipt, unless every line is in
|
|
//! an exempt account. Selected accounts can require receipts regardless of
|
|
//! amount. Reversals are exempt: the original entry carries the evidence.
|
|
|
|
use ledger_core::{JournalEntry, Ledger, Side};
|
|
use rust_decimal::Decimal;
|
|
use serde::Deserialize;
|
|
|
|
/// Server-side receipt policy, loaded from config.
|
|
#[derive(Debug, Clone, Deserialize)]
|
|
pub struct ReceiptPolicy {
|
|
/// Receipts required when an entry's debits are strictly greater than
|
|
/// this amount. Decimal string, e.g. `"25.00"`.
|
|
#[serde(default = "default_threshold")]
|
|
pub require_receipts_above: String,
|
|
/// Account codes that always require a receipt, regardless of amount.
|
|
#[serde(default)]
|
|
pub receipt_required_accounts: Vec<String>,
|
|
/// Account codes exempt from the policy. The exemption applies only when
|
|
/// *every* line of the entry is in an exempt account.
|
|
#[serde(default)]
|
|
pub receipt_exempt_accounts: Vec<String>,
|
|
}
|
|
|
|
fn default_threshold() -> String {
|
|
"25.00".to_string()
|
|
}
|
|
|
|
impl Default for ReceiptPolicy {
|
|
fn default() -> Self {
|
|
Self {
|
|
require_receipts_above: default_threshold(),
|
|
receipt_required_accounts: Vec::new(),
|
|
receipt_exempt_accounts: Vec::new(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ReceiptPolicy {
|
|
fn threshold(&self) -> Decimal {
|
|
self.require_receipts_above
|
|
.parse()
|
|
.unwrap_or(Decimal::from(25))
|
|
}
|
|
|
|
fn account_codes(&self, ledger: &Ledger, entry: &JournalEntry) -> Vec<String> {
|
|
entry
|
|
.lines()
|
|
.iter()
|
|
.map(|l| {
|
|
ledger
|
|
.chart()
|
|
.get(l.account)
|
|
.map(|a| a.code.clone())
|
|
.unwrap_or_default()
|
|
})
|
|
.collect()
|
|
}
|
|
|
|
/// Total debits of the entry (one side of the balanced entry).
|
|
pub fn entry_debits(entry: &JournalEntry) -> Decimal {
|
|
entry
|
|
.lines()
|
|
.iter()
|
|
.filter(|l| l.side == Side::Debit)
|
|
.map(|l| l.amount.amount)
|
|
.sum()
|
|
}
|
|
|
|
/// True when posting this entry requires at least one receipt.
|
|
pub fn receipt_required(&self, ledger: &Ledger, entry: &JournalEntry) -> bool {
|
|
let codes = self.account_codes(ledger, entry);
|
|
let refs: Vec<&str> = codes.iter().map(|s| s.as_str()).collect();
|
|
self.receipt_required_for(&refs, Self::entry_debits(entry))
|
|
}
|
|
|
|
/// True when an entry touching these account codes with this debit total
|
|
/// requires at least one receipt. The code-level check behind
|
|
/// [`Self::receipt_required`], for postings (like disposals) computed
|
|
/// without a draft entry in hand.
|
|
pub fn receipt_required_for(&self, codes: &[&str], debits: Decimal) -> bool {
|
|
// Per-account override: any line in a required account → required.
|
|
if codes
|
|
.iter()
|
|
.any(|c| self.receipt_required_accounts.iter().any(|r| r == *c))
|
|
{
|
|
return true;
|
|
}
|
|
// Strictly greater than the threshold (Stephen: ">$25").
|
|
if debits <= self.threshold() {
|
|
return false;
|
|
}
|
|
// Exempt only when every line is in an exempt account.
|
|
!codes
|
|
.iter()
|
|
.all(|c| self.receipt_exempt_accounts.iter().any(|e| e == *c))
|
|
}
|
|
|
|
/// Human-readable policy summary for previews and errors.
|
|
pub fn describe(&self) -> String {
|
|
format!(
|
|
"receipts required when entry debits are strictly greater than {}",
|
|
self.threshold()
|
|
)
|
|
}
|
|
|
|
/// Normalize a description for split detection.
|
|
fn normalize_description(desc: &str) -> String {
|
|
desc.split_whitespace()
|
|
.collect::<Vec<_>>()
|
|
.join(" ")
|
|
.to_lowercase()
|
|
}
|
|
|
|
/// Debit account ids of an entry, sorted.
|
|
fn debit_accounts(entry: &JournalEntry) -> Vec<u64> {
|
|
let mut ids: Vec<u64> = entry
|
|
.lines()
|
|
.iter()
|
|
.filter(|l| l.side == Side::Debit)
|
|
.map(|l| l.account)
|
|
.collect();
|
|
ids.sort_unstable();
|
|
ids.dedup();
|
|
ids
|
|
}
|
|
|
|
/// Detect a potential threshold split: posted entries on the same date
|
|
/// with the same normalized description and debit accounts, whose
|
|
/// combined debits with this entry exceed the threshold while this
|
|
/// entry alone does not. Returns the matching posted entry ids.
|
|
///
|
|
/// This is the anti-gaming rule: splitting a $100 purchase into four
|
|
/// $25 entries does not dodge the receipt policy. Same-day,
|
|
/// same-description, same-accounts is the signature; recurring spending
|
|
/// spread across days is not flagged.
|
|
pub fn split_group(&self, ledger: &Ledger, entry_id: u64, entry: &JournalEntry) -> Vec<u64> {
|
|
let debits = Self::entry_debits(entry);
|
|
if debits > self.threshold() {
|
|
return Vec::new(); // Normal policy already applies.
|
|
}
|
|
let desc = Self::normalize_description(entry.description());
|
|
let accounts = Self::debit_accounts(entry);
|
|
let date = entry.date();
|
|
let mut group = Vec::new();
|
|
let mut total = debits;
|
|
for other in ledger.posted_entries() {
|
|
if other.id() == entry_id {
|
|
continue;
|
|
}
|
|
if other.date() != date {
|
|
continue;
|
|
}
|
|
if Self::normalize_description(other.description()) != desc {
|
|
continue;
|
|
}
|
|
if Self::debit_accounts(other) != accounts {
|
|
continue;
|
|
}
|
|
// Reversals are exempt from the policy; don't count them.
|
|
if other.reversal_of().is_some() {
|
|
continue;
|
|
}
|
|
group.push(other.id());
|
|
total += Self::entry_debits(other);
|
|
}
|
|
if !group.is_empty() && total > self.threshold() {
|
|
group
|
|
} else {
|
|
Vec::new()
|
|
}
|
|
}
|
|
}
|