core-invoice 2.0.1

EN 16931 + Peppol PINT semantic model (VAT, GST, SST, consumption tax)
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

use std::fmt;

/// Business term id `BT-151`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct BtId(pub u16);

impl fmt::Display for BtId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "BT-{}", self.0)
    }
}

/// Repeating or distinguishable groups. Index in [`Path`] is **0-based**;
/// `BG-25[2]/BT-151` is the third line.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[non_exhaustive]
pub enum Group {
    Document,
    Seller,
    Buyer,
    Payee,
    TaxRepresentative,
    Delivery,
    Payment,
    DocumentAllowance,
    DocumentCharge,
    Totals,
    /// Tax breakdown (BG-23 / IBG-23), not VAT-only.
    TaxBreakdown,
    Attachment,
    Line,
}

impl Group {
    pub fn bg_id(self) -> Option<u16> {
        Some(match self {
            Self::Document => return None,
            Self::Seller => 4,
            Self::Buyer => 7,
            Self::Payee => 10,
            Self::TaxRepresentative => 11,
            Self::Delivery => 13,
            Self::Payment => 16,
            Self::DocumentAllowance => 20,
            Self::DocumentCharge => 21,
            Self::Totals => 22,
            Self::TaxBreakdown => 23,
            Self::Attachment => 24,
            Self::Line => 25,
        })
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Path {
    pub group: Group,
    pub index: Option<usize>,
    pub term: Option<BtId>,
}

impl Path {
    pub fn term(term: BtId) -> Self {
        Self {
            group: Group::Document,
            index: None,
            term: Some(term),
        }
    }

    pub fn at_term(group: Group, index: usize, term: BtId) -> Self {
        Self {
            group,
            index: Some(index),
            term: Some(term),
        }
    }

    pub fn group(group: Group) -> Self {
        Self {
            group,
            index: None,
            term: None,
        }
    }

    pub fn group_term(group: Group, term: BtId) -> Self {
        Self {
            group,
            index: None,
            term: Some(term),
        }
    }
}

impl fmt::Display for Path {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match (self.group.bg_id(), self.index, self.term) {
            (None, _, Some(t)) => write!(f, "{t}"),
            (None, _, None) => write!(f, "Invoice"),
            (Some(bg), None, None) => write!(f, "BG-{bg}"),
            (Some(bg), Some(i), None) => write!(f, "BG-{bg}[{i}]"),
            (Some(bg), None, Some(t)) => write!(f, "BG-{bg}/{t}"),
            (Some(bg), Some(i), Some(t)) => write!(f, "BG-{bg}[{i}]/{t}"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn display_shapes() {
        assert_eq!(Path::term(BtId(1)).to_string(), "BT-1");
        assert_eq!(Path::group(Group::Totals).to_string(), "BG-22");
        assert_eq!(
            Path {
                group: Group::Totals,
                index: None,
                term: Some(BtId(109))
            }
            .to_string(),
            "BG-22/BT-109"
        );
        assert_eq!(Path::group(Group::Line).to_string(), "BG-25");
        assert_eq!(
            Path::at_term(Group::Line, 2, BtId(151)).to_string(),
            "BG-25[2]/BT-151"
        );
    }
}