bo4e_core/bo/
price_sheet.rs

1//! Price sheet (Preisblatt) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{PricePosition, TimePeriod};
7use crate::enums::Division;
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A generic price sheet containing price positions.
11///
12/// German: Preisblatt
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::PriceSheet;
18/// use bo4e_core::enums::Division;
19///
20/// let price_sheet = PriceSheet {
21///     designation: Some("Standardpreisblatt 2024".to_string()),
22///     division: Some(Division::Electricity),
23///     ..Default::default()
24/// };
25/// ```
26#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
27#[serde(rename_all = "camelCase")]
28pub struct PriceSheet {
29    /// BO4E metadata
30    #[serde(flatten)]
31    pub meta: Bo4eMeta,
32
33    /// Name/designation of the price sheet (Bezeichnung)
34    #[serde(skip_serializing_if = "Option::is_none")]
35    pub designation: Option<String>,
36
37    /// Description (Beschreibung)
38    #[serde(skip_serializing_if = "Option::is_none")]
39    pub description: Option<String>,
40
41    /// Energy division (Sparte)
42    #[serde(skip_serializing_if = "Option::is_none")]
43    pub division: Option<Division>,
44
45    /// Price number/identifier (Preisnummer)
46    #[serde(skip_serializing_if = "Option::is_none")]
47    pub price_number: Option<String>,
48
49    /// Validity period (Gueltigkeitszeitraum)
50    #[serde(skip_serializing_if = "Option::is_none")]
51    pub validity_period: Option<TimePeriod>,
52
53    /// Valid from date (Gueltig ab)
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub valid_from: Option<DateTime<Utc>>,
56
57    /// Valid until date (Gueltig bis)
58    #[serde(skip_serializing_if = "Option::is_none")]
59    pub valid_until: Option<DateTime<Utc>>,
60
61    /// Price positions (Preispositionen)
62    #[serde(default, skip_serializing_if = "Vec::is_empty")]
63    pub positions: Vec<PricePosition>,
64
65    /// Publisher of the price sheet
66    #[serde(skip_serializing_if = "Option::is_none")]
67    pub publisher: Option<Box<super::BusinessPartner>>,
68}
69
70impl Bo4eObject for PriceSheet {
71    fn type_name_german() -> &'static str {
72        "Preisblatt"
73    }
74
75    fn type_name_english() -> &'static str {
76        "PriceSheet"
77    }
78
79    fn meta(&self) -> &Bo4eMeta {
80        &self.meta
81    }
82
83    fn meta_mut(&mut self) -> &mut Bo4eMeta {
84        &mut self.meta
85    }
86}
87
88#[cfg(test)]
89mod tests {
90    use super::*;
91
92    #[test]
93    fn test_price_sheet_creation() {
94        let price_sheet = PriceSheet {
95            designation: Some("Standardpreisblatt 2024".to_string()),
96            division: Some(Division::Electricity),
97            price_number: Some("PB-2024-001".to_string()),
98            ..Default::default()
99        };
100
101        assert_eq!(
102            price_sheet.designation,
103            Some("Standardpreisblatt 2024".to_string())
104        );
105        assert_eq!(price_sheet.division, Some(Division::Electricity));
106    }
107
108    #[test]
109    fn test_serialize() {
110        let price_sheet = PriceSheet {
111            meta: Bo4eMeta::with_type("Preisblatt"),
112            designation: Some("Test Price Sheet".to_string()),
113            ..Default::default()
114        };
115
116        let json = serde_json::to_string(&price_sheet).unwrap();
117        assert!(json.contains(r#""designation":"Test Price Sheet""#));
118        assert!(json.contains(r#""_typ":"Preisblatt""#));
119    }
120
121    #[test]
122    fn test_roundtrip() {
123        let price_sheet = PriceSheet {
124            meta: Bo4eMeta::with_type("Preisblatt"),
125            designation: Some("Network Fee Sheet".to_string()),
126            description: Some("Standard network fees".to_string()),
127            division: Some(Division::Electricity),
128            price_number: Some("NF-2024".to_string()),
129            ..Default::default()
130        };
131
132        let json = serde_json::to_string(&price_sheet).unwrap();
133        let parsed: PriceSheet = serde_json::from_str(&json).unwrap();
134        assert_eq!(price_sheet, parsed);
135    }
136
137    #[test]
138    fn test_bo4e_object_impl() {
139        assert_eq!(PriceSheet::type_name_german(), "Preisblatt");
140        assert_eq!(PriceSheet::type_name_english(), "PriceSheet");
141    }
142}