backbone-payroll 0.3.49

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

//! DTOs (Data Transfer Objects)
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! This module provides DTOs for the presentation layer,
//! with validation and OpenAPI schema support.

pub mod compensation_change_dto;
pub mod payroll_entry_dto;
pub mod salary_slip_dto;
pub mod salary_slip_line_dto;
pub mod salary_structure_dto;
pub mod salary_component_dto;

// Re-exports
pub use compensation_change_dto::{
    CreateCompensationChangeDto,
    UpdateCompensationChangeDto,
    PatchCompensationChangeDto,
    CompensationChangeResponseDto,
    CompensationChangeListResponseDto,
    CompensationChangeSummaryDto,
};
pub use payroll_entry_dto::{
    CreatePayrollEntryDto,
    UpdatePayrollEntryDto,
    PatchPayrollEntryDto,
    PayrollEntryResponseDto,
    PayrollEntryListResponseDto,
    PayrollEntrySummaryDto,
};
pub use salary_slip_dto::{
    CreateSalarySlipDto,
    UpdateSalarySlipDto,
    PatchSalarySlipDto,
    SalarySlipResponseDto,
    SalarySlipListResponseDto,
    SalarySlipSummaryDto,
};
pub use salary_slip_line_dto::{
    CreateSalarySlipLineDto,
    UpdateSalarySlipLineDto,
    PatchSalarySlipLineDto,
    SalarySlipLineResponseDto,
    SalarySlipLineListResponseDto,
    SalarySlipLineSummaryDto,
};
pub use salary_structure_dto::{
    CreateSalaryStructureDto,
    UpdateSalaryStructureDto,
    PatchSalaryStructureDto,
    SalaryStructureResponseDto,
    SalaryStructureListResponseDto,
    SalaryStructureSummaryDto,
};
pub use salary_component_dto::{
    CreateSalaryComponentDto,
    UpdateSalaryComponentDto,
    PatchSalaryComponentDto,
    SalaryComponentResponseDto,
    SalaryComponentListResponseDto,
    SalaryComponentSummaryDto,
};

// Common pagination types
use serde::Serialize;

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

/// Pagination parameters for list requests
#[derive(Debug, Clone, Default, serde::Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct PaginationParams {
    /// Page number (1-indexed)
    #[serde(default = "default_page")]
    pub page: u32,
    /// Items per page
    #[serde(default = "default_per_page")]
    pub per_page: u32,
    /// Field to sort by
    pub sort_by: Option<String>,
    /// Sort order (asc/desc)
    pub sort_order: Option<String>,
}

fn default_page() -> u32 { 1 }
fn default_per_page() -> u32 { 20 }

/// API response wrapper
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct ApiResponse<T> {
    pub success: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<T>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<ApiError>,
}

#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct ApiError {
    pub code: String,
    pub message: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub details: Option<serde_json::Value>,
}

impl<T> ApiResponse<T> {
    pub fn ok(data: T) -> Self {
        Self { success: true, data: Some(data), error: None }
    }

    pub fn err(code: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            success: false,
            data: None,
            error: Some(ApiError {
                code: code.into(),
                message: message.into(),
                details: None,
            }),
        }
    }
}