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#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
28#[cfg_attr(feature = "json-schema", schemars(rename = "Preisblatt"))]
29#[serde(rename_all = "camelCase")]
30pub struct PriceSheet {
31    /// BO4E metadata
32    #[serde(flatten)]
33    pub meta: Bo4eMeta,
34
35    /// Name/designation of the price sheet (Bezeichnung)
36    #[serde(skip_serializing_if = "Option::is_none")]
37    #[cfg_attr(feature = "json-schema", schemars(rename = "bezeichnung"))]
38    pub designation: Option<String>,
39
40    /// Description (Beschreibung)
41    #[serde(skip_serializing_if = "Option::is_none")]
42    #[cfg_attr(feature = "json-schema", schemars(rename = "beschreibung"))]
43    pub description: Option<String>,
44
45    /// Energy division (Sparte)
46    #[serde(skip_serializing_if = "Option::is_none")]
47    #[cfg_attr(feature = "json-schema", schemars(rename = "sparte"))]
48    pub division: Option<Division>,
49
50    /// Price number/identifier (Preisnummer)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    #[cfg_attr(feature = "json-schema", schemars(rename = "preisnummer"))]
53    pub price_number: Option<String>,
54
55    /// Validity period (Gueltigkeitszeitraum)
56    #[serde(skip_serializing_if = "Option::is_none")]
57    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigkeitszeitraum"))]
58    pub validity_period: Option<TimePeriod>,
59
60    /// Valid from date (Gueltig ab)
61    #[serde(skip_serializing_if = "Option::is_none")]
62    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigAb"))]
63    pub valid_from: Option<DateTime<Utc>>,
64
65    /// Valid until date (Gueltig bis)
66    #[serde(skip_serializing_if = "Option::is_none")]
67    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigBis"))]
68    pub valid_until: Option<DateTime<Utc>>,
69
70    /// Price positions (Preispositionen)
71    #[serde(default, skip_serializing_if = "Vec::is_empty")]
72    #[cfg_attr(feature = "json-schema", schemars(rename = "preispositionen"))]
73    pub positions: Vec<PricePosition>,
74
75    /// Publisher of the price sheet
76    #[serde(skip_serializing_if = "Option::is_none")]
77    #[cfg_attr(feature = "json-schema", schemars(rename = "herausgeber"))]
78    pub publisher: Option<Box<super::BusinessPartner>>,
79}
80
81impl Bo4eObject for PriceSheet {
82    fn type_name_german() -> &'static str {
83        "Preisblatt"
84    }
85
86    fn type_name_english() -> &'static str {
87        "PriceSheet"
88    }
89
90    fn meta(&self) -> &Bo4eMeta {
91        &self.meta
92    }
93
94    fn meta_mut(&mut self) -> &mut Bo4eMeta {
95        &mut self.meta
96    }
97}
98
99#[cfg(test)]
100mod tests {
101    use super::*;
102
103    #[test]
104    fn test_price_sheet_creation() {
105        let price_sheet = PriceSheet {
106            designation: Some("Standardpreisblatt 2024".to_string()),
107            division: Some(Division::Electricity),
108            price_number: Some("PB-2024-001".to_string()),
109            ..Default::default()
110        };
111
112        assert_eq!(
113            price_sheet.designation,
114            Some("Standardpreisblatt 2024".to_string())
115        );
116        assert_eq!(price_sheet.division, Some(Division::Electricity));
117    }
118
119    #[test]
120    fn test_serialize() {
121        let price_sheet = PriceSheet {
122            meta: Bo4eMeta::with_type("Preisblatt"),
123            designation: Some("Test Price Sheet".to_string()),
124            ..Default::default()
125        };
126
127        let json = serde_json::to_string(&price_sheet).unwrap();
128        assert!(json.contains(r#""designation":"Test Price Sheet""#));
129        assert!(json.contains(r#""_typ":"Preisblatt""#));
130    }
131
132    #[test]
133    fn test_roundtrip() {
134        let price_sheet = PriceSheet {
135            meta: Bo4eMeta::with_type("Preisblatt"),
136            designation: Some("Network Fee Sheet".to_string()),
137            description: Some("Standard network fees".to_string()),
138            division: Some(Division::Electricity),
139            price_number: Some("NF-2024".to_string()),
140            ..Default::default()
141        };
142
143        let json = serde_json::to_string(&price_sheet).unwrap();
144        let parsed: PriceSheet = serde_json::from_str(&json).unwrap();
145        assert_eq!(price_sheet, parsed);
146    }
147
148    #[test]
149    fn test_bo4e_object_impl() {
150        assert_eq!(PriceSheet::type_name_german(), "Preisblatt");
151        assert_eq!(PriceSheet::type_name_english(), "PriceSheet");
152    }
153}
bo4e_core/bo/price_sheet.rs

bo4e_core/bo/
price_sheet.rs
