brynq-sdk-nmbrs 2.3.0__tar.gz → 2.3.1.dev0__tar.gz

brynq_sdk_nmbrs-2.3.1.dev0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: brynq_sdk_nmbrs
+Version: 2.3.1.dev0
+Summary: Nmbrs wrapper from BrynQ
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Requires-Dist: brynq-sdk-brynq<5,>=4
+Requires-Dist: pandas<3.0.0,>=2.2.0
+Requires-Dist: pydantic<3.0.0,>=2.5.0
+Requires-Dist: pandera<1.0.0,>=0.16.0
+Requires-Dist: zeep<5.0.0,>=4.0.0
+Requires-Dist: brynq-sdk-functions>=2.0.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+Nmbrs wrapper from BrynQ

{brynq_sdk_nmbrs-2.3.0 → brynq_sdk_nmbrs-2.3.1.dev0}/brynq_sdk_nmbrs/__init__.py

@@ -1,34 +1,38 @@
-import warnings
-from typing import Union, List, Literal, Optional, get_args, get_origin
+import os
 import re
+import warnings
+from typing import List, Literal, Optional, Union, get_args, get_origin
+
 import pandas as pd
-from pydantic import BaseModel
 import requests
+from pydantic import BaseModel
+from zeep import Client, Settings
+
 from brynq_sdk_brynq import BrynQ
+
 from .absence import Absence
-from .wage_tax import WageTax
 from .address import Address
 from .bank import Bank
-from zeep import Client, Settings
 from .children import Children
 from .companies import Companies
-from .debtors import Debtors
 from .contract import Contract
-from .costcenter import EmployeeCostcenter, Costcenter
+from .costcenter import Costcenter, EmployeeCostcenter
 from .costunit import Costunit
-from .department import EmployeeDepartment
+from .days import FixedDays, VariableDays
+from .debtors import Debtors
+from .department import Departments, EmployeeDepartment
 from .document import Payslip
+from .employee_wage_tax_settings import EmployeeWageTaxSettings
 from .employees import Employees
-from .salary_tables import SalaryTables, SalaryScales, SalarySteps
 from .employment import Employment
-from .function import EmployeeFunction
-from .hours import VariableHours, FixedHours
-from .days import VariableDays, FixedDays
+from .function import EmployeeFunction, Functions
+from .hours import FixedHours, VariableHours
 from .manager import EmployeeManager, Manager
 from .salaries import Salaries
+from .salary_tables import SalaryScales, SalarySteps, SalaryTables
 from .schedules import Schedule
+from .wage_tax import WageTax
 from .wagecomponents import EmployeeFixedWageComponents, EmployeeVariableWageComponents
-import os
 
 
 class Nmbrs(BrynQ):
@@ -67,10 +71,14 @@ class Nmbrs(BrynQ):
                 'https://api.nmbrs.nl/soap/v3/EmployeeService.asmx?wsdl',
                 settings=self.soap_settings
             )
-            self.soap_auth_header = self._get_soap_auth_header()
+            self.soap_auth_header = self._get_soap_auth_header_companies()
+            self.soap_auth_header_employees = self._get_soap_auth_header_employees()
             # Following methods can only be used if the SOAP authentication header is set (optional, this is not always in scope for all integrations)
             if self.soap_auth_header is not None:
+                self.companies = Companies(self)
+                self.employees = Employees(self)
                 self.soap_company_ids = self.companies.get_soap_ids()
+                self.soap_employee_ids = self.employees.get_soap_ids()
                 self.salary_tables = SalaryTables(self)
                 self.salary_scales = SalaryScales(self)
                 self.salary_steps = SalarySteps(self)
@@ -84,13 +92,15 @@ class Nmbrs(BrynQ):
         self.debtor = Debtors(self)
         self.companies = Companies(self)
         self.contract = Contract(self)
-        self.department = EmployeeDepartment(self)
+        self.employee_department = EmployeeDepartment(self)
+        self.department = Departments(self)
         debtors, _ = self.debtor.get()
         self.debtor_ids = debtors['debtor_id'].to_list()
         self.company_ids = self.companies.get()['companyId'].to_list()
         self.employees = Employees(self)
         self.employment = Employment(self)
-        self.function = EmployeeFunction(self)
+        self.employee_function = EmployeeFunction(self)
+        self.functions = Functions(self)
         self.fixed_hours = FixedHours(self)
         self.fixed_days = FixedDays(self)
         self.variable_hours = VariableHours(self)
@@ -99,6 +109,10 @@ class Nmbrs(BrynQ):
         self.employee_manager = EmployeeManager(self)
         self.salaries = Salaries(self)
         self.schedule = Schedule(self)
+        self.cost_center = Costcenter(self)
+        self.employee_cost_center = EmployeeCostcenter(self)
+        self.cost_unit = Costunit(self)
+        self.employee_wage_tax_settings = EmployeeWageTaxSettings(self)
         self.fixed_wagecomponents = EmployeeFixedWageComponents(self)
         self.variable_wagecomponents = EmployeeVariableWageComponents(self)
         self.current_period = self.companies.get_current_period()
@@ -114,7 +128,7 @@ class Nmbrs(BrynQ):
 
         return headers
 
-    def _get_soap_auth_header(self):
+    def _get_soap_auth_header_companies(self):
         """
         Creates the SOAP authentication header using credentials from initial_credentials.
 
@@ -146,17 +160,17 @@ class Nmbrs(BrynQ):
         Returns:
             AuthHeaderWithDomainType: The authentication header for SOAP requests
         """
-        initial_credentials = self.get_system_credential(system='nmbrs', label='bob')
-        config = initial_credentials.get("config", {})
+        initial_credentials = self.interfaces.credentials.get(system='nmbrs', system_type=self.system_type)
+        custom_data = initial_credentials.get("custom_data", {})
 
         # Get the AuthHeaderWithDomain type from the WSDL
         AuthHeaderWithDomainType = self.soap_client_employees.get_element('ns0:AuthHeaderWithDomain')
 
         # Create the auth header using credentials from config
         auth_header = AuthHeaderWithDomainType(
-            Username=config.get("soap_api_username"),
-            Token=config.get("soap_api_token"),
-            Domain=config.get("soap_api_domain")
+            Username=custom_data.get("soap_api_username"),
+            Token=custom_data.get("soap_api_token"),
+            Domain=custom_data.get("soap_api_domain")
         )
 
         return auth_header

{brynq_sdk_nmbrs-2.3.0 → brynq_sdk_nmbrs-2.3.1.dev0}/brynq_sdk_nmbrs/costcenter.py

@@ -1,13 +1,20 @@
+from typing import TYPE_CHECKING, Any, Dict
+
 import pandas as pd
 import requests
-from dateutil.utils import today
-from requests import HTTPError
-from typing import Dict, Any, TYPE_CHECKING
 
 from brynq_sdk_functions import Functions
-from .schemas.costcenter import CostcenterGet, EmployeeCostcenterGet
-from .schemas.costcenter import EmployeeCostcenterUpdate, EmployeeCostcenterDelete
-from .schemas.costcenter import CostcenterCreate, CostcenterUpdate, CostcenterDelete
+
+from .schemas.costcenter import (
+    CostcenterCreate,
+    CostcenterGet,
+    CostCentersResponse,
+    CostcenterUpdate,
+    EmployeeCostcenterGet,
+    EmployeeCostCentersResponse,
+    EmployeeCostcenterUpdate,
+)
+
 if TYPE_CHECKING:
     from brynq_sdk_nmbrs import Nmbrs
 
@@ -40,12 +47,40 @@ class EmployeeCostcenter:
                                    url=f"{self.nmbrs.base_url}companies/{company_id}/employees/costcenters",
                                    params=params)
         data = self.nmbrs.get_paginated_result(request)
+
+        # Parse and validate API response using Pydantic models
+        if not data:
+            return pd.DataFrame()
+
+        # Validate response structure with Pydantic
+        response = EmployeeCostCentersResponse(data=data)
+
+        # Serialize models to dicts using model_dump with by_alias=True
+        serialized_data = [item.model_dump(by_alias=True, mode='json') for item in response.data]
+
+        # Use json_normalize to flatten nested structure efficiently
         df = pd.json_normalize(
-            data,
+            serialized_data,
             record_path='employeeCostCenters',
             meta=['employeeId']
         )
 
+        # Flatten nested costUnits object if it exists
+        if 'costUnits' in df.columns:
+            # Check if costUnits contains dict-like objects
+            cost_units_dicts = df['costUnits'].dropna()
+            if not cost_units_dicts.empty and isinstance(cost_units_dicts.iloc[0], dict):
+                cost_units_expanded = pd.json_normalize(cost_units_dicts)
+                cost_units_expanded.columns = [f'costUnits.{col}' for col in cost_units_expanded.columns]
+                # Reindex to match original DataFrame index and fill missing values with None
+                cost_units_expanded = cost_units_expanded.reindex(df.index)
+                df = pd.concat([df.drop(columns=['costUnits']), cost_units_expanded], axis=1)
+            else:
+                # If costUnits is not dict-like or all None, create columns with None
+                for col in ['costUnits.costUnitId', 'costUnits.code', 'costUnits.description']:
+                    df[col] = None
+                df = df.drop(columns=['costUnits'])
+
         return df
 
     def update(self, employee_id: str, data: Dict[str, Any]):
@@ -101,7 +136,17 @@ class Costcenter:
         request = requests.Request(method='GET',
                                    url=f"{self.nmbrs.base_url}companies/{company_id}/costcenters")
         data = self.nmbrs.get_paginated_result(request)
-        df = pd.DataFrame(data)
+
+        # Parse and validate API response using Pydantic models
+        if not data:
+            return pd.DataFrame()
+
+        # Validate response structure with Pydantic
+        response = CostCentersResponse(data=data)
+
+        # Serialize models to dicts and convert to DataFrame efficiently
+        serialized_data = [item.model_dump(by_alias=True, mode='json') for item in response.data]
+        df = pd.DataFrame(serialized_data)
 
         return df
 

{brynq_sdk_nmbrs-2.3.0 → brynq_sdk_nmbrs-2.3.1.dev0}/brynq_sdk_nmbrs/costunit.py

@@ -1,9 +1,16 @@
+from typing import Any, Dict
+
 import pandas as pd
 import requests
-from typing import Dict, Any
 
 from brynq_sdk_functions import Functions
-from .schemas.costunit import CostunitGet, CostunitCreate, CostunitUpdate, CostunitDelete
+
+from .schemas.costunit import (
+    CostunitCreate,
+    CostunitDelete,
+    CostunitGet,
+    CostunitUpdate,
+)
 
 
 class Costunit:
@@ -13,7 +20,9 @@ class Costunit:
     def get(self) -> tuple[pd.DataFrame, pd.DataFrame]:
         costunits = pd.DataFrame()
         for company in self.nmbrs.company_ids:
-            costunits = pd.concat([costunits, self._get(company)])
+            company_costunits = self._get(company)
+            if not company_costunits.empty:
+                costunits = pd.concat([costunits, company_costunits])
 
         valid_costunits, invalid_costunits = Functions.validate_data(df=costunits, schema=CostunitGet, debug=True)
 
@@ -22,9 +31,12 @@ class Costunit:
     def _get(self,
             company_id: str):
         request = requests.Request(method='GET',
-                                   url=f"{self.nmbrs.base_url}companies/{company_id}/costunits")
+                                   url=f"{self.nmbrs.base_url}companies/{company_id}/costUnits")
 
         data = self.nmbrs.get_paginated_result(request)
+        if not data:
+            return pd.DataFrame()
+
         df = pd.DataFrame(data)
 
         return df

{brynq_sdk_nmbrs-2.3.0 → brynq_sdk_nmbrs-2.3.1.dev0}/brynq_sdk_nmbrs/department.py

@@ -1,10 +1,19 @@
 import math
+from typing import Any, Dict
+
 import pandas as pd
 import requests
-from typing import Dict, Any
-from .schemas.department import DepartmentCreate, EmployeeDepartmentUpdate, Period, EmployeeDepartmentGet, DepartmentGet
+
 from brynq_sdk_functions import Functions
 
+from .schemas.department import (
+    DepartmentCreate,
+    DepartmentGet,
+    EmployeeDepartmentGet,
+    EmployeeDepartmentUpdate,
+    Period,
+)
+
 
 class EmployeeDepartment:
     def __init__(self, nmbrs):
@@ -43,35 +52,35 @@ class EmployeeDepartment:
 
         return df
 
-    def create(self, employee_id: str, data: Dict[str, Any]):
-        """
-        Create a new department for an employee using Pydantic validation.
+    # def create(self, employee_id: str, data: Dict[str, Any]):
+    #     """
+    #     Create a new department for an employee using Pydantic validation.
 
-        Args:
-            employee_id: The ID of the employee
-            data: Dictionary containing department data with fields matching
-                 the DepartmentCreate schema (using camelCase field names)
+    #     Args:
+    #         employee_id: The ID of the employee
+    #         data: Dictionary containing department data with fields matching
+    #              the DepartmentCreate schema (using camelCase field names)
 
-        Returns:
-            Response from the API
-        """
-        # Validate with Pydantic model
-        nested_data = self.nmbrs.flat_dict_to_nested_dict(data, DepartmentCreate)
-        department_model = DepartmentCreate(**nested_data)
+    #     Returns:
+    #         Response from the API
+    #     """
+    #     # Validate with Pydantic model
+    #     nested_data = self.nmbrs.flat_dict_to_nested_dict(data, DepartmentCreate)
+    #     department_model = DepartmentCreate(**nested_data)
 
-        if self.nmbrs.mock_mode:
-            return department_model
+    #     if self.nmbrs.mock_mode:
+    #         return department_model
 
-        # Convert validated model to dict for API payload
-        payload = department_model.model_dump(exclude_none=True, by_alias=True)
+    #     # Convert validated model to dict for API payload
+    #     payload = department_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}/department",
-            json=payload,
-            timeout=self.nmbrs.timeout
-        )
-        return resp
+    #     # Send request
+    #     resp = self.nmbrs.session.post(
+    #         url=f"{self.nmbrs.base_url}employees/{employee_id}/department",
+    #         json=payload,
+    #         timeout=self.nmbrs.timeout
+    #     )
+    #     return resp
 
     def update(self, employee_id: str, data: Dict[str, Any]):
         """
@@ -93,7 +102,7 @@ class EmployeeDepartment:
             return department_model
 
         # Convert validated model to dict for API payload
-        payload = department_model.model_dump(exclude_none=True, by_alias=True)
+        payload = department_model.model_dump(exclude_none=True, by_alias=True, mode='json')
 
         # Send request
         resp = self.nmbrs.session.put(

brynq_sdk_nmbrs-2.3.1.dev0/brynq_sdk_nmbrs/employee_wage_tax_settings.py

@@ -0,0 +1,106 @@
+from typing import Any, Dict
+
+import pandas as pd
+import requests
+
+from brynq_sdk_functions import Functions
+
+from .schemas.wage_tax_settings import (
+    EmployeeWageTaxSettingsCreate,
+    EmployeeWageTaxSettingsGet,
+)
+
+
+class EmployeeWageTaxSettings:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            employee_id: str = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get wage tax settings history for employees in companies.
+
+        Args:
+            employee_id: Optional filter for a specific employee ID
+
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        wage_tax_settings = pd.DataFrame()
+        for company in self.nmbrs.company_ids:
+            company_settings = self._get(company, employee_id)
+            if not company_settings.empty:
+                wage_tax_settings = pd.concat([wage_tax_settings, company_settings])
+
+        valid_settings, invalid_settings = Functions.validate_data(
+            df=wage_tax_settings, schema=EmployeeWageTaxSettingsGet, debug=True
+        )
+
+        return valid_settings, invalid_settings
+
+    def _get(self,
+             company_id: str,
+             employee_id: str = None) -> pd.DataFrame:
+        """
+        Get wage tax settings history for a specific company.
+
+        Args:
+            company_id: The ID of the company
+            employee_id: Optional filter for a specific employee ID
+
+        Returns:
+            DataFrame with wage tax settings
+        """
+        params = {}
+        if employee_id:
+            params['employeeId'] = employee_id
+
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}companies/{company_id}/employees/wagetaxsettings",
+            params=params
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+
+        if not data:
+            return pd.DataFrame()
+
+        # Normalize nested structure similar to departments/employments
+        df = pd.json_normalize(
+            data,
+            record_path='wagetaxsettings',
+            meta=['employeeId']
+        )
+
+        return df
+
+    def create(self, employee_id: str, data: Dict[str, Any]):
+        """
+        Create wage tax settings for an employee using Pydantic validation.
+
+        Args:
+            employee_id: The ID of the employee
+            data: Dictionary containing wage tax settings data with fields matching
+                 the EmployeeWageTaxSettingsCreate schema (using camelCase field names)
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic model
+        nested_data = self.nmbrs.flat_dict_to_nested_dict(data, EmployeeWageTaxSettingsCreate)
+        settings_model = EmployeeWageTaxSettingsCreate(**nested_data)
+
+        if self.nmbrs.mock_mode:
+            return settings_model
+
+        # Convert validated model to dict for API payload
+        payload = settings_model.model_dump(exclude_none=True, by_alias=True, mode='json')
+
+        # Send request
+        resp = self.nmbrs.session.post(
+            url=f"{self.nmbrs.base_url}employees/{employee_id}/wagetaxsettings",
+            json=payload,
+            timeout=self.nmbrs.timeout
+        )
+        return resp