backbone-payroll 0.3.47

Payroll: salary structures, payroll runs and computed salary slips over effective-dated statutory tables, plus compensation changes
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
use chrono::{DateTime, Utc, NaiveDate};
use serde::{Deserialize, Serialize};
use sqlx::FromRow;
use uuid::Uuid;
use rust_decimal::Decimal;

use super::PayrollStatus;
use super::AuditMetadata;

/// Strongly-typed ID for PayrollEntry
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct PayrollEntryId(pub Uuid);

impl PayrollEntryId {
    pub fn new(id: Uuid) -> Self { Self(id) }
    pub fn generate() -> Self { Self(Uuid::new_v4()) }
    pub fn into_inner(self) -> Uuid { self.0 }
}

impl std::fmt::Display for PayrollEntryId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl std::str::FromStr for PayrollEntryId {
    type Err = uuid::Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self(Uuid::parse_str(s)?))
    }
}

impl From<Uuid> for PayrollEntryId {
    fn from(id: Uuid) -> Self { Self(id) }
}

impl From<PayrollEntryId> for Uuid {
    fn from(id: PayrollEntryId) -> Self { id.0 }
}

impl AsRef<Uuid> for PayrollEntryId {
    fn as_ref(&self) -> &Uuid { &self.0 }
}

impl std::ops::Deref for PayrollEntryId {
    type Target = Uuid;
    fn deref(&self) -> &Self::Target { &self.0 }
}

#[derive(Debug, Clone, Serialize, Deserialize, FromRow)]
pub struct PayrollEntry {
    pub id: Uuid,
    pub period_year: i32,
    pub period_month: i32,
    pub posting_date: Option<DateTime<Utc>>,
    pub timesheet_approval_id: Option<Uuid>,
    pub period_start: Option<NaiveDate>,
    pub period_end: Option<NaiveDate>,
    pub status: PayrollStatus,
    pub salary_expense_account_id: Option<Uuid>,
    pub salary_payable_account_id: Option<Uuid>,
    pub total_gross: Decimal,
    pub total_deductions: Decimal,
    pub total_net: Decimal,
    pub journal_id: Option<Uuid>,
    pub accounting_post_id: Option<Uuid>,
    #[serde(default)]
    #[sqlx(json)]
    pub metadata: AuditMetadata,
}

impl PayrollEntry {
    /// Create a builder for PayrollEntry
    pub fn builder() -> PayrollEntryBuilder {
        <PayrollEntryBuilder as Default>::default()
    }

    /// Create a new PayrollEntry with required fields
    pub fn new(period_year: i32, period_month: i32, status: PayrollStatus, total_gross: Decimal, total_deductions: Decimal, total_net: Decimal) -> Self {
        Self {
            id: Uuid::new_v4(),
            period_year,
            period_month,
            posting_date: None,
            timesheet_approval_id: None,
            period_start: None,
            period_end: None,
            status,
            salary_expense_account_id: None,
            salary_payable_account_id: None,
            total_gross,
            total_deductions,
            total_net,
            journal_id: None,
            accounting_post_id: None,
            metadata: AuditMetadata::default(),
        }
    }

    /// Get the entity's unique identifier
    pub fn id(&self) -> &Uuid {
        &self.id
    }

    /// Get a strongly-typed ID for this entity
    pub fn typed_id(&self) -> PayrollEntryId {
        PayrollEntryId(self.id)
    }

    /// Get when this entity was created
    pub fn created_at(&self) -> Option<&DateTime<Utc>> {
        self.metadata.created_at.as_ref()
    }

    /// Get when this entity was last updated
    pub fn updated_at(&self) -> Option<&DateTime<Utc>> {
        self.metadata.updated_at.as_ref()
    }

    /// Check if this entity is soft deleted
    pub fn is_deleted(&self) -> bool {
        self.metadata.deleted_at.is_some()
    }

    /// Check if this entity is active (not deleted)
    pub fn is_active(&self) -> bool {
        self.metadata.deleted_at.is_none()
    }

    /// Get when this entity was deleted
    pub fn deleted_at(&self) -> Option<&DateTime<Utc>> {
        self.metadata.deleted_at.as_ref()
    }

    /// Get who created this entity
    pub fn created_by(&self) -> Option<&Uuid> {
        self.metadata.created_by.as_ref()
    }

    /// Get who last updated this entity
    pub fn updated_by(&self) -> Option<&Uuid> {
        self.metadata.updated_by.as_ref()
    }

    /// Get who deleted this entity
    pub fn deleted_by(&self) -> Option<&Uuid> {
        self.metadata.deleted_by.as_ref()
    }

    /// Get the current status
    pub fn status(&self) -> &PayrollStatus {
        &self.status
    }


    // ==========================================================
    // Fluent Setters (with_* for optional fields)
    // ==========================================================

    /// Set the posting_date field (chainable)
    pub fn with_posting_date(mut self, value: DateTime<Utc>) -> Self {
        self.posting_date = Some(value);
        self
    }

    /// Set the timesheet_approval_id field (chainable)
    pub fn with_timesheet_approval_id(mut self, value: Uuid) -> Self {
        self.timesheet_approval_id = Some(value);
        self
    }

    /// Set the period_start field (chainable)
    pub fn with_period_start(mut self, value: NaiveDate) -> Self {
        self.period_start = Some(value);
        self
    }

    /// Set the period_end field (chainable)
    pub fn with_period_end(mut self, value: NaiveDate) -> Self {
        self.period_end = Some(value);
        self
    }

    /// Set the salary_expense_account_id field (chainable)
    pub fn with_salary_expense_account_id(mut self, value: Uuid) -> Self {
        self.salary_expense_account_id = Some(value);
        self
    }

    /// Set the salary_payable_account_id field (chainable)
    pub fn with_salary_payable_account_id(mut self, value: Uuid) -> Self {
        self.salary_payable_account_id = Some(value);
        self
    }

    /// Set the journal_id field (chainable)
    pub fn with_journal_id(mut self, value: Uuid) -> Self {
        self.journal_id = Some(value);
        self
    }

    /// Set the accounting_post_id field (chainable)
    pub fn with_accounting_post_id(mut self, value: Uuid) -> Self {
        self.accounting_post_id = Some(value);
        self
    }

    // ==========================================================
    // Partial Update
    // ==========================================================

    /// Apply partial updates from a map of field name to JSON value
    pub fn apply_patch(&mut self, fields: std::collections::HashMap<String, serde_json::Value>) {
        for (key, value) in fields {
            match key.as_str() {
                "period_year" => {
                    if let Ok(v) = serde_json::from_value(value) { self.period_year = v; }
                }
                "period_month" => {
                    if let Ok(v) = serde_json::from_value(value) { self.period_month = v; }
                }
                "posting_date" => {
                    if let Ok(v) = serde_json::from_value(value) { self.posting_date = v; }
                }
                "timesheet_approval_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.timesheet_approval_id = v; }
                }
                "period_start" => {
                    if let Ok(v) = serde_json::from_value(value) { self.period_start = v; }
                }
                "period_end" => {
                    if let Ok(v) = serde_json::from_value(value) { self.period_end = v; }
                }
                "status" => {
                    if let Ok(v) = serde_json::from_value(value) { self.status = v; }
                }
                "salary_expense_account_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.salary_expense_account_id = v; }
                }
                "salary_payable_account_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.salary_payable_account_id = v; }
                }
                "total_gross" => {
                    if let Ok(v) = serde_json::from_value(value) { self.total_gross = v; }
                }
                "total_deductions" => {
                    if let Ok(v) = serde_json::from_value(value) { self.total_deductions = v; }
                }
                "total_net" => {
                    if let Ok(v) = serde_json::from_value(value) { self.total_net = v; }
                }
                "journal_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.journal_id = v; }
                }
                "accounting_post_id" => {
                    if let Ok(v) = serde_json::from_value(value) { self.accounting_post_id = v; }
                }
                _ => {} // ignore unknown fields
            }
        }
    }

    // <<< CUSTOM METHODS START >>>
    // <<< CUSTOM METHODS END >>>
}

impl super::Entity for PayrollEntry {
    type Id = Uuid;

    fn entity_id(&self) -> &Self::Id {
        &self.id
    }

    fn entity_type() -> &'static str {
        "PayrollEntry"
    }
}

impl backbone_core::PersistentEntity for PayrollEntry {
    fn entity_id(&self) -> String {
        self.id.to_string()
    }
    fn set_entity_id(&mut self, id: String) {
        if let Ok(uuid) = uuid::Uuid::parse_str(&id) {
            self.id = uuid;
        }
    }
    fn created_at(&self) -> Option<chrono::DateTime<chrono::Utc>> {
        self.metadata.created_at
    }
    fn set_created_at(&mut self, ts: chrono::DateTime<chrono::Utc>) {
        self.metadata.created_at = Some(ts);
    }
    fn updated_at(&self) -> Option<chrono::DateTime<chrono::Utc>> {
        self.metadata.updated_at
    }
    fn set_updated_at(&mut self, ts: chrono::DateTime<chrono::Utc>) {
        self.metadata.updated_at = Some(ts);
    }
    fn deleted_at(&self) -> Option<chrono::DateTime<chrono::Utc>> {
        self.metadata.deleted_at
    }
    fn set_deleted_at(&mut self, ts: Option<chrono::DateTime<chrono::Utc>>) {
        self.metadata.deleted_at = ts;
    }
}

impl backbone_orm::EntityRepoMeta for PayrollEntry {
    fn column_types() -> std::collections::HashMap<String, String> {
        let mut m = std::collections::HashMap::new();
        m.insert("id".to_string(), "uuid".to_string());
        m.insert("timesheet_approval_id".to_string(), "uuid".to_string());
        m.insert("salary_expense_account_id".to_string(), "uuid".to_string());
        m.insert("salary_payable_account_id".to_string(), "uuid".to_string());
        m.insert("journal_id".to_string(), "uuid".to_string());
        m.insert("accounting_post_id".to_string(), "uuid".to_string());
        m.insert("status".to_string(), "payroll_status".to_string());
        m.insert("posting_date".to_string(), "timestamptz".to_string());
        m.insert("period_start".to_string(), "date".to_string());
        m.insert("period_end".to_string(), "date".to_string());
        m
    }
    fn search_fields() -> &'static [&'static str] {
        &[]
    }
}

/// Builder for PayrollEntry entity
///
/// Provides a fluent API for constructing PayrollEntry instances.
/// System fields (id, metadata, timestamps) are auto-initialized.
#[derive(Debug, Clone, Default)]
pub struct PayrollEntryBuilder {
    period_year: Option<i32>,
    period_month: Option<i32>,
    posting_date: Option<DateTime<Utc>>,
    timesheet_approval_id: Option<Uuid>,
    period_start: Option<NaiveDate>,
    period_end: Option<NaiveDate>,
    status: Option<PayrollStatus>,
    salary_expense_account_id: Option<Uuid>,
    salary_payable_account_id: Option<Uuid>,
    total_gross: Option<Decimal>,
    total_deductions: Option<Decimal>,
    total_net: Option<Decimal>,
    journal_id: Option<Uuid>,
    accounting_post_id: Option<Uuid>,
}

impl PayrollEntryBuilder {
    /// Set the period_year field (required)
    pub fn period_year(mut self, value: i32) -> Self {
        self.period_year = Some(value);
        self
    }

    /// Set the period_month field (required)
    pub fn period_month(mut self, value: i32) -> Self {
        self.period_month = Some(value);
        self
    }

    /// Set the posting_date field (optional)
    pub fn posting_date(mut self, value: DateTime<Utc>) -> Self {
        self.posting_date = Some(value);
        self
    }

    /// Set the timesheet_approval_id field (optional)
    pub fn timesheet_approval_id(mut self, value: Uuid) -> Self {
        self.timesheet_approval_id = Some(value);
        self
    }

    /// Set the period_start field (optional)
    pub fn period_start(mut self, value: NaiveDate) -> Self {
        self.period_start = Some(value);
        self
    }

    /// Set the period_end field (optional)
    pub fn period_end(mut self, value: NaiveDate) -> Self {
        self.period_end = Some(value);
        self
    }

    /// Set the status field (default: `PayrollStatus::default()`)
    pub fn status(mut self, value: PayrollStatus) -> Self {
        self.status = Some(value);
        self
    }

    /// Set the salary_expense_account_id field (optional)
    pub fn salary_expense_account_id(mut self, value: Uuid) -> Self {
        self.salary_expense_account_id = Some(value);
        self
    }

    /// Set the salary_payable_account_id field (optional)
    pub fn salary_payable_account_id(mut self, value: Uuid) -> Self {
        self.salary_payable_account_id = Some(value);
        self
    }

    /// Set the total_gross field (default: `Decimal::from(0)`)
    pub fn total_gross(mut self, value: Decimal) -> Self {
        self.total_gross = Some(value);
        self
    }

    /// Set the total_deductions field (default: `Decimal::from(0)`)
    pub fn total_deductions(mut self, value: Decimal) -> Self {
        self.total_deductions = Some(value);
        self
    }

    /// Set the total_net field (default: `Decimal::from(0)`)
    pub fn total_net(mut self, value: Decimal) -> Self {
        self.total_net = Some(value);
        self
    }

    /// Set the journal_id field (optional)
    pub fn journal_id(mut self, value: Uuid) -> Self {
        self.journal_id = Some(value);
        self
    }

    /// Set the accounting_post_id field (optional)
    pub fn accounting_post_id(mut self, value: Uuid) -> Self {
        self.accounting_post_id = Some(value);
        self
    }

    /// Build the PayrollEntry entity
    ///
    /// Returns Err if any required field without a default is missing.
    pub fn build(self) -> Result<PayrollEntry, String> {
        let period_year = self.period_year.ok_or_else(|| "period_year is required".to_string())?;
        let period_month = self.period_month.ok_or_else(|| "period_month is required".to_string())?;

        Ok(PayrollEntry {
            id: Uuid::new_v4(),
            period_year,
            period_month,
            posting_date: self.posting_date,
            timesheet_approval_id: self.timesheet_approval_id,
            period_start: self.period_start,
            period_end: self.period_end,
            status: self.status.unwrap_or_default(),
            salary_expense_account_id: self.salary_expense_account_id,
            salary_payable_account_id: self.salary_payable_account_id,
            total_gross: self.total_gross.unwrap_or(Decimal::from(0)),
            total_deductions: self.total_deductions.unwrap_or(Decimal::from(0)),
            total_net: self.total_net.unwrap_or(Decimal::from(0)),
            journal_id: self.journal_id,
            accounting_post_id: self.accounting_post_id,
            metadata: AuditMetadata::default(),
        })
    }
}