bo4e-core 0.2.0

Core types for BO4E (Business Objects for Energy)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! External cost position (Fremdkostenposition) component.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::enums::Unit;
use crate::traits::{Bo4eMeta, Bo4eObject};

use super::{Amount, Price};

/// A cost position for external (third-party) costs.
///
/// German: Fremdkostenposition
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::{ExternalCostPosition, Amount};
///
/// let position = ExternalCostPosition {
///     title: Some("Netzbetreiber ABC".to_string()),
///     amount: Some(Amount::eur(120.0)),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Fremdkostenposition"))]
#[serde(rename_all = "camelCase")]
pub struct ExternalCostPosition {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Title of the position (Positionstitel)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "positionstitel"))]
    pub title: Option<String>,

    /// Total amount for this position (Betrag)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "betrag"))]
    pub amount: Option<Amount>,

    /// Description of the article (Artikelbezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "artikelbezeichnung"))]
    pub article_description: Option<String>,

    /// Price per unit (Einzelpreis)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "einzelpreis"))]
    pub unit_price: Option<Price>,

    /// Start date inclusive (Von)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "von"))]
    pub start_date: Option<DateTime<Utc>>,

    /// End date exclusive (Bis)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "bis"))]
    pub end_date: Option<DateTime<Utc>>,

    /// Quantity value (Menge - Wert)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "mengeWert"))]
    pub quantity_value: Option<f64>,

    /// Quantity unit (Menge - Einheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "mengeEinheit"))]
    pub quantity_unit: Option<Unit>,

    /// External ID/reference (Link)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "link"))]
    pub external_reference: Option<String>,
}

impl Bo4eObject for ExternalCostPosition {
    fn type_name_german() -> &'static str {
        "Fremdkostenposition"
    }

    fn type_name_english() -> &'static str {
        "ExternalCostPosition"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

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

    #[test]
    fn test_external_cost_position() {
        let position = ExternalCostPosition {
            title: Some("Netzbetreiber ABC".to_string()),
            article_description: Some("Netznutzungsentgelt".to_string()),
            amount: Some(Amount::eur(120.0)),
            quantity_value: Some(1500.0),
            quantity_unit: Some(Unit::KilowattHour),
            ..Default::default()
        };

        assert_eq!(position.title, Some("Netzbetreiber ABC".to_string()));
        assert_eq!(position.quantity_value, Some(1500.0));
    }

    #[test]
    fn test_default() {
        let position = ExternalCostPosition::default();
        assert!(position.title.is_none());
        assert!(position.amount.is_none());
    }

    #[test]
    fn test_roundtrip() {
        let position = ExternalCostPosition {
            title: Some("Messstellenbetreiber".to_string()),
            amount: Some(Amount::eur(80.0)),
            external_reference: Some("MSB-2024-001".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&position).unwrap();
        let parsed: ExternalCostPosition = serde_json::from_str(&json).unwrap();
        assert_eq!(position, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(
            ExternalCostPosition::type_name_german(),
            "Fremdkostenposition"
        );
        assert_eq!(
            ExternalCostPosition::type_name_english(),
            "ExternalCostPosition"
        );
    }
}