brynq-sdk-nmbrs 2.3.4.dev0__py3-none-any.whl → 2.4.5__py3-none-any.whl

brynq_sdk_nmbrs/schemas/department.py

@@ -1,10 +1,6 @@
-from datetime import datetime
-from typing import Optional
-
 import pandas as pd
 import pandera as pa
-import pandera.extensions as extensions
-from pandera.typing import DateTime, Float, Series, String
+from pandera.typing import DateTime, Series, String
 from pydantic import BaseModel, Field
 
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
@@ -44,7 +40,10 @@ class DepartmentGet(BrynQPanderaDataFrameModel):
     code: Series[String] = pa.Field(coerce=True, description="Department Code", alias="code")
     description: Series[String] = pa.Field(coerce=True, description="Department Description", alias="description")
     created_at: Series[DateTime] = pa.Field(coerce=True, description="Created At", alias="createdAt")
-    managers: Series[String] = pa.Field(coerce=True, description="List of managers", alias="managers")
+    managers: Series[String] = pa.Field(coerce=True, nullable=True, description="List of managers", alias="managers")
+
+    class _Annotation:
+        primary_key = "department_id"
 
 class DepartmentCreate(BaseModel):
     code: int = Field(..., ge=1, example=2, description="Department Code", alias="code")
@@ -56,36 +55,3 @@ class EmployeeDepartmentUpdate(BaseModel):
 
     class Config:
         primary_key = "departmentId"
-
-
-# ---------------------------
-# SOAP Schemas (DebtorService)
-# ---------------------------
-class DepartmentMasterCreate(BaseModel):
-    """Schema for creating a master department via SOAP API."""
-    debtor_id: int = Field(..., description="Debtor ID", alias="debtorId", example=34548)
-    code: int = Field(..., ge=1, description="Department Code", alias="code", example=101)
-    description: str = Field(..., min_length=1, max_length=200, description="Department Description", alias="description", example="Engineering")
-
-    class Config:
-        populate_by_name = True
-
-
-class DepartmentMasterUpdate(BaseModel):
-    """Schema for updating a master department via SOAP API."""
-    debtor_id: int = Field(..., description="Debtor ID", alias="debtorId", example=34548)
-    department_id: int = Field(..., description="Department ID", alias="departmentId", example=12345)
-    code: int = Field(..., ge=1, description="Department Code", alias="code", example=101)
-    description: str = Field(..., min_length=1, max_length=200, description="Department Description", alias="description", example="Engineering Updated")
-
-    class Config:
-        populate_by_name = True
-
-
-class DepartmentMasterDelete(BaseModel):
-    """Schema for deleting a master department via SOAP API."""
-    debtor_id: int = Field(..., description="Debtor ID", alias="debtorId", example=34548)
-    department_id: int = Field(..., description="Department ID to delete", alias="departmentId", example=12345)
-
-    class Config:
-        populate_by_name = True

brynq_sdk_nmbrs/schemas/document.py

@@ -4,10 +4,8 @@ from typing import Optional
 
 class DocumentUpload(BaseModel):
     """Schema for uploading a document to an employee via SOAP API."""
-    employee_id: int = Field(..., description="Employee ID", alias="employeeId", example=276967)
     document_name: str = Field(..., description="Document name (with extension)", alias="documentName", example="contract.pdf")
     document_type_guid: str = Field(..., description="Document type GUID", alias="documentTypeGuid", example="00000000-0000-0000-0000-000000000000")
 
     class Config:
         populate_by_name = True
-

brynq_sdk_nmbrs/schemas/employee_wage_tax_settings.py

@@ -0,0 +1,75 @@
+from typing import Literal, Optional
+
+import pandas as pd
+import pandera as pa
+from pydantic import BaseModel, ConfigDict, Field
+
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+# ---------------------------
+# Get Schemas - Employee Wage Tax Settings
+# ---------------------------
+class EmployeeWageTaxSettingsGet(BrynQPanderaDataFrameModel):
+    """Schema for validating employee wage tax settings data."""
+    employee_id: pd.StringDtype = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    wage_tax_settings_id: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Wage tax settings ID", alias="wageTaxSettingsId")
+    wage_tax: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="Wage tax", alias="wageTax")
+    wage_tax_rebate: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="Wage tax rebate (Loonheffingskorting)", alias="wageTaxRebate")
+    single_elderly_discount: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="Single elderly discount", alias="singleElderlyDiscount")
+    color_table: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Color table (White/Green)", alias="colorTable")
+    period_table: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Period table (Month/Week/4Week/Day)", alias="periodTable")
+    income_type: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Income type", alias="incomeType")
+    special_annual_salary_rate: pd.Float64Dtype = pa.Field(coerce=True, nullable=True, description="Special annual salary rate (Loonheffing BT)", alias="specialAnnualSalaryRate")
+    special_table: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Special table", alias="specialTable")
+    different_special_rate: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Different special rate (Afwijkend Bijzonder tarief %)", alias="differentSpecialRate")
+    period_year: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Period year", alias="period.year")
+    period_period: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Period", alias="period.period")
+    created_at: str = pa.Field(coerce=True, nullable=True, description="Created at", alias="createdAt")
+
+    class _Annotation:
+        primary_key = "wage_tax_settings_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "1:N"
+            }
+        }
+
+
+# ---------------------------
+# Create/Update Schemas
+# ---------------------------
+class Period(BaseModel):
+    """Period model for specifying year and period."""
+    model_config = ConfigDict(populate_by_name=True)
+
+    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+
+
+class Calc30PercentRuling(BaseModel):
+    """30 percent ruling settings."""
+    model_config = ConfigDict(populate_by_name=True)
+
+    cal_30_percent_ruling: Optional[str] = Field(None, example="None", description="30% ruling type", alias="Cal30PercentRuling")
+    end_period: Optional[int] = Field(None, ge=1, le=53, example=12, description="End period", alias="endPeriod")
+    end_year: Optional[int] = Field(None, ge=1900, le=2100, example=2025, description="End year", alias="endYear")
+
+
+class EmployeeWageTaxSettingsCreate(BaseModel):
+    """Schema for creating employee wage tax settings."""
+    model_config = ConfigDict(populate_by_name=True)
+
+    wage_tax: bool = Field(..., example=True, description="Wage tax", alias="wageTax")
+    wage_tax_rebate: bool = Field(..., example=True, description="Wage tax rebate (Loonheffingskorting)", alias="wageTaxRebate")
+    single_elderly_discount: bool = Field(..., example=False, description="Single elderly discount", alias="singleElderlyDiscount")
+    color_table: Literal["White", "Green"] = Field(..., example="White", description="Color table", alias="colorTable")
+    period_table: Literal["Month", "Week", "4Week", "Day"] = Field(..., example="Month", description="Period table", alias="periodTable")
+    income_type: str = Field(..., example="11", description="Income type", alias="incomeType")
+    special_annual_salary_rate: Optional[float] = Field(None, example=0.0, description="Special annual salary rate (Loonheffing BT)", alias="specialAnnualSalaryRate")
+    special_table: str = Field(..., example="None", description="Special table", alias="specialTable")
+    different_special_rate: Optional[float] = Field(None, example=0.0, description="Different special rate (Afwijkend Bijzonder tarief %)", alias="differentSpecialRate")
+    calc_30_percent_ruling: Optional[Calc30PercentRuling] = Field(None, example={"Cal30PercentRuling": "None", "endPeriod": 12, "endYear": 2025}, description="30% ruling settings", alias="Calc30PercentRuling")
+    period: Period = Field(..., example={"year": 2021, "period": 4}, description="Period to apply settings")

brynq_sdk_nmbrs/schemas/employees.py

@@ -132,10 +132,12 @@ class CreateEmployeePersonalInfo(BaseModel):
     created_at: Optional[str] = Field(None, example="2021-07-01T10:15:08Z", description="Created At", alias="createdAt")
 
 class EmployeeCreate(BaseModel):
+    company_id: str = Field(..., description="Company identifier", alias="companyId")
     personal_info: CreateEmployeePersonalInfo = Field(..., alias="personalInfo")
     additional_employee_info: AdditionalEmployeeInfo = Field(..., alias="additionalEmployeeInfo")
 
 class EmployeeUpdate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     basic_info: Optional[BasicInfoUpdate] = Field(None, alias="basicInfo")
     birth_info: Optional[BirthInfo] = Field(None, alias="birthInfo")
     contact_info: Optional[ContactInfo] = Field(None, alias="contactInfo")

brynq_sdk_nmbrs/schemas/extra_fields.py

@@ -0,0 +1,56 @@
+import pandas as pd
+import pandera as pa
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+# ---------------------------
+# Get Schemas - Company Extra Field Settings
+# ---------------------------
+class ExtraFieldSettingsGet(BrynQPanderaDataFrameModel):
+    """Schema for validating company extra field settings data."""
+    extra_field_id: pd.StringDtype = pa.Field(coerce=True, description="Extra field ID", alias="extraFieldId")
+    name: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Extra field name", alias="name")
+    extra_field_type: pd.StringDtype = pa.Field(
+        coerce=True,
+        nullable=True,
+        isin=["text", "decimal", "number", "date", "yesNo", "textDate"],
+        description="Extra field type",
+        alias="extraFieldType"
+    )
+
+    class _Annotation:
+        primary_key = "extra_field_id"
+
+
+# ---------------------------
+# Get Schemas - Employee Extra Fields
+# ---------------------------
+class EmployeeExtraFieldsGet(BrynQPanderaDataFrameModel):
+    """Schema for validating employee extra fields data."""
+    employee_id: pd.StringDtype = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    extra_field_id: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Extra field ID", alias="extraField.extraFieldId")
+    extra_field_name: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Extra field name", alias="extraField.name")
+    extra_field_type: pd.StringDtype = pa.Field(
+        coerce=True,
+        nullable=True,
+        isin=["text", "decimal", "number", "date", "yesNo", "textDate"],
+        description="Extra field type",
+        alias="extraField.extraFieldType"
+    )
+    value: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Field value", alias="value")
+    start_date: str = pa.Field(coerce=True, nullable=True, description="Start date", alias="startDate")
+
+    class _Annotation:
+        primary_key = "extra_field_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "1:N"
+            },
+            "extra_field_id": {
+                "parent_schema": "ExtraFieldSettingsGet",
+                "parent_column": "extra_field_id",
+                "cardinality": "N:1"
+            }
+        }

brynq_sdk_nmbrs/schemas/function.py

@@ -1,10 +1,8 @@
 from datetime import datetime
-from typing import Optional
 
 import pandas as pd
 import pandera as pa
-import pandera.extensions as extensions
-from pandera.typing import DateTime, Float, Series, String
+from pandera.typing import Series
 from pydantic import BaseModel, Field
 
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
@@ -44,34 +42,9 @@ class FunctionGet(BrynQPanderaDataFrameModel):
     code: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Function Code", alias="code")
     description: Series[pa.String] = pa.Field(coerce=True, description="Function Description", alias="description")
 
+    class _Annotation:
+        primary_key = "function_id"
+
 class FunctionUpdate(BaseModel):
     function_id: str = Field(..., example="5981", description="Function ID", alias="functionId")
-    period_details: Period = Field(..., alias="periodDetails")
-
-
-# SOAP Schemas for DebtorService Functions
-class FunctionCreate(BaseModel):
-    """Schema for creating a master function via SOAP API."""
-    code: int = Field(..., example=101, description="Function Code", alias="code")
-    description: str = Field(..., example="Software Developer", description="Function Description", alias="description")
-
-    class Config:
-        populate_by_name = True
-
-
-class FunctionDelete(BaseModel):
-    """Schema for deleting a master function via SOAP API."""
-    function_id: int = Field(..., example=12345, description="Function ID to delete", alias="functionId")
-
-    class Config:
-        populate_by_name = True
-
-
-class FunctionMasterUpdate(BaseModel):
-    """Schema for updating a master function via SOAP API."""
-    function_id: int = Field(..., example=12345, description="Function ID", alias="functionId")
-    code: int = Field(..., example=101, description="Function Code", alias="code")
-    description: str = Field(..., example="Senior Software Developer", description="Function Description", alias="description")
-
-    class Config:
-        populate_by_name = True
+    period_details: Period = Field(..., example={"year": 2021, "period": 4}, description="Period details", alias="periodDetails")

brynq_sdk_nmbrs/schemas/hours.py

@@ -76,6 +76,7 @@ class PeriodPost(BaseModel):
     unprotected_mode: Optional[bool] = Field(None, example=False, description="Unprotected Mode", alias="unprotectedMode")
 
 class FixedHoursCreate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     hour_code: int = Field(..., ge=1, example=2100, description="Hour Code", alias="hourCode")
     number_of_hours: float = Field(..., ge=0, le=1000, example=40, description="Hours", alias="hours")
     cost_center_id: Optional[str] = Field(None, example="aa506564-d1db-4fa8-83dc-d68db4cfcd82", description="Cost Center ID", alias="costCenterId")
@@ -86,6 +87,7 @@ class FixedHoursCreate(BaseModel):
     period_details: Optional[PeriodPost] = None
 
 class FixedHoursUpdate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     hour_component_id: str = Field(..., example="ddaae291-47fa-4c67-bb2f-de0e5da9e8a1", description="Hour Component ID", alias="hourComponentId")
     hour_code: Optional[int] = Field(None, ge=1, example=2100, description="Hour Code", alias="hourCode")
     number_of_hours: Optional[float] = Field(None, ge=0, le=1000, example=40, description="Hours", alias="hours")
@@ -97,14 +99,16 @@ class FixedHoursUpdate(BaseModel):
     period_details: Optional[PeriodPost] = None
 
 class VariableHoursCreate(BaseModel):
+    employee_id: str = Field(..., example="3054d4cf-b449-489d-8d2e-5dd30e5ab994", description="Employee identifier", alias="employeeId")
     hour_code: int = Field(..., ge=1, example=2100, description="Hour Code", alias="hourCode")
     number_of_hours: float = Field(..., ge=0, le=1000, example=3.5, description="Hours", alias="hours")
     cost_center_id: Optional[str] = Field(None, example="aa506564-d1db-4fa8-83dc-d68db4cfcd82", description="Cost Center ID", alias="costCenterId")
     cost_unit_id: Optional[str] = Field(None, example="d8ac6afb-2ac6-43bf-9880-2d382cdace43", description="Cost Unit ID", alias="costUnitId")
     comment: Optional[str] = Field(None, example="Shift hours", description="Comment", alias="comment")
-    period_details: Optional[PeriodPost] = Field(None, example="Period details", description="Period details", alias="periodDetails")
+    period_details: Optional[PeriodPost] = Field(None, example={"period": {"year": 2025, "period": 1}, "unprotectedMode": False}, description="Period details", alias="periodDetails")
 
 class VariableHoursUpdate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     hour_component_id: str = Field(..., example="49a69eda-252e-4ccb-a220-38ea90511d4f", description="Hour Component ID", alias="hourComponentId")
     hour_code: Optional[int] = Field(None, ge=1, example=2100, description="Hour Code", alias="hourCode")
     number_of_hours: Optional[float] = Field(None, ge=0, le=1000, example=45.5, description="Hours", alias="hours")

brynq_sdk_nmbrs/schemas/leave.py

@@ -1,12 +1,14 @@
+from datetime import datetime
+from enum import Enum
+from typing import Annotated, Optional
+
 import pandas as pd
 import pandera as pa
-from pandera.typing import Series, String, Float, DateTime
 import pandera.extensions as extensions
-from brynq_sdk_functions import BrynQPanderaDataFrameModel
-from typing import Optional, Annotated
+from pandera.typing import DateTime, Float, Series, String
 from pydantic import BaseModel, Field, StringConstraints
-from enum import Enum
-from datetime import datetime
+
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
 
 class LeaveGet(BrynQPanderaDataFrameModel):
@@ -48,7 +50,6 @@ class LeaveDelete(BaseModel):
 
 class LeaveUpdate(BaseModel):
     """Schema for updating leave via SOAP API."""
-    employee_id: int = Field(..., example=12345, description="Employee ID", alias="employeeId")
     leave_id: int = Field(..., example=67890, description="Leave ID", alias="leaveId")
     start_date: datetime = Field(..., example="2025-01-01T00:00:00", description="Leave Start Date", alias="startDate")
     end_date: datetime = Field(..., example="2025-01-02T00:00:00", description="Leave End Date", alias="endDate")
@@ -62,3 +63,13 @@ class LeaveBalanceGet(BrynQPanderaDataFrameModel):
     employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     leave_group_id: Series[String] = pa.Field(coerce=True, nullable=True, description="Leave Group ID", alias="leaveGroupId")
     balance: Series[Float] = pa.Field(coerce=True, nullable=True, description="Leave Balance", alias="leaveBalance")
+
+    class _Annotation:
+        primary_key = "employee_id"
+        foreign_keys = {
+            "leave_group_id": {
+                "parent_schema": "LeaveGroupGet",
+                "parent_column": "leave_group_id",
+                "cardinality": "N:1"
+            }
+        }

brynq_sdk_nmbrs/schemas/manager.py

@@ -3,9 +3,8 @@ from typing import Optional
 
 import pandas as pd
 import pandera as pa
-import pandera.extensions as extensions
-from pandera.typing import DateTime, Float, Series, String
-from pydantic import BaseModel, Field
+from pandera.typing import Series
+from pydantic import BaseModel, ConfigDict, Field
 
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
@@ -47,25 +46,10 @@ class ManagerBasicGet(BrynQPanderaDataFrameModel):
 class EmployeeManagerGet(BrynQPanderaDataFrameModel):
     employee_id: Series[pa.String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     manager_id: Series[pa.String] = pa.Field(coerce=True, description="Manager ID", alias="managerId")
-    manager_number: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Manager number", alias="number")
     manager_first_name: Series[pa.String] = pa.Field(coerce=True, description="Manager first name", alias="firstName")
     manager_last_name: Series[pa.String] = pa.Field(coerce=True, description="Manager last name", alias="lastName")
-    manager_gender: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager gender", alias="gender")
-    manager_phone_number: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager phone number", alias="phoneNumber")
-    manager_cellphone: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager cellphone", alias="cellphone")
-    manager_fax: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager fax", alias="fax")
     manager_email: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager email", alias="email")
     created_at: Series[datetime] = pa.Field(coerce=True, description="Manager created at", alias="createdAt")
-    period_period: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Period", alias="period.period")
-    period_year: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Year", alias="period.year")
-    manager_department_id: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Department ID", alias="department.departmentId")
-    manager_department_code: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Department Code", alias="department.code")
-    manager_department_description: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Department Description", alias="department.description")
-    manager_department_created_at: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Department Created At", alias="department.createdAt")
-    manager_function_id: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Function ID", alias="function.functionId")
-    manager_function_code: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Function Code", alias="function.code")
-    manager_function_description: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Function Description", alias="function.description")
-    function_created_at: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Function Created At", alias="function.createdAt")
 
     class _Annotation:
         primary_key = "manager_id"
@@ -99,10 +83,13 @@ class ManagerHistoricBasicGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class Period(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
     year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
     period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
 
 class ManagerCreate(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    debtor_id: str = Field(..., description="Debtor identifier", alias="debtorId")
     number: int = Field(..., ge=1, example=1, description="Manager number", alias="number")
     first_name: str = Field(..., max_length=100, example="John", description="Manager first name", alias="firstName")
     last_name: str = Field(..., max_length=100, example="Doe", description="Manager last name", alias="lastName")
@@ -113,12 +100,16 @@ class ManagerCreate(BaseModel):
     email: Optional[str] = Field(None, max_length=100, example="john.doe@company.com", description="Manager email", alias="email")
 
 class ManagerUpdate(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    debtor_id: str = Field(..., example="a1b2c3d4-e5f6-7890-abcd-ef1234567890", description="Debtor identifier", alias="debtorId")
     manager_id: str = Field(..., example="2f6aa11c-504a-49a1-903b-e15e79965702", description="Manager ID", alias="managerId")
-    period_details: Period = Field(..., alias="periodDetails")
+    period_details: Period = Field(..., example={"year": 2021, "period": 4}, description="Period details", alias="periodDetails")
 
 class ManagerDelete(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
     manager_id: str = Field(..., example="2f6aa11c-504a-49a1-903b-e15e79965702", description="Manager ID", alias="managerId")
 
 class UpdateEmployeeManager(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
     manager_id: str = Field(..., example="2f6aa11c-504a-49a1-903b-e15e79965702", description="Manager ID", alias="managerId")
-    period_details: Period = Field(..., alias="periodDetails")
+    period_details: Period = Field(..., example={"year": 2021, "period": 4}, description="Period details", alias="periodDetails")

brynq_sdk_nmbrs/schemas/salary.py

@@ -29,7 +29,8 @@ class SalaryGet(BrynQPanderaDataFrameModel):
             "netParttimeSalaryExclWageComp",
             "netHourlyWageExclWageComp",
             "netHourlyWageInclWageComp",
-            "employerCosts"
+            "employerCosts",
+            "0"
         ],
         description="Salary Type",
         alias="type"
@@ -100,6 +101,9 @@ class SalaryTableGet(BrynQPanderaDataFrameModel):
     guid_salary_table: Series[String] = pa.Field(coerce=True, description="GUID Salary table", alias="GuidSalaryTable")
     company_id: Series[String] = pa.Field(coerce=True, description="Company ID", alias="companyId")
 
+    class _Annotation:
+        primary_key = "guid_salary_table"
+
 class SalaryScalesGet(BrynQPanderaDataFrameModel):
     scale: Series[String] = pa.Field(coerce=True, description="Salary Scale", alias="Scale")
     description: Series[String] = pa.Field(coerce=True, description="Salary Scale Description", alias="SchaalDescription")
@@ -109,9 +113,15 @@ class SalaryScalesGet(BrynQPanderaDataFrameModel):
     guid_salary_table_scale: Series[String] = pa.Field(coerce=True, description="GUID Salary table scale", alias="GuidSalaryTableScale")
     company_id: Series[String] = pa.Field(coerce=True, description="Company ID", alias="companyId")
 
+    class _Annotation:
+        primary_key = "guid_salary_table_scale"
+
 class SalaryStepsGet(BrynQPanderaDataFrameModel):
     step: Series[String] = pa.Field(coerce=True, description="Salary Step", alias="Step")
     step_description: Series[String] = pa.Field(coerce=True, description="Salary Step Description", alias="StepDescription")
     step_value: Series[String] = pa.Field(coerce=True, description="Salary Step Value", alias="StepValue")
     guid_salary_table_step: Series[String] = pa.Field(coerce=True, description="GUID Salary Step table", alias="GuidSalaryTableStep")
     company_id: Series[String] = pa.Field(coerce=True, description="Company ID", alias="companyId")
+
+    class _Annotation:
+        primary_key = "guid_salary_table_step"

brynq_sdk_nmbrs/schemas/schedules.py

@@ -1,11 +1,8 @@
 from datetime import datetime
-from typing import Any, Dict, Optional
+from typing import Optional
 
-import pandas as pd
 import pandera as pa
-import pandera.extensions as extensions
-from pandera import Bool, Int
-from pandera.typing import DateTime, Float, Series, String
+from pandera.typing import Float, Series, String
 from pydantic import BaseModel, Field
 
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
@@ -109,52 +106,3 @@ class ScheduleCreate(BaseModel):
                 }
             }
         }
-
-
-class ScheduleUpdate(BaseModel):
-    """
-    Pydantic model for updating a schedule via SOAP API
-    """
-    employee_id: int = Field(..., example=12345, description="Employee ID", alias="employeeId")
-    start_date: datetime = Field(..., example="2025-01-01T00:00:00", description="Start date of the schedule", alias="startDate")
-    parttime_percentage: float = Field(..., ge=0, le=100, example=100.0, description="Part-time percentage", alias="parttimePercentage")
-    company_rooster_nr: Optional[int] = Field(0, example=0, description="Company Rooster Number (schedule template)", alias="companyRoosterNr")
-    hours_monday: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Monday", alias="hoursMonday")
-    hours_tuesday: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Tuesday", alias="hoursTuesday")
-    hours_wednesday: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Wednesday", alias="hoursWednesday")
-    hours_thursday: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Thursday", alias="hoursThursday")
-    hours_friday: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Friday", alias="hoursFriday")
-    hours_saturday: Optional[float] = Field(0, ge=0, le=24, example=0.0, description="Hours Saturday", alias="hoursSaturday")
-    hours_sunday: Optional[float] = Field(0, ge=0, le=24, example=0.0, description="Hours Sunday", alias="hoursSunday")
-    hours_monday2: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Monday Week 2", alias="hoursMonday2")
-    hours_tuesday2: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Tuesday Week 2", alias="hoursTuesday2")
-    hours_wednesday2: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Wednesday Week 2", alias="hoursWednesday2")
-    hours_thursday2: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Thursday Week 2", alias="hoursThursday2")
-    hours_friday2: Optional[float] = Field(0, ge=0, le=24, example=8.0, description="Hours Friday Week 2", alias="hoursFriday2")
-    hours_saturday2: Optional[float] = Field(0, ge=0, le=24, example=0.0, description="Hours Saturday Week 2", alias="hoursSaturday2")
-    hours_sunday2: Optional[float] = Field(0, ge=0, le=24, example=0.0, description="Hours Sunday Week 2", alias="hoursSunday2")
-
-    def to_soap_schedule(self, soap_client):
-        """Convert to SOAP Schedule object"""
-        ScheduleType = soap_client.get_type('ns0:Schedule')
-        return ScheduleType(
-            StartDate=self.start_date,
-            ParttimePercentage=self.parttime_percentage,
-            HoursMonday=self.hours_monday or 0,
-            HoursTuesday=self.hours_tuesday or 0,
-            HoursWednesday=self.hours_wednesday or 0,
-            HoursThursday=self.hours_thursday or 0,
-            HoursFriday=self.hours_friday or 0,
-            HoursSaturday=self.hours_saturday or 0,
-            HoursSunday=self.hours_sunday or 0,
-            HoursMonday2=self.hours_monday2 or 0,
-            HoursTuesday2=self.hours_tuesday2 or 0,
-            HoursWednesday2=self.hours_wednesday2 or 0,
-            HoursThursday2=self.hours_thursday2 or 0,
-            HoursFriday2=self.hours_friday2 or 0,
-            HoursSaturday2=self.hours_saturday2 or 0,
-            HoursSunday2=self.hours_sunday2 or 0
-        )
-
-    class Config:
-        populate_by_name = True

brynq_sdk_nmbrs/schemas/svw_settings.py

@@ -0,0 +1,116 @@
+from typing import Optional
+
+import pandas as pd
+import pandera as pa
+from pydantic import BaseModel, ConfigDict, Field
+
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+# ---------------------------
+# Get Schemas - Company SVW Settings
+# ---------------------------
+class CompanySVWSettingsGet(BrynQPanderaDataFrameModel):
+    """Schema for validating company SVW settings data."""
+    svw_settings_id: pd.StringDtype = pa.Field(coerce=True, description="SVW Settings ID", alias="SVWSettingsId")
+    own_risk_dif_wga: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="Own risk DIF WGA", alias="ownRiskDifWGA")
+    own_risk_health_care: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="Own risk health care", alias="ownRiskHealthCare")
+    aof: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="AOF (Low/High)", alias="AOF")
+    diff_wga_wn: pd.Float64Dtype = pa.Field(coerce=True, nullable=True, description="Diff WGA Wn", alias="diffWGAWn")
+    diff_wga_wg: pd.Float64Dtype = pa.Field(coerce=True, nullable=True, description="Diff WGA Wg", alias="diffWGAWg")
+    zw_wg: pd.Float64Dtype = pa.Field(coerce=True, nullable=True, description="ZW Wg", alias="zwWg")
+
+    class _Annotation:
+        primary_key = "svw_settings_id"
+
+
+# ---------------------------
+# Get Schemas - Employee SVW Settings
+# ---------------------------
+class EmployeeSVWSettingsGet(BrynQPanderaDataFrameModel):
+    """Schema for validating employee SVW settings data."""
+    employee_id: pd.StringDtype = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    zw: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="ZW (Ziektewet)", alias="ZW")
+    ww: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="WW (Werkloosheidswet)", alias="WW")
+    wao_wia: pd.BooleanDtype = pa.Field(coerce=True, nullable=True, description="WAO/WIA", alias="waoWia")
+    nature_of_employment: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Nature of employment", alias="natureOfEmployment")
+    phase_classification: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Phase classification", alias="phaseClassification")
+    tax_sequence_number: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Tax sequence number", alias="taxSequenceNumber")
+    code_zvw: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Code ZVW", alias="codeZvw")
+    income_related_contribution_zvw: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Income related contribution ZVW", alias="incomeRelatedContributionZvw")
+    influence_obliged_insurance: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Influence obliged insurance", alias="influenceObligedInsurance")
+    wage_cost_benefit_code: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Wage cost benefit code", alias="wageCostBenefit.code")
+    wage_cost_benefit_description: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="Wage cost benefit description", alias="wageCostBenefit.description")
+    wage_cost_benefit_end_period: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Wage cost benefit end period", alias="wageCostBenefit.endPeriod")
+    wage_cost_benefit_end_year: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Wage cost benefit end year", alias="wageCostBenefit.endYear")
+    cao_code: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="CAO code", alias="CAO.code")
+    cao_description: pd.StringDtype = pa.Field(coerce=True, nullable=True, description="CAO description", alias="CAO.CAODescription")
+    hirer_cao_code: Optional[pd.Int64Dtype] = pa.Field(
+        coerce=True,
+        nullable=True,
+        description="Hirer CAO code",
+        alias="hirerCAO.code",
+    )
+    hirer_cao_description: Optional[pd.StringDtype] = pa.Field(
+        coerce=True,
+        nullable=True,
+        description="Hirer CAO description",
+        alias="hirerCAO.CAODescription",
+    )
+    period_year: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Period year", alias="period.year")
+    period_period: pd.Int64Dtype = pa.Field(coerce=True, nullable=True, description="Period", alias="period.period")
+    created_at: str = pa.Field(coerce=True, nullable=True, description="Created at", alias="createdAt")
+
+    class _Annotation:
+        primary_key = "employee_id"
+
+
+# ---------------------------
+# Create/Update Schemas
+# ---------------------------
+class Period(BaseModel):
+    """Period model for specifying year and period."""
+    model_config = ConfigDict(populate_by_name=True)
+
+    period_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+
+
+class WageCostBenefit(BaseModel):
+    """Wage cost benefit model."""
+    model_config = ConfigDict(populate_by_name=True)
+
+    code: Optional[int] = Field(None, example=1234, description="Wage cost benefit code", alias="code")
+    end_period: Optional[int] = Field(None, ge=1, le=53, example=12, description="End period", alias="endPeriod")
+    end_year: Optional[int] = Field(None, ge=1900, le=2100, example=2025, description="End year", alias="endYear")
+
+
+class SVWSettingsCreate(BaseModel):
+    """Schema for creating employee SVW settings."""
+    model_config = ConfigDict(populate_by_name=True)
+
+    zw: Optional[bool] = Field(None, example=True, description="ZW (Ziektewet)", alias="ZW")
+    ww: Optional[bool] = Field(None, example=True, description="WW (Werkloosheidswet)", alias="WW")
+    wao_wia: Optional[bool] = Field(None, example=True, description="WAO/WIA", alias="waoWia")
+    nature_of_employment: int = Field(..., example=1, description="Nature of employment code (1, 4, 6, 7, 11, 18, 21, 22, 23, 24, 79, 81, 82, 83)", alias="natureOfEmployment")
+    phase_classification: Optional[int] = Field(None, example=1, description="Phase classification (only for nature of employment 11)", alias="phaseClassification")
+    code_zvw: str = Field(
+        ...,
+        pattern=r'^[ABGHIKLMN]$',
+        example="A",
+        description="Code ZVW (A, B, G, H, I, K, L, M, N)",
+        alias="codeZvw",
+    )
+    tax_sequence_number: int = Field(..., ge=0, example=0, description="Tax sequence number", alias="taxSequenceNumber")
+    income_related_contribution_zvw: int = Field(..., ge=0, example=0, description="Income related contribution ZVW", alias="incomeRelatedContributionZvw")
+    influence_obliged_insurance: str = Field(
+        ...,
+        pattern=r'^[0ABDE]$',
+        example="0",
+        description="Influence obliged insurance (0, A, B, D, E)",
+        alias="influenceObligedInsurance",
+    )
+    wage_cost_benefit: Optional[WageCostBenefit] = Field(None, example={"code": 1234, "endPeriod": 12, "endYear": 2025}, description="Wage cost benefit", alias="wageCostBenefit")
+    cao: Optional[int] = Field(None, example=100, description="CAO code", alias="CAO")
+    hirer_cao: Optional[int] = Field(None, example=100, description="Hirer CAO code", alias="hirerCAO")
+    period: Period = Field(..., example={"year": 2021, "period": 4}, description="Period to apply settings")