stateset-core 0.8.1

Core domain models and business logic for StateSet iCommerce
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
//! Credit Management domain models
//!
//! Models for customer credit limits, credit holds, and credit applications.

use chrono::{DateTime, Utc};
use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};
use stateset_primitives::{CreditId, CurrencyCode, CustomerId, OrderId};
use strum::{Display, EnumString};
use uuid::Uuid;

// ============================================================================
// Core Credit Types
// ============================================================================

/// Customer credit account.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreditAccount {
    pub id: CreditId,
    pub customer_id: CustomerId,
    pub credit_limit: Decimal,
    pub available_credit: Decimal,
    pub current_balance: Decimal,
    pub hold_amount: Decimal,
    pub currency: CurrencyCode,
    pub status: CreditAccountStatus,
    pub payment_terms: Option<String>,
    pub risk_rating: Option<RiskRating>,
    pub last_review_date: Option<DateTime<Utc>>,
    pub next_review_date: Option<DateTime<Utc>>,
    pub notes: Option<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

/// Credit hold on an order.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreditHold {
    pub id: Uuid,
    pub customer_id: CustomerId,
    pub order_id: Option<OrderId>,
    pub hold_type: CreditHoldType,
    pub hold_amount: Decimal,
    pub reason: String,
    pub status: CreditHoldStatus,
    pub placed_by: Option<String>,
    pub placed_at: DateTime<Utc>,
    pub released_by: Option<String>,
    pub released_at: Option<DateTime<Utc>>,
    pub release_notes: Option<String>,
    pub created_at: DateTime<Utc>,
}

/// Credit application from a customer.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreditApplication {
    pub id: Uuid,
    pub application_number: String,
    pub customer_id: CustomerId,
    pub requested_limit: Decimal,
    pub approved_limit: Option<Decimal>,
    pub status: CreditApplicationStatus,
    pub business_name: Option<String>,
    pub tax_id: Option<String>,
    pub years_in_business: Option<i32>,
    pub annual_revenue: Option<Decimal>,
    pub bank_reference: Option<String>,
    pub trade_references: Option<String>,
    pub submitted_at: DateTime<Utc>,
    pub reviewed_by: Option<String>,
    pub reviewed_at: Option<DateTime<Utc>>,
    pub decision_notes: Option<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

/// Credit transaction history.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreditTransaction {
    pub id: Uuid,
    pub customer_id: CustomerId,
    pub transaction_type: CreditTransactionType,
    pub amount: Decimal,
    pub running_balance: Decimal,
    pub reference_type: Option<String>,
    pub reference_id: Option<Uuid>,
    pub notes: Option<String>,
    pub created_at: DateTime<Utc>,
}

/// Credit check result.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreditCheckResult {
    pub customer_id: CustomerId,
    pub order_amount: Decimal,
    pub credit_limit: Decimal,
    pub available_credit: Decimal,
    pub current_balance: Decimal,
    pub approved: bool,
    pub reason: Option<String>,
    pub requires_approval: bool,
    pub checked_at: DateTime<Utc>,
}

// ============================================================================
// Enums
// ============================================================================

/// Credit account status.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, Serialize, Deserialize, Default,
)]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum CreditAccountStatus {
    #[default]
    Active,
    Suspended,
    #[strum(serialize = "on_hold", serialize = "onhold")]
    OnHold,
    Closed,
    #[strum(serialize = "pending_review", serialize = "pendingreview")]
    PendingReview,
}

/// Risk rating.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, Serialize, Deserialize, Default,
)]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum RiskRating {
    Low,
    #[default]
    Medium,
    High,
    Critical,
}

/// Credit hold type.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, Serialize, Deserialize, Default,
)]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum CreditHoldType {
    #[default]
    #[strum(serialize = "over_limit", serialize = "overlimit")]
    OverLimit,
    #[strum(serialize = "past_due", serialize = "pastdue")]
    PastDue,
    Manual,
    #[strum(serialize = "new_customer", serialize = "newcustomer")]
    NewCustomer,
    #[strum(serialize = "high_risk", serialize = "highrisk")]
    HighRisk,
}

/// Credit hold status.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, Serialize, Deserialize, Default,
)]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum CreditHoldStatus {
    #[default]
    Active,
    Released,
    Expired,
}

/// Credit application status.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, Serialize, Deserialize, Default,
)]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum CreditApplicationStatus {
    #[default]
    Pending,
    #[strum(serialize = "under_review", serialize = "underreview")]
    UnderReview,
    Approved,
    #[strum(serialize = "denied", serialize = "rejected")]
    Denied,
    #[strum(
        serialize = "more_info_needed",
        serialize = "moreinfoneeded",
        serialize = "info_needed"
    )]
    MoreInfoNeeded,
    Withdrawn,
}

/// Credit transaction type.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, Serialize, Deserialize, Default,
)]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum CreditTransactionType {
    #[default]
    Charge,
    Payment,
    #[strum(serialize = "credit_memo", serialize = "creditmemo")]
    CreditMemo,
    Adjustment,
    #[strum(serialize = "write_off", serialize = "writeoff")]
    WriteOff,
    #[strum(serialize = "limit_change", serialize = "limitchange")]
    LimitChange,
}

// ============================================================================
// Input Types
// ============================================================================

/// Input for creating a credit account.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreateCreditAccount {
    pub customer_id: CustomerId,
    pub credit_limit: Decimal,
    pub currency: Option<CurrencyCode>,
    pub payment_terms: Option<String>,
    pub risk_rating: Option<RiskRating>,
    pub notes: Option<String>,
}

/// Input for updating a credit account.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct UpdateCreditAccount {
    pub credit_limit: Option<Decimal>,
    pub status: Option<CreditAccountStatus>,
    pub payment_terms: Option<String>,
    pub risk_rating: Option<RiskRating>,
    pub notes: Option<String>,
}

/// Input for placing a credit hold.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PlaceCreditHold {
    pub customer_id: CustomerId,
    pub order_id: Option<OrderId>,
    pub hold_type: CreditHoldType,
    pub hold_amount: Decimal,
    pub reason: String,
    pub placed_by: Option<String>,
}

/// Input for releasing a credit hold.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ReleaseCreditHold {
    pub hold_id: Uuid,
    pub released_by: Option<String>,
    pub release_notes: Option<String>,
}

/// Input for submitting a credit application.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SubmitCreditApplication {
    pub customer_id: CustomerId,
    pub requested_limit: Decimal,
    pub business_name: Option<String>,
    pub tax_id: Option<String>,
    pub years_in_business: Option<i32>,
    pub annual_revenue: Option<Decimal>,
    pub bank_reference: Option<String>,
    pub trade_references: Option<String>,
}

/// Input for reviewing a credit application.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ReviewCreditApplication {
    pub application_id: Uuid,
    pub approved_limit: Option<Decimal>,
    pub status: CreditApplicationStatus,
    pub reviewed_by: String,
    pub decision_notes: Option<String>,
}

/// Input for recording a credit transaction.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RecordCreditTransaction {
    pub customer_id: CustomerId,
    pub transaction_type: CreditTransactionType,
    pub amount: Decimal,
    pub reference_type: Option<String>,
    pub reference_id: Option<Uuid>,
    pub notes: Option<String>,
}

// ============================================================================
// Filter Types
// ============================================================================

/// Filter for listing credit accounts.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreditAccountFilter {
    pub customer_id: Option<CustomerId>,
    pub status: Option<CreditAccountStatus>,
    pub risk_rating: Option<RiskRating>,
    pub over_limit: Option<bool>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

/// Filter for listing credit holds.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreditHoldFilter {
    pub customer_id: Option<CustomerId>,
    pub order_id: Option<OrderId>,
    pub hold_type: Option<CreditHoldType>,
    pub status: Option<CreditHoldStatus>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

/// Filter for listing credit applications.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreditApplicationFilter {
    pub customer_id: Option<CustomerId>,
    pub status: Option<CreditApplicationStatus>,
    pub from_date: Option<DateTime<Utc>>,
    pub to_date: Option<DateTime<Utc>>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

/// Filter for listing credit transactions.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CreditTransactionFilter {
    pub customer_id: Option<CustomerId>,
    pub transaction_type: Option<CreditTransactionType>,
    pub from_date: Option<DateTime<Utc>>,
    pub to_date: Option<DateTime<Utc>>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

// ============================================================================
// Summary Types
// ============================================================================

/// Credit aging bucket.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreditAgingBucket {
    pub current: Decimal,
    pub days_1_30: Decimal,
    pub days_31_60: Decimal,
    pub days_61_90: Decimal,
    pub days_over_90: Decimal,
    pub total: Decimal,
}

/// Customer credit summary.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomerCreditSummary {
    pub customer_id: CustomerId,
    pub credit_limit: Decimal,
    pub current_balance: Decimal,
    pub available_credit: Decimal,
    pub oldest_due_date: Option<DateTime<Utc>>,
    pub days_past_due: i32,
    pub hold_count: i32,
}

// ============================================================================
// Helper Functions
// ============================================================================

/// Generate a credit application number.
pub fn generate_credit_application_number() -> String {
    let timestamp = chrono::Utc::now().format("%Y%m%d").to_string();
    let random = &uuid::Uuid::new_v4().to_string()[..6].to_uppercase();
    format!("CAPP-{}-{}", timestamp, random)
}

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

    #[test]
    fn test_credit_account_status_from_str() {
        assert_eq!(CreditAccountStatus::from_str("active").unwrap(), CreditAccountStatus::Active);
        assert_eq!(CreditAccountStatus::from_str("OnHold").unwrap(), CreditAccountStatus::OnHold);
        assert!(CreditAccountStatus::from_str("nope").is_err());
    }

    #[test]
    fn test_risk_rating_from_str() {
        assert_eq!(RiskRating::from_str("low").unwrap(), RiskRating::Low);
        assert_eq!(RiskRating::from_str("CRITICAL").unwrap(), RiskRating::Critical);
        assert!(RiskRating::from_str("nope").is_err());
    }

    #[test]
    fn test_credit_hold_type_from_str() {
        assert_eq!(CreditHoldType::from_str("overlimit").unwrap(), CreditHoldType::OverLimit);
        assert_eq!(CreditHoldType::from_str("past_due").unwrap(), CreditHoldType::PastDue);
        assert!(CreditHoldType::from_str("nope").is_err());
    }

    #[test]
    fn test_credit_hold_status_from_str() {
        assert_eq!(CreditHoldStatus::from_str("released").unwrap(), CreditHoldStatus::Released);
        assert!(CreditHoldStatus::from_str("nope").is_err());
    }

    #[test]
    fn test_credit_application_status_from_str() {
        assert_eq!(
            CreditApplicationStatus::from_str("under_review").unwrap(),
            CreditApplicationStatus::UnderReview
        );
        assert_eq!(
            CreditApplicationStatus::from_str("info_needed").unwrap(),
            CreditApplicationStatus::MoreInfoNeeded
        );
        assert!(CreditApplicationStatus::from_str("nope").is_err());
    }

    #[test]
    fn test_credit_transaction_type_from_str() {
        assert_eq!(
            CreditTransactionType::from_str("creditmemo").unwrap(),
            CreditTransactionType::CreditMemo
        );
        assert_eq!(
            CreditTransactionType::from_str("limit_change").unwrap(),
            CreditTransactionType::LimitChange
        );
        assert!(CreditTransactionType::from_str("nope").is_err());
    }
}