datasynth-generators 2.2.0

50+ data generators covering GL, P2P, O2C, S2C, HR, manufacturing, audit, tax, treasury, and ESG
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
//! Inventory generator.

use chrono::NaiveDate;
use datasynth_core::utils::seeded_rng;
use rand::Rng;
use rand_chacha::ChaCha8Rng;
use rust_decimal::Decimal;
use rust_decimal_macros::dec;

use tracing::debug;

use datasynth_core::models::subledger::inventory::{
    InventoryMovement, InventoryPosition, MovementType, PositionValuation, ReferenceDocType,
    ValuationMethod,
};
use datasynth_core::models::{JournalEntry, JournalEntryLine};

/// Configuration for inventory generation.
///
/// ## Moving-average valuation note
///
/// When `default_valuation_method` is [`ValuationMethod::MovingAverage`], the
/// generator updates the weighted-average unit cost after each goods receipt via
/// `InventoryPosition::add_quantity`. The moving-average formula is:
///
/// ```text
/// new_avg_cost = (existing_qty × existing_cost + receipt_qty × receipt_cost)
///                / (existing_qty + receipt_qty)
/// ```
///
/// `generate_goods_receipt` now accepts `&mut InventoryPosition` so it can update
/// the position in-place, ensuring `valuation.unit_cost` reflects the true
/// moving-average after each receipt.
#[derive(Debug, Clone)]
pub struct InventoryGeneratorConfig {
    /// Default valuation method.
    pub default_valuation_method: ValuationMethod,
    /// Average unit cost.
    pub avg_unit_cost: Decimal,
    /// Unit cost variation.
    pub cost_variation: Decimal,
    /// Average movement quantity.
    pub avg_movement_quantity: Decimal,
    /// Quantity variation.
    pub quantity_variation: Decimal,
}

impl Default for InventoryGeneratorConfig {
    fn default() -> Self {
        Self {
            default_valuation_method: ValuationMethod::MovingAverage,
            avg_unit_cost: dec!(100),
            cost_variation: dec!(0.5),
            avg_movement_quantity: dec!(50),
            quantity_variation: dec!(0.8),
        }
    }
}

/// Generator for inventory transactions.
pub struct InventoryGenerator {
    config: InventoryGeneratorConfig,
    rng: ChaCha8Rng,
    movement_counter: u64,
    /// Currency code for generated movements and journal entries.
    currency: String,
}

impl InventoryGenerator {
    /// Creates a new inventory generator with the specified currency.
    pub fn new_with_currency(
        config: InventoryGeneratorConfig,
        rng: ChaCha8Rng,
        currency: String,
    ) -> Self {
        Self {
            config,
            rng,
            movement_counter: 0,
            currency,
        }
    }

    /// Creates a new inventory generator (defaults to USD).
    pub fn new(config: InventoryGeneratorConfig, rng: ChaCha8Rng) -> Self {
        Self::new_with_currency(config, rng, "USD".to_string())
    }

    /// Creates a new inventory generator from a seed, constructing the RNG internally.
    pub fn with_seed(config: InventoryGeneratorConfig, seed: u64) -> Self {
        Self::new(config, seeded_rng(seed, 0))
    }

    /// Generates an initial inventory position.
    pub fn generate_position(
        &mut self,
        company_code: &str,
        plant: &str,
        storage_location: &str,
        material_id: &str,
        description: &str,
        initial_quantity: Decimal,
        unit_cost: Option<Decimal>,
        _currency: &str,
    ) -> InventoryPosition {
        debug!(company_code, plant, material_id, %initial_quantity, "Generating inventory position");
        let cost = unit_cost.unwrap_or_else(|| self.generate_unit_cost());
        let total_value = (initial_quantity * cost).round_dp(2);

        let mut position = InventoryPosition::new(
            material_id.to_string(),
            description.to_string(),
            plant.to_string(),
            storage_location.to_string(),
            company_code.to_string(),
            "EA".to_string(),
        );

        position.quantity_on_hand = initial_quantity;
        position.quantity_available = initial_quantity;
        position.valuation = PositionValuation {
            method: self.config.default_valuation_method,
            standard_cost: cost,
            unit_cost: cost,
            total_value,
            price_variance: Decimal::ZERO,
            last_price_change: None,
        };
        position.min_stock = Some(dec!(10));
        position.max_stock = Some(dec!(1000));
        position.reorder_point = Some(dec!(50));

        position
    }

    /// Generates a goods receipt (inventory increase).
    pub fn generate_goods_receipt(
        &mut self,
        position: &mut InventoryPosition,
        receipt_date: NaiveDate,
        quantity: Decimal,
        unit_cost: Decimal,
        po_number: Option<&str>,
    ) -> (InventoryMovement, JournalEntry) {
        self.movement_counter += 1;
        let document_number = format!("INVMV{:08}", self.movement_counter);
        let batch_number = format!("BATCH{:06}", self.rng.random::<u32>() % 1000000);

        let mut movement = InventoryMovement::new(
            document_number,
            1, // item_number
            position.company_code.clone(),
            receipt_date,
            MovementType::GoodsReceipt,
            position.material_id.clone(),
            position.description.clone(),
            position.plant.clone(),
            position.storage_location.clone(),
            quantity,
            position.unit.clone(),
            unit_cost,
            self.currency.clone(),
            "SYSTEM".to_string(),
        );

        movement.batch_number = Some(batch_number);
        if let Some(po) = po_number {
            movement.reference_doc_type = Some(ReferenceDocType::PurchaseOrder);
            movement.reference_doc_number = Some(po.to_string());
        }
        movement.reason_code = Some("Goods Receipt from PO".to_string());

        // Update the position's moving-average unit cost and quantity.
        // For MovingAverage valuation this recalculates:
        //   new_avg_cost = (old_qty × old_cost + receipt_qty × receipt_cost)
        //                  / (old_qty + receipt_qty)
        position.add_quantity(quantity, unit_cost, receipt_date);

        let je = self.generate_goods_receipt_je(&movement);
        (movement, je)
    }

    /// Generates a goods issue (inventory decrease).
    pub fn generate_goods_issue(
        &mut self,
        position: &InventoryPosition,
        issue_date: NaiveDate,
        quantity: Decimal,
        cost_center: Option<&str>,
        production_order: Option<&str>,
    ) -> (InventoryMovement, JournalEntry) {
        self.movement_counter += 1;
        let document_number = format!("INVMV{:08}", self.movement_counter);

        let unit_cost = position.valuation.unit_cost;

        let mut movement = InventoryMovement::new(
            document_number,
            1, // item_number
            position.company_code.clone(),
            issue_date,
            MovementType::GoodsIssue,
            position.material_id.clone(),
            position.description.clone(),
            position.plant.clone(),
            position.storage_location.clone(),
            quantity,
            position.unit.clone(),
            unit_cost,
            self.currency.clone(),
            "SYSTEM".to_string(),
        );

        movement.cost_center = cost_center.map(std::string::ToString::to_string);
        if let Some(po) = production_order {
            movement.reference_doc_type = Some(ReferenceDocType::ProductionOrder);
            movement.reference_doc_number = Some(po.to_string());
        }
        movement.reason_code = Some("Goods Issue to Production".to_string());

        let je = self.generate_goods_issue_je(&movement);
        (movement, je)
    }

    /// Generates a stock transfer between locations.
    pub fn generate_transfer(
        &mut self,
        position: &InventoryPosition,
        transfer_date: NaiveDate,
        quantity: Decimal,
        to_plant: &str,
        to_storage_location: &str,
    ) -> (InventoryMovement, InventoryMovement, JournalEntry) {
        // Issue from source
        self.movement_counter += 1;
        let issue_id = format!("INVMV{:08}", self.movement_counter);

        // Receipt at destination
        self.movement_counter += 1;
        let receipt_id = format!("INVMV{:08}", self.movement_counter);

        let unit_cost = position.valuation.unit_cost;

        let mut issue = InventoryMovement::new(
            issue_id,
            1, // item_number
            position.company_code.clone(),
            transfer_date,
            MovementType::TransferOut,
            position.material_id.clone(),
            position.description.clone(),
            position.plant.clone(),
            position.storage_location.clone(),
            quantity,
            position.unit.clone(),
            unit_cost,
            self.currency.clone(),
            "SYSTEM".to_string(),
        );
        issue.reference_doc_type = Some(ReferenceDocType::MaterialDocument);
        issue.reference_doc_number = Some(receipt_id.clone());
        issue.reason_code = Some(format!("Transfer to {to_plant}/{to_storage_location}"));

        let mut receipt = InventoryMovement::new(
            receipt_id,
            1, // item_number
            position.company_code.clone(),
            transfer_date,
            MovementType::TransferIn,
            position.material_id.clone(),
            position.description.clone(),
            to_plant.to_string(),
            to_storage_location.to_string(),
            quantity,
            position.unit.clone(),
            unit_cost,
            self.currency.clone(),
            "SYSTEM".to_string(),
        );
        receipt.reference_doc_type = Some(ReferenceDocType::MaterialDocument);
        receipt.reference_doc_number = Some(issue.document_number.clone());
        receipt.reason_code = Some(format!(
            "Transfer from {}/{}",
            position.plant, position.storage_location
        ));

        // For intra-company transfer, no GL impact unless different plants have different valuations
        let je = self.generate_transfer_je(&issue, &receipt);

        (issue, receipt, je)
    }

    /// Generates an inventory adjustment.
    pub fn generate_adjustment(
        &mut self,
        position: &InventoryPosition,
        adjustment_date: NaiveDate,
        quantity_change: Decimal,
        reason: &str,
    ) -> (InventoryMovement, JournalEntry) {
        self.movement_counter += 1;
        let document_number = format!("INVMV{:08}", self.movement_counter);

        let movement_type = if quantity_change > Decimal::ZERO {
            MovementType::InventoryAdjustmentIn
        } else {
            MovementType::InventoryAdjustmentOut
        };

        let unit_cost = position.valuation.unit_cost;

        let mut movement = InventoryMovement::new(
            document_number,
            1, // item_number
            position.company_code.clone(),
            adjustment_date,
            movement_type,
            position.material_id.clone(),
            position.description.clone(),
            position.plant.clone(),
            position.storage_location.clone(),
            quantity_change.abs(),
            position.unit.clone(),
            unit_cost,
            self.currency.clone(),
            "SYSTEM".to_string(),
        );
        movement.reference_doc_type = Some(ReferenceDocType::PhysicalInventoryDoc);
        movement.reference_doc_number = Some(format!("PI{:08}", self.movement_counter));
        movement.reason_code = Some(reason.to_string());

        let je = self.generate_adjustment_je(&movement, quantity_change > Decimal::ZERO);
        (movement, je)
    }

    fn generate_unit_cost(&mut self) -> Decimal {
        let base = self.config.avg_unit_cost;
        let variation = base * self.config.cost_variation;
        let random: f64 = self.rng.random_range(-1.0..1.0);
        (base + variation * Decimal::try_from(random).unwrap_or_default())
            .max(dec!(1))
            .round_dp(2)
    }

    fn generate_goods_receipt_je(&self, movement: &InventoryMovement) -> JournalEntry {
        let mut je = JournalEntry::new_simple(
            format!("JE-{}", movement.document_number),
            movement.company_code.clone(),
            movement.posting_date,
            format!("Goods Receipt {}", movement.material_id),
        );

        // Debit Inventory
        je.add_line(JournalEntryLine {
            line_number: 1,
            gl_account: "1300".to_string(),
            debit_amount: movement.value,
            cost_center: movement.cost_center.clone(),
            profit_center: None,
            reference: Some(movement.document_number.clone()),
            assignment: Some(movement.material_id.clone()),
            text: Some(movement.description.clone()),
            quantity: Some(movement.quantity),
            unit: Some(movement.unit.clone()),
            ..Default::default()
        });

        // Credit GR/IR Clearing
        je.add_line(JournalEntryLine {
            line_number: 2,
            gl_account: "2100".to_string(),
            credit_amount: movement.value,
            reference: movement.reference_doc_number.clone(),
            ..Default::default()
        });

        je
    }

    fn generate_goods_issue_je(&self, movement: &InventoryMovement) -> JournalEntry {
        let mut je = JournalEntry::new_simple(
            format!("JE-{}", movement.document_number),
            movement.company_code.clone(),
            movement.posting_date,
            format!("Goods Issue {}", movement.material_id),
        );

        // Debit Cost of Goods Sold or WIP
        let debit_account =
            if movement.reference_doc_type == Some(ReferenceDocType::ProductionOrder) {
                "1350".to_string() // WIP
            } else {
                "5100".to_string() // COGS
            };

        je.add_line(JournalEntryLine {
            line_number: 1,
            gl_account: debit_account,
            debit_amount: movement.value,
            cost_center: movement.cost_center.clone(),
            profit_center: None,
            reference: Some(movement.document_number.clone()),
            assignment: Some(movement.material_id.clone()),
            text: Some(movement.description.clone()),
            quantity: Some(movement.quantity),
            unit: Some(movement.unit.clone()),
            ..Default::default()
        });

        // Credit Inventory
        je.add_line(JournalEntryLine {
            line_number: 2,
            gl_account: "1300".to_string(),
            credit_amount: movement.value,
            reference: Some(movement.document_number.clone()),
            assignment: Some(movement.material_id.clone()),
            quantity: Some(movement.quantity),
            unit: Some(movement.unit.clone()),
            ..Default::default()
        });

        je
    }

    fn generate_transfer_je(
        &self,
        issue: &InventoryMovement,
        _receipt: &InventoryMovement,
    ) -> JournalEntry {
        // For intra-company transfer with same valuation, this might be a memo entry
        // or could involve plant-specific inventory accounts
        let mut je = JournalEntry::new_simple(
            format!("JE-XFER-{}", issue.document_number),
            issue.company_code.clone(),
            issue.posting_date,
            format!("Stock Transfer {}", issue.material_id),
        );

        // Debit Inventory at destination (using same account for simplicity)
        je.add_line(JournalEntryLine {
            line_number: 1,
            gl_account: "1300".to_string(),
            debit_amount: issue.value,
            reference: Some(issue.document_number.clone()),
            assignment: Some(issue.material_id.clone()),
            quantity: Some(issue.quantity),
            unit: Some(issue.unit.clone()),
            ..Default::default()
        });

        // Credit Inventory at source
        je.add_line(JournalEntryLine {
            line_number: 2,
            gl_account: "1300".to_string(),
            credit_amount: issue.value,
            reference: Some(issue.document_number.clone()),
            assignment: Some(issue.material_id.clone()),
            quantity: Some(issue.quantity),
            unit: Some(issue.unit.clone()),
            ..Default::default()
        });

        je
    }

    fn generate_adjustment_je(
        &self,
        movement: &InventoryMovement,
        is_increase: bool,
    ) -> JournalEntry {
        let mut je = JournalEntry::new_simple(
            format!("JE-{}", movement.document_number),
            movement.company_code.clone(),
            movement.posting_date,
            format!("Inventory Adjustment {}", movement.material_id),
        );

        if is_increase {
            // Debit Inventory
            je.add_line(JournalEntryLine {
                line_number: 1,
                gl_account: "1300".to_string(),
                debit_amount: movement.value,
                reference: Some(movement.document_number.clone()),
                assignment: Some(movement.material_id.clone()),
                text: Some(movement.reason_code.clone().unwrap_or_default()),
                quantity: Some(movement.quantity),
                unit: Some(movement.unit.clone()),
                ..Default::default()
            });

            // Credit Inventory Adjustment Account
            je.add_line(JournalEntryLine {
                line_number: 2,
                gl_account: "4950".to_string(),
                credit_amount: movement.value,
                cost_center: movement.cost_center.clone(),
                reference: Some(movement.document_number.clone()),
                ..Default::default()
            });
        } else {
            // Debit Inventory Adjustment Account (expense)
            je.add_line(JournalEntryLine {
                line_number: 1,
                gl_account: "6950".to_string(),
                debit_amount: movement.value,
                cost_center: movement.cost_center.clone(),
                reference: Some(movement.document_number.clone()),
                text: Some(movement.reason_code.clone().unwrap_or_default()),
                ..Default::default()
            });

            // Credit Inventory
            je.add_line(JournalEntryLine {
                line_number: 2,
                gl_account: "1300".to_string(),
                credit_amount: movement.value,
                reference: Some(movement.document_number.clone()),
                assignment: Some(movement.material_id.clone()),
                quantity: Some(movement.quantity),
                unit: Some(movement.unit.clone()),
                ..Default::default()
            });
        }

        je
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;
    use rand::SeedableRng;

    #[test]
    fn test_generate_position() {
        let rng = ChaCha8Rng::seed_from_u64(12345);
        let mut generator = InventoryGenerator::new(InventoryGeneratorConfig::default(), rng);

        let position = generator.generate_position(
            "1000",
            "PLANT01",
            "WH01",
            "MAT001",
            "Raw Material A",
            dec!(100),
            None,
            "USD",
        );

        assert_eq!(position.quantity_on_hand, dec!(100));
        assert!(position.valuation.unit_cost > Decimal::ZERO);
    }

    #[test]
    fn test_generate_goods_receipt() {
        let rng = ChaCha8Rng::seed_from_u64(12345);
        let mut generator = InventoryGenerator::new(InventoryGeneratorConfig::default(), rng);

        let mut position = generator.generate_position(
            "1000",
            "PLANT01",
            "WH01",
            "MAT001",
            "Raw Material A",
            dec!(100),
            Some(dec!(50)),
            "USD",
        );

        let (movement, je) = generator.generate_goods_receipt(
            &mut position,
            NaiveDate::from_ymd_opt(2024, 1, 15).unwrap(),
            dec!(50),
            dec!(50),
            Some("PO001"),
        );

        assert_eq!(movement.movement_type, MovementType::GoodsReceipt);
        assert_eq!(movement.quantity, dec!(50));
        assert!(je.is_balanced());
    }

    #[test]
    fn test_generate_goods_issue() {
        let rng = ChaCha8Rng::seed_from_u64(12345);
        let mut generator = InventoryGenerator::new(InventoryGeneratorConfig::default(), rng);

        let position = generator.generate_position(
            "1000",
            "PLANT01",
            "WH01",
            "MAT001",
            "Raw Material A",
            dec!(100),
            Some(dec!(50)),
            "USD",
        );

        let (movement, je) = generator.generate_goods_issue(
            &position,
            NaiveDate::from_ymd_opt(2024, 1, 20).unwrap(),
            dec!(30),
            Some("CC100"),
            None,
        );

        assert_eq!(movement.movement_type, MovementType::GoodsIssue);
        assert_eq!(movement.quantity, dec!(30));
        assert!(je.is_balanced());
    }
}