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

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")

brynq_sdk_nmbrs/schemas/wage_tax.py

@@ -1,17 +1,36 @@
-import math
 from datetime import datetime
-from typing import Annotated, Optional, Union
+from typing import Optional
 
 import pandas as pd
 import pandera as pa
-import pandera.extensions as extensions
 from pandera import Bool
-from pandera.typing import DateTime, Float, Series, String
-from pydantic import BaseModel, Field, StringConstraints
+from pandera.typing import DateTime, Series, String
+from pydantic import BaseModel, Field
 
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
 
+# ---------------------------
+# REST API Schema - Company Wage Tax Declarations
+# ---------------------------
+class CompanyWageTaxGet(BrynQPanderaDataFrameModel):
+    """Schema for validating company wage tax data from REST API."""
+    wage_tax_id: Series[String] = pa.Field(coerce=True, description="Wage Tax ID", alias="wageTaxId")
+    serial_number: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Serial Number", alias="serialNumber")
+    total_general: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Total General", alias="totalGeneral")
+    payment_reference: Series[String] = pa.Field(coerce=True, nullable=True, description="Payment Reference", alias="paymentReference")
+    period: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Period", alias="period")
+    year: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Year", alias="year")
+    status: Series[String] = pa.Field(coerce=True, nullable=True, description="Status", alias="status")
+    sent_at: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Sent At", alias="sentAt")
+    period_start: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Period Start", alias="periodStart")
+    period_end: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Period End", alias="periodEnd")
+    correction_period_start: Series[DateTime] = pa.Field(nullable=True, coerce=True, description="Correction Period Start", alias="correctionPeriodStart")
+    correction_period_end: Series[DateTime] = pa.Field(nullable=True, coerce=True, description="Correction Period End", alias="correctionPeriodEnd")
+
+    class _Annotation:
+        primary_key = "wage_tax_id"
+
 # ---------------------------
 # REST API Get Schema (Wage Tax Settings History)
 # ---------------------------
@@ -70,7 +89,7 @@ class WageTaxSettingsCreate(BaseModel):
 # ---------------------------
 # SOAP API Get Schema (Company Wage Tax List)
 # ---------------------------
-class CompanyWageTaxGet(BrynQPanderaDataFrameModel):
+class CompanyWageTaxGetSOAP(BrynQPanderaDataFrameModel):
     wagetax_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Loonaangifte ID", alias="LoonaangifteID")
     serial_number: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Serial Number", alias="SerialNumber")
     payment_reference: Series[String] = pa.Field(coerce=True, description="Payment Reference", alias="PaymentReference")
@@ -84,6 +103,9 @@ class CompanyWageTaxGet(BrynQPanderaDataFrameModel):
     correction_period_start: Series[DateTime] = pa.Field(nullable=True, coerce=True, description="Correction Tijdvak Start", alias="CorrectionTijdvakStart")
     correction_period_end: Series[DateTime] = pa.Field(nullable=True, coerce=True, description="Correction Tijdvak End", alias="CorrectionTijdvakEnd")
 
+    class _Annotation:
+        primary_key = "wagetax_id"
+
 # <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 #    <soap:Body>
 #       <WageTax_GetListResponse xmlns="https://api.nmbrs.nl/soap/v3/EmployeeService">
@@ -126,22 +148,32 @@ class WageTaxGet(BrynQPanderaDataFrameModel):
     holiday_vouchers: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Vakantie Bonnen", alias="VakantieBonnen")
     code_calculate_30_percent_rule: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Code Calc 30% Rule", alias="CodeCalc30PercRule")
 
+    class _Annotation:
+        primary_key = "wage_tax_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "N:1"
+            }
+        }
+
 class WageTaxUpdate(BaseModel):
-    employee_id: Optional[int] = Field(None, example="1234567890", description="Employee ID", alias="EmployeeId")
-    wage_tax_id: Optional[int] = Field(None, example="1234567890", description="Wage Tax Settings ID", alias="Id")
-    yearly_salary: Optional[float] = Field(None, example="1234567890", description="Yearly Salary", alias="JaarloonBT")
-    deviation_special_rate_payroll_tax_deduction: Optional[float] = Field(None, example="1234567890", description="Afw Bijz Tarief LH", alias="AfwBijzTariefLH")
-    auto_small_jobs: Optional[bool] = Field(None, example="1234567890", description="Auto Kleine Banen Regeling", alias="AutoKleineBanenRegeling")
-    payroll_tax_deduction: Optional[bool] = Field(None, example="1234567890", description="Loonheffingkorting", alias="Loonheffingkorting")
-    benefit_scheme: Optional[bool] = Field(None, example="1234567890", description="Voordeelreg", alias="Voordeelreg")
-    payroll_tax: Optional[bool] = Field(None, example="1234567890", description="Loonheffing", alias="Loonheffing")
-    code_tax_reduction: Optional[int] = Field(None, example="1234567890", description="Code Afdrachtvermindering", alias="CodeAfdrachtvermindering")
-    color_table: Optional[int] = Field(None, example="1234567890", description="Kleur Tabel", alias="KleurTabel")
-    type_of_income: Optional[int] = Field(None, example="1234567890", description="Soort Inkomen", alias="SoortInkomen")
-    special_table: Optional[int] = Field(None, example="1234567890", description="Speciale Tabel", alias="SpecialeTabel")
-    period_table: Optional[int] = Field(None, example="1234567890", description="Tijdvak Tabel", alias="TijdvakTabel")
-    holiday_vouchers: Optional[int] = Field(None, example="1234567890", description="Vakantie Bonnen", alias="VakantieBonnen")
-    code_calculate_30_percent_rule: Optional[int] = Field(None, example="1234567890", description="Code Calc 30% Rule", alias="CodeCalc30PercRule")
+    employee_id: Optional[int] = Field(None, example=1234567890, description="Employee ID", alias="EmployeeId")
+    wage_tax_id: Optional[int] = Field(None, example=2998190, description="Wage Tax Settings ID", alias="Id")
+    yearly_salary: Optional[float] = Field(None, example=12144.00, description="Yearly Salary", alias="JaarloonBT")
+    deviation_special_rate_payroll_tax_deduction: Optional[float] = Field(None, example=0, description="Afw Bijz Tarief LH", alias="AfwBijzTariefLH")
+    auto_small_jobs: Optional[bool] = Field(None, example=True, description="Auto Kleine Banen Regeling", alias="AutoKleineBanenRegeling")
+    payroll_tax_deduction: Optional[bool] = Field(None, example=True, description="Loonheffingkorting", alias="Loonheffingkorting")
+    benefit_scheme: Optional[bool] = Field(None, example=True, description="Voordeelreg", alias="Voordeelreg")
+    payroll_tax: Optional[bool] = Field(None, example=True, description="Loonheffing", alias="Loonheffing")
+    code_tax_reduction: Optional[int] = Field(None, example=0, description="Code Afdrachtvermindering", alias="CodeAfdrachtvermindering")
+    color_table: Optional[int] = Field(None, example=1, description="Kleur Tabel", alias="KleurTabel")
+    type_of_income: Optional[int] = Field(None, example=15, description="Soort Inkomen", alias="SoortInkomen")
+    special_table: Optional[int] = Field(None, example=0, description="Speciale Tabel", alias="SpecialeTabel")
+    period_table: Optional[int] = Field(None, example=2, description="Tijdvak Tabel", alias="TijdvakTabel")
+    holiday_vouchers: Optional[int] = Field(None, example=0, description="Vakantie Bonnen", alias="VakantieBonnen")
+    code_calculate_30_percent_rule: Optional[int] = Field(None, example=0, description="Code Calc 30% Rule", alias="CodeCalc30PercRule")
 
     def to_soap_settings(self, soap_client):
         """Convert to SOAP WageTaxSettings object"""

brynq_sdk_nmbrs/schemas/wagecomponents.py

@@ -1,4 +1,3 @@
-import math
 from typing import Optional
 
 import pandas as pd
@@ -7,8 +6,6 @@ from pandera.typing import Float, Series, String
 from pydantic import (
     BaseModel,
     Field,
-    confloat,
-    conint,
     field_validator,
     model_serializer,
 )
@@ -69,12 +66,12 @@ class VariableWageComponentGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class PeriodPost(BaseModel):
-    period_details_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
-    period_details_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+    period_details_year: Optional[int] = Field(None, ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_details_period: Optional[int] = Field(None, ge=1, le=53, example=4, description="Period", alias="period")
 
 class FixedWageComponentCreate(BaseModel):
     code: int = Field(..., ge=1, example=1100, description="Wage Component Code", alias="code")
-    value: float = Field(..., ge=0, example=500, description="Wage Component Value", alias="value")
+    value: float = Field(..., example=500, description="Wage Component Value", alias="value")
     end_year: Optional[int] = Field(None, ge=1900, le=2100, example=2023, description="End Year", alias="endYear")
     end_period: Optional[int] = Field(None, ge=1, le=53, example=6, description="End Period", alias="endPeriod")
     comment: Optional[str] = Field(None, example="some comment", description="Comment", alias="comment")
@@ -113,7 +110,7 @@ class FixedWageComponentCreate(BaseModel):
 class FixedWageComponentUpdate(BaseModel):
     fixed_wage_component_id: str = Field(..., example="643c6b90-57c6-4199-9e4e-ded553572d78", description="Fixed Wage Component ID", alias="fixedWageComponentId")
     code: Optional[int] = Field(None, ge=1, example=1100, description="Wage Component Code", alias="code")
-    value: Optional[float] = Field(None, ge=0, example=500, description="Wage Component Value", alias="value")
+    value: Optional[float] = Field(None, example=500, description="Wage Component Value", alias="value")
     end_year: Optional[int] = Field(None, ge=1900, le=2100, example=2023, description="End Year", alias="endYear")
     end_period: Optional[int] = Field(None, ge=1, le=53, example=6, description="End Period", alias="endPeriod")
     comment: Optional[str] = Field(None, example="string", description="Comment", alias="comment")
@@ -124,7 +121,7 @@ class FixedWageComponentUpdate(BaseModel):
 
 class VariableWageComponentCreate(BaseModel):
     code: int = Field(..., ge=1, example=3045, description="Wage Component Code", alias="code")
-    value: float = Field(..., ge=0, example=200, description="Wage Component Value", alias="value")
+    value: float = Field(..., example=200, description="Wage Component Value", alias="value")
     comment: Optional[str] = Field(None, example="comment", description="Comment", alias="comment")
     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")
@@ -153,7 +150,7 @@ class VariableWageComponentCreate(BaseModel):
 class VariableWageComponentUpdate(BaseModel):
     variable_wage_component_id: str = Field(..., example="7fc59095-daed-4746-a7f8-a454e38e3683", description="Variable Wage Component ID", alias="variableWageComponentId")
     code: Optional[int] = Field(None, ge=1, example=3045, description="Wage Component Code", alias="code")
-    value: Optional[float] = Field(None, ge=0, example=2200, description="Wage Component Value", alias="value")
+    value: Optional[float] = Field(None, example=2200, description="Wage Component Value", alias="value")
     comment: Optional[str] = Field(None, example="comment", description="Comment", alias="comment")
     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")

brynq_sdk_nmbrs/svw_settings.py

@@ -0,0 +1,213 @@
+from typing import Any, Dict, Optional
+
+import pandas as pd
+import requests
+
+from brynq_sdk_functions import Functions
+
+from .schemas.svw_settings import (
+    CompanySVWSettingsGet,
+    EmployeeSVWSettingsGet,
+    SVWSettingsCreate,
+)
+
+
+class CompanySVWSettings:
+    """
+    Class for handling company-level SVW (Social Insurance) settings.
+
+    Endpoints:
+        - GET /api/companies/{companyId}/svwsettings
+    """
+
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            company_id: Optional[str] = None,
+            year: Optional[int] = None,
+            period: Optional[int] = None,
+            created_from: Optional[str] = None) -> tuple:
+        """
+        Get company SVW settings (SVW table).
+
+        Args:
+            company_id: Optional company ID. If not provided, fetches for all companies.
+            year: Optional year filter
+            period: Optional period filter
+            created_from: Optional datetime filter for records created after this date
+
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        if company_id:
+            df = self._get(company_id, year, period, created_from)
+        else:
+            df = pd.DataFrame()
+            for company in self.nmbrs.company_ids:
+                df = pd.concat([df, self._get(company, year, period, created_from)])
+
+        if df.empty:
+            return df, pd.DataFrame()
+
+        valid_data, invalid_data = Functions.validate_data(df=df, schema=CompanySVWSettingsGet, debug=self.nmbrs.debug)
+        return valid_data, invalid_data
+
+    def _get(self,
+             company_id: str,
+             year: Optional[int] = None,
+             period: Optional[int] = None,
+             created_from: Optional[str] = None) -> pd.DataFrame:
+        """
+        Internal method to get SVW settings for a single company.
+        """
+        params = {}
+        if year is not None:
+            params['year'] = year
+        if period is not None:
+            params['period'] = period
+        if created_from is not None:
+            params['createdFrom'] = created_from
+
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}companies/{company_id}/svwsettings",
+            params=params
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+        df = pd.DataFrame(data)
+
+        if not df.empty:
+            df['companyId'] = company_id
+
+        return df
+
+
+class EmployeeSVWSettings:
+    """
+    Class for handling employee-level SVW (Social Insurance) settings.
+
+    Endpoints:
+        - GET /api/companies/{companyId}/employees/svwsettings
+        - POST /api/employees/{employeeId}/SVWSettings
+    """
+
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            company_id: Optional[str] = None,
+            employee_id: Optional[str] = None,
+            created_from: Optional[str] = None) -> tuple:
+        """
+        Get SVW settings history for employees of a company.
+
+        Args:
+            company_id: Optional company ID. If not provided, fetches for all companies.
+            employee_id: Optional employee ID filter
+            created_from: Optional datetime filter for records created after this date
+
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        if company_id:
+            df = self._get(company_id, employee_id, created_from)
+        else:
+            df = pd.DataFrame()
+            for company in self.nmbrs.company_ids:
+                df = pd.concat([df, self._get(company, employee_id, created_from)])
+
+        if df.empty:
+            return df, pd.DataFrame()
+
+        valid_data, invalid_data = Functions.validate_data(df=df, schema=EmployeeSVWSettingsGet, debug=self.nmbrs.debug)
+        return valid_data, invalid_data
+
+    def _get(self,
+             company_id: str,
+             employee_id: Optional[str] = None,
+             created_from: Optional[str] = None) -> pd.DataFrame:
+        """
+        Internal method to get employee SVW settings for a single company.
+        """
+        params = {}
+        if employee_id is not None:
+            params['employeeId'] = employee_id
+        if created_from is not None:
+            params['createdFrom'] = created_from
+
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}companies/{company_id}/employees/svwsettings",
+            params=params
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+
+        # Normalize nested data structure without meta key conflicts
+        records = []
+        for item in data:
+            parent_employee_id = item.get("employeeId")
+            for record in item.get("employeeSVWSettings", []) or []:
+                if "employeeId" not in record:
+                    record["employeeId"] = parent_employee_id
+                records.append(record)
+        df = pd.json_normalize(records)
+        if 'hirerCAO' in df.columns:
+            hirer_cao_df = pd.json_normalize(df['hirerCAO']).add_prefix('hirerCAO.')
+            if not hirer_cao_df.empty:
+                hirer_cao_df = hirer_cao_df.reindex(df.index)
+                df = pd.concat([df.drop(columns=['hirerCAO']), hirer_cao_df], axis=1)
+            else:
+                df = df.drop(columns=['hirerCAO'])
+
+        if not df.empty:
+            df['companyId'] = company_id
+
+        return df
+
+    def create(self, employee_id: str, data: Dict[str, Any]):
+        """
+        Create SVW settings for a specific employee.
+
+        A new SVW settings entry will be created in Nmbrs, starting from the
+        applied start period.
+
+        Args:
+            employee_id: The ID of the employee
+            data: Dictionary containing SVW settings data matching SVWSettingsCreate schema:
+                - ZW: bool (optional) - Ziektewet
+                - WW: bool (optional) - Werkloosheidswet
+                - waoWia: bool (optional) - WAO/WIA
+                - natureOfEmployment: int (required) - Nature of employment code
+                - phaseClassification: int (optional) - Phase classification
+                - codeZvw: str (required) - Code ZVW (A, B, G, H)
+                - taxSequenceNumber: int (required)
+                - incomeRelatedContributionZvw: int (required)
+                - influenceObligedInsurance: int (required)
+                - wageCostBenefit: dict (optional)
+                - CAO: int (optional)
+                - hirerCAO: int (optional)
+                - period: dict (required) with year and period
+
+        Returns:
+            Response from the API or validated model in mock mode
+        """
+        # Validate with Pydantic model
+        nested_data = self.nmbrs.flat_dict_to_nested_dict(data, SVWSettingsCreate)
+        svw_model = SVWSettingsCreate(**nested_data)
+
+        if self.nmbrs.mock_mode:
+            return svw_model
+
+        # Convert validated model to dict for API payload
+        payload = svw_model.model_dump(exclude_none=True, by_alias=True)
+
+        # Send request
+        resp = self.nmbrs.session.post(
+            url=f"{self.nmbrs.base_url}employees/{employee_id}/SVWSettings",
+            json=payload,
+            timeout=self.nmbrs.timeout
+        )
+        return resp

brynq_sdk_nmbrs/wage_tax.py

@@ -1,16 +1,128 @@
-from typing import Any, Dict, List, Union, Tuple
+from typing import Any, Dict, Optional, Tuple
+
 import pandas as pd
 import requests
-from .schemas.wage_tax import (
-    WageTaxGet, WageTaxUpdate, CompanyWageTaxGet,
-    WageTaxSettingsGet, WageTaxSettingsCreate
-)
 from zeep.exceptions import Fault
-from zeep.ns import WSDL, SOAP_ENV_11
-from zeep.xsd import ComplexType, Element, String
 from zeep.helpers import serialize_object
+
 from brynq_sdk_functions import Functions
 
+from .schemas.wage_tax import (
+    CompanyWageTaxGet,
+    CompanyWageTaxGetSOAP,
+    WageTaxGet,
+    WageTaxSettingsCreate,
+    WageTaxSettingsGet,
+    WageTaxUpdate,
+)
+
+
+class CompanyWageTax:
+    """
+    Class for handling company-level wage tax data via REST API.
+
+    Endpoints:
+        - GET /api/companies/{companyId}/wagetaxes
+        - GET /api/companies/{companyId}/wagetaxes/{wageTaxId}/xml
+        - GET /api/companies/{companyId}/wagetaxes/{wageTaxId}/sepa
+    """
+
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            company_id: Optional[str] = None,
+            year: Optional[int] = None) -> tuple:
+        """
+        Get wage tax declarations for a company.
+
+        Args:
+            company_id: Optional company ID. If not provided, fetches for all companies.
+            year: Optional year filter. If not provided, returns current year.
+
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        if company_id:
+            df = self._get(company_id, year)
+        else:
+            df = pd.DataFrame()
+            for company in self.nmbrs.company_ids:
+                df = pd.concat([df, self._get(company, year)])
+
+        if df.empty:
+            return df, pd.DataFrame()
+
+        valid_data, invalid_data = Functions.validate_data(df=df, schema=CompanyWageTaxGet, debug=True)
+        return valid_data, invalid_data
+
+    def _get(self,
+             company_id: str,
+             year: Optional[int] = None) -> pd.DataFrame:
+        """
+        Internal method to get wage tax declarations for a single company.
+        """
+        params = {}
+        if year is not None:
+            params['year'] = year
+
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}companies/{company_id}/wagetaxes",
+            params=params
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+        df = pd.DataFrame(data)
+
+        if not df.empty:
+            df['companyId'] = company_id
+
+        return df
+
+    def get_xml(self, company_id: str, wage_tax_id: str):
+        """
+        Get the XML file of a wage tax declaration.
+
+        Args:
+            company_id: The ID of the company
+            wage_tax_id: The ID of the wage tax declaration
+
+        Returns:
+            Response containing the task ID for retrieving the XML file
+        """
+        resp = self.nmbrs.session.get(
+            url=f"{self.nmbrs.base_url}companies/{company_id}/wagetaxes/{wage_tax_id}/xml",
+            timeout=self.nmbrs.timeout
+        )
+        resp.raise_for_status()
+        return resp.json()
+
+    def get_sepa(self, company_id: str, wage_tax_id: str, year: int, payment_date: Optional[str] = None):
+        """
+        Get the SEPA (payment file) of a wage tax declaration.
+
+        Args:
+            company_id: The ID of the company
+            wage_tax_id: The ID of the wage tax declaration
+            year: The year of the search (required)
+            payment_date: Optional payment date to be added to the payment file (ISO format)
+
+        Returns:
+            Response containing the task ID for retrieving the SEPA file
+        """
+        params = {'year': year}
+        if payment_date is not None:
+            params['paymentDate'] = payment_date
+
+        resp = self.nmbrs.session.get(
+            url=f"{self.nmbrs.base_url}companies/{company_id}/wagetaxes/{wage_tax_id}/sepa",
+            params=params,
+            timeout=self.nmbrs.timeout
+        )
+        resp.raise_for_status()
+        return resp.json()
+
 
 class WageTaxSettings:
     """Wage Tax Settings History - uses REST API."""
@@ -134,7 +246,7 @@ class WageTax:
                 wagetax_settings_temp['companyId'] = company['number']
                 wagetax_settings = pd.concat([wagetax_settings, wagetax_settings_temp])
 
-        valid_wagetax_settings, invalid_wagetax_settings = Functions.validate_data(df=wagetax_settings, schema=CompanyWageTaxGet, debug=True)
+        valid_wagetax_settings, invalid_wagetax_settings = Functions.validate_data(df=wagetax_settings, schema=CompanyWageTaxGetSOAP, debug=True)
 
         # No validation schema for now, but could be added later
         return valid_wagetax_settings, invalid_wagetax_settings
@@ -230,9 +342,6 @@ class WageTax:
             if self.nmbrs.mock_mode:
                 return wage_tax_model
 
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header_employees()
-
             # Use the model's built-in SOAP conversion method
             wage_tax_settings = wage_tax_model.to_soap_settings(self.nmbrs.soap_client_employees)
 

{brynq_sdk_nmbrs-2.3.3.dev0.dist-info → brynq_sdk_nmbrs-2.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brynq_sdk_nmbrs
-Version: 2.3.3.dev0
+Version: 2.4.5
 Summary: Nmbrs wrapper from BrynQ
 Author: BrynQ
 Author-email: support@brynq.com