pactole-core 0.2.0

Core domain models, validation and reports for Pactole, a plain-text double-entry accounting ledger.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use crate::models::balance::Amount;
use crate::models::names::{AccountName, Metadata};
use chrono::NaiveDate;

// -------------------------------------------------
// Events
// -------------------------------------------------

/// A balanced financial transaction with one or more postings.
#[derive(Debug, Clone, PartialEq)]
pub struct Transaction {
    /// Posting date.
    pub date: NaiveDate,
    /// Optional effective date, distinct from the posting date.
    pub effective_date: Option<NaiveDate>,

    /// Reconciliation status of the transaction.
    pub status: TransactionStatus,
    /// Optional declared payee.
    pub payee: Option<String>,
    /// Optional human-readable narration.
    pub narration: Option<String>,

    /// Accounts and amounts making up the transaction.
    pub postings: Vec<Posting>,

    /// Tags attached to the transaction.
    pub tags: Vec<String>,
    /// Links attached to the transaction.
    pub links: Vec<String>,
    /// Optional external reference.
    pub reference: Option<String>,
    /// Metadata attached to the transaction.
    pub meta: Metadata,
}

/// One account-side movement within a transaction.
#[derive(Debug, Clone, PartialEq)]
pub struct Posting {
    /// Account affected by the posting.
    pub account: AccountName,
    /// Amount and commodity. `None` may be inferred during validation when
    /// there is exactly one missing posting amount.
    pub amount: Option<Amount>,
    /// Metadata attached to the posting.
    pub meta: Metadata,
}

/// Reconciliation status of a transaction.
#[derive(Debug, Clone, PartialEq)]
pub enum TransactionStatus {
    /// The transaction has not been cleared.
    Uncleared,
    /// The transaction is pending.
    Pending,
    /// The transaction has cleared.
    Cleared,
}