backbone-pos 0.7.1

Point of sale — cashier session, ticket + multi-tender; orchestrates billing (revenue) + payment (settlement), posts no GL directly
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
//! PosProfile DTOs (Data Transfer Objects)
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! DTOs provide a clean separation between domain entities and API
//! representations, with validation and OpenAPI documentation support.

use serde::{Deserialize, Serialize};
use uuid::Uuid;
use chrono::{DateTime, Utc};
use rust_decimal::Decimal;

#[cfg(feature = "openapi")]
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

#[cfg(feature = "validation")]
use validator::Validate;

use crate::domain::entity::PosProfile;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::PosCashRoundingStrategy;
use crate::domain::entity::PosProfileStatus;

// =============================================================================
// Create DTO
// =============================================================================

/// Request DTO for creating a new PosProfile
///
/// Used in POST requests to create new entities.
/// Excludes auto-generated fields (id, created_at, updated_at, deleted_at).
#[derive(Debug, Clone, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct CreatePosProfileDto {
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "branch_id")]
    pub branch_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 140)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "default_customer_id")]
    pub default_customer_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 3)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub currency: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "income_account_id")]
    pub income_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "receivable_account_id")]
    pub receivable_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "cash_account_id")]
    pub cash_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "write_off_account_id")]
    pub write_off_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "tax_account_id")]
    pub tax_account_id: Option<Uuid>,
    #[serde(alias = "tax_rate")]
    pub tax_rate: Decimal,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "tax_template_ids")]
    pub tax_template_ids: Option<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "warehouse_id")]
    pub warehouse_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "cogs_account_id")]
    pub cogs_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "inventory_account_id")]
    pub inventory_account_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "allow_discount")]
    pub allow_discount: bool,
    #[serde(alias = "cash_rounding_strategy")]
    pub cash_rounding_strategy: PosCashRoundingStrategy,
    #[serde(alias = "cash_rounding_unit")]
    pub cash_rounding_unit: Decimal,
    pub status: PosProfileStatus,
}

// =============================================================================
// Update DTO
// =============================================================================

/// Request DTO for full update of a PosProfile
///
/// Used in PUT requests for full entity replacement.
/// All fields are required (except auto-generated ones).
#[derive(Debug, Clone, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct UpdatePosProfileDto {
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "branch_id")]
    pub branch_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 140)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "default_customer_id")]
    pub default_customer_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 3)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub currency: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "income_account_id")]
    pub income_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "receivable_account_id")]
    pub receivable_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "cash_account_id")]
    pub cash_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "write_off_account_id")]
    pub write_off_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "tax_account_id")]
    pub tax_account_id: Option<Uuid>,
    #[serde(alias = "tax_rate")]
    pub tax_rate: Decimal,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "tax_template_ids")]
    pub tax_template_ids: Option<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "warehouse_id")]
    pub warehouse_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "cogs_account_id")]
    pub cogs_account_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "inventory_account_id")]
    pub inventory_account_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "allow_discount")]
    pub allow_discount: bool,
    #[serde(alias = "cash_rounding_strategy")]
    pub cash_rounding_strategy: PosCashRoundingStrategy,
    #[serde(alias = "cash_rounding_unit")]
    pub cash_rounding_unit: Decimal,
    pub status: PosProfileStatus,
}

// =============================================================================
// Patch DTO
// =============================================================================

/// Request DTO for partial update of a PosProfile
///
/// Used in PATCH requests for partial updates.
/// All fields are optional - only provided fields will be updated.
#[derive(Debug, Clone, Default, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct PatchPosProfileDto {
    #[serde(skip_serializing_if = "Option::is_none", alias = "branch_id")]
    pub branch_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 140)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "default_customer_id")]
    pub default_customer_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 3)))]
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "income_account_id")]
    pub income_account_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "receivable_account_id")]
    pub receivable_account_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "cash_account_id")]
    pub cash_account_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "write_off_account_id")]
    pub write_off_account_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "tax_account_id")]
    pub tax_account_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "tax_rate")]
    pub tax_rate: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "tax_template_ids")]
    pub tax_template_ids: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "warehouse_id")]
    pub warehouse_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "cogs_account_id")]
    pub cogs_account_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "inventory_account_id")]
    pub inventory_account_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "allow_discount")]
    pub allow_discount: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "cash_rounding_strategy")]
    pub cash_rounding_strategy: Option<PosCashRoundingStrategy>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "cash_rounding_unit")]
    pub cash_rounding_unit: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<PosProfileStatus>,
}

impl PatchPosProfileDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.branch_id.is_some() || self.name.is_some() || self.default_customer_id.is_some() || self.currency.is_some() || self.income_account_id.is_some() || self.receivable_account_id.is_some() || self.cash_account_id.is_some() || self.write_off_account_id.is_some() || self.tax_account_id.is_some() || self.tax_rate.is_some() || self.tax_template_ids.is_some() || self.warehouse_id.is_some() || self.cogs_account_id.is_some() || self.inventory_account_id.is_some() || self.allow_discount.is_some() || self.cash_rounding_strategy.is_some() || self.cash_rounding_unit.is_some() || self.status.is_some()
    }
}

// =============================================================================
// Response DTO
// =============================================================================

/// Response DTO for PosProfile entity
///
/// Used in API responses for single entity.
/// Includes all fields including metadata.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct PosProfileResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    pub branch_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    pub default_customer_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub currency: String,
    pub income_account_id: Option<Uuid>,
    pub receivable_account_id: Option<Uuid>,
    pub cash_account_id: Option<Uuid>,
    pub write_off_account_id: Option<Uuid>,
    pub tax_account_id: Option<Uuid>,
    pub tax_rate: Decimal,
    pub tax_template_ids: Option<serde_json::Value>,
    pub warehouse_id: Option<Uuid>,
    pub cogs_account_id: Option<Uuid>,
    pub inventory_account_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub allow_discount: bool,
    pub cash_rounding_strategy: PosCashRoundingStrategy,
    pub cash_rounding_unit: Decimal,
    pub status: PosProfileStatus,
    pub metadata: AuditMetadata,
}

// =============================================================================
// List Response DTO
// =============================================================================

/// Paginated list response for PosProfile entities
///
/// Used in API responses for list endpoints.
/// Includes pagination metadata.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct PosProfileListResponseDto {
    /// List of items
    pub items: Vec<PosProfileResponseDto>,
    /// Total number of items (across all pages)
    pub total: u64,
    /// Current page number (1-indexed)
    pub page: u32,
    /// Number of items per page
    pub per_page: u32,
    /// Total number of pages
    pub total_pages: u32,
    /// Whether there is a next page
    pub has_next: bool,
    /// Whether there is a previous page
    pub has_prev: bool,
}

impl PosProfileListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<PosProfileResponseDto>, total: u64, page: u32, per_page: u32) -> Self {
        let total_pages = if per_page > 0 {
            ((total as f64) / (per_page as f64)).ceil() as u32
        } else {
            0
        };
        Self {
            items,
            total,
            page,
            per_page,
            total_pages,
            has_next: page < total_pages,
            has_prev: page > 1,
        }
    }
}

/// Summary DTO for list views (compact version)
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct PosProfileSummaryDto {
    pub id: Uuid,
    pub branch_id: Option<Uuid>,
    pub name: String,
    pub default_customer_id: Option<Uuid>,
    pub created_at: Option<DateTime<Utc>>,
}

// =============================================================================
// Conversions
// =============================================================================

impl From<PosProfile> for PosProfileResponseDto {
    fn from(entity: PosProfile) -> Self {
        Self {
            id: entity.id,
            branch_id: entity.branch_id,
            name: entity.name,
            default_customer_id: entity.default_customer_id,
            currency: entity.currency,
            income_account_id: entity.income_account_id,
            receivable_account_id: entity.receivable_account_id,
            cash_account_id: entity.cash_account_id,
            write_off_account_id: entity.write_off_account_id,
            tax_account_id: entity.tax_account_id,
            tax_rate: entity.tax_rate,
            tax_template_ids: entity.tax_template_ids,
            warehouse_id: entity.warehouse_id,
            cogs_account_id: entity.cogs_account_id,
            inventory_account_id: entity.inventory_account_id,
            allow_discount: entity.allow_discount,
            cash_rounding_strategy: entity.cash_rounding_strategy,
            cash_rounding_unit: entity.cash_rounding_unit,
            status: entity.status,
            metadata: entity.metadata,
        }
    }
}

impl From<PosProfile> for PosProfileSummaryDto {
    fn from(entity: PosProfile) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            branch_id: entity.branch_id,
            name: entity.name,
            default_customer_id: entity.default_customer_id,
            created_at,
        }
    }
}

impl From<CreatePosProfileDto> for PosProfile {
    fn from(dto: CreatePosProfileDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            branch_id: dto.branch_id,
            name: dto.name,
            default_customer_id: dto.default_customer_id,
            currency: dto.currency,
            income_account_id: dto.income_account_id,
            receivable_account_id: dto.receivable_account_id,
            cash_account_id: dto.cash_account_id,
            write_off_account_id: dto.write_off_account_id,
            tax_account_id: dto.tax_account_id,
            tax_rate: dto.tax_rate,
            tax_template_ids: dto.tax_template_ids,
            warehouse_id: dto.warehouse_id,
            cogs_account_id: dto.cogs_account_id,
            inventory_account_id: dto.inventory_account_id,
            allow_discount: dto.allow_discount,
            cash_rounding_strategy: dto.cash_rounding_strategy,
            cash_rounding_unit: dto.cash_rounding_unit,
            status: dto.status,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&PosProfile> for PosProfileResponseDto {
    fn from(entity: &PosProfile) -> Self {
        Self {
            id: entity.id.clone(),
            branch_id: entity.branch_id.clone(),
            name: entity.name.clone(),
            default_customer_id: entity.default_customer_id.clone(),
            currency: entity.currency.clone(),
            income_account_id: entity.income_account_id.clone(),
            receivable_account_id: entity.receivable_account_id.clone(),
            cash_account_id: entity.cash_account_id.clone(),
            write_off_account_id: entity.write_off_account_id.clone(),
            tax_account_id: entity.tax_account_id.clone(),
            tax_rate: entity.tax_rate.clone(),
            tax_template_ids: entity.tax_template_ids.clone(),
            warehouse_id: entity.warehouse_id.clone(),
            cogs_account_id: entity.cogs_account_id.clone(),
            inventory_account_id: entity.inventory_account_id.clone(),
            allow_discount: entity.allow_discount.clone(),
            cash_rounding_strategy: entity.cash_rounding_strategy.clone(),
            cash_rounding_unit: entity.cash_rounding_unit.clone(),
            status: entity.status.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

impl backbone_core::FromCreateDto<CreatePosProfileDto> for PosProfile {
    fn from_create_dto(dto: CreatePosProfileDto) -> backbone_core::ServiceResult<Self> {
        Ok(PosProfile::from(dto))
    }
}

impl backbone_core::ApplyUpdateDto<UpdatePosProfileDto> for PosProfile {
    fn apply_update(mut self, dto: UpdatePosProfileDto) -> backbone_core::ServiceResult<Self> {
        self.branch_id = dto.branch_id;
        self.name = dto.name;
        self.default_customer_id = dto.default_customer_id;
        self.currency = dto.currency;
        self.income_account_id = dto.income_account_id;
        self.receivable_account_id = dto.receivable_account_id;
        self.cash_account_id = dto.cash_account_id;
        self.write_off_account_id = dto.write_off_account_id;
        self.tax_account_id = dto.tax_account_id;
        self.tax_rate = dto.tax_rate;
        self.tax_template_ids = dto.tax_template_ids;
        self.warehouse_id = dto.warehouse_id;
        self.cogs_account_id = dto.cogs_account_id;
        self.inventory_account_id = dto.inventory_account_id;
        self.allow_discount = dto.allow_discount;
        self.cash_rounding_strategy = dto.cash_rounding_strategy;
        self.cash_rounding_unit = dto.cash_rounding_unit;
        self.status = dto.status;
        Ok(self)
    }
}

// =============================================================================
// Custom DTOs
// =============================================================================

// <<< CUSTOM DTOs
// Add custom DTOs specific to PosProfile here.
// This section will be preserved during regeneration.
// >>> END CUSTOM DTOs