brynq-sdk-nmbrs 2.2.1__tar.gz → 2.3.0__tar.gz

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_nmbrs
-Version: 2.2.1
+Version: 2.3.0
 Summary: Nmbrs wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/__init__.py

@@ -67,6 +67,16 @@ 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()
+            # 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.soap_company_ids = self.companies.get_soap_ids()
+                self.salary_tables = SalaryTables(self)
+                self.salary_scales = SalaryScales(self)
+                self.salary_steps = SalarySteps(self)
+                self.wage_tax = WageTax(self)
+                self.absence = Absence(self)
+                self.children = Children(self)
 
         self.address = Address(self)
         self.bank = Bank(self)
@@ -78,7 +88,6 @@ class Nmbrs(BrynQ):
         debtors, _ = self.debtor.get()
         self.debtor_ids = debtors['debtor_id'].to_list()
         self.company_ids = self.companies.get()['companyId'].to_list()
-        self.soap_company_ids = self.companies.get_soap_ids()
         self.employees = Employees(self)
         self.employment = Employment(self)
         self.function = EmployeeFunction(self)
@@ -92,12 +101,6 @@ class Nmbrs(BrynQ):
         self.schedule = Schedule(self)
         self.fixed_wagecomponents = EmployeeFixedWageComponents(self)
         self.variable_wagecomponents = EmployeeVariableWageComponents(self)
-        self.children = Children(self)
-        self.salary_tables = SalaryTables(self)
-        self.salary_scales = SalaryScales(self)
-        self.salary_steps = SalarySteps(self)
-        self.wage_tax = WageTax(self)
-        self.absence = Absence(self)
         self.current_period = self.companies.get_current_period()
 
     def _get_request_headers(self):
@@ -115,6 +118,31 @@ class Nmbrs(BrynQ):
         """
         Creates the SOAP authentication header using credentials from initial_credentials.
 
+        Returns:
+            AuthHeaderWithDomainType: The authentication header for SOAP requests
+        """
+        initial_credentials = self.interfaces.credentials.get(system='nmbrs', system_type=self.system_type)
+        config = initial_credentials.get("custom_data", {})
+
+        if 'soap_api_token' not in config.keys():
+            return None
+        else:
+            # Get the AuthHeaderWithDomain type from the WSDL
+            AuthHeaderWithDomainType = self.soap_client_companies.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")
+            )
+
+            return auth_header
+
+    def _get_soap_auth_header_employees(self):
+        """
+        Creates the SOAP authentication header using credentials from initial_credentials.
+
         Returns:
             AuthHeaderWithDomainType: The authentication header for SOAP requests
         """
@@ -122,7 +150,7 @@ class Nmbrs(BrynQ):
         config = initial_credentials.get("config", {})
 
         # Get the AuthHeaderWithDomain type from the WSDL
-        AuthHeaderWithDomainType = self.soap_client_companies.get_element('ns0:AuthHeaderWithDomain')
+        AuthHeaderWithDomainType = self.soap_client_employees.get_element('ns0:AuthHeaderWithDomain')
 
         # Create the auth header using credentials from config
         auth_header = AuthHeaderWithDomainType(

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/absence.py

@@ -40,7 +40,7 @@ class Absence:
 
     def _get(self, company_id: int, employee_id: int = None) -> pd.DataFrame:
         """
-        Get salary tables for a specific company, period and year.
+        Get all absences for a specific company, period and year.
 
         Args:
             company_id (int): The ID of the company
@@ -51,20 +51,16 @@ class Absence:
             pd.DataFrame: DataFrame containing the salary tables
         """
         try:
-
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             if employee_id is None:
                 response = self.soap_client_employees.service.Absence_GetAll_AllEmployeesByCompany(
                     CompanyId=company_id,
-                    _soapheaders=[auth_header]
+                    _soapheaders=[self.nmbrs.soap_auth_header]
                 )
             else:
                 # Make SOAP request with the proper header structure
                 response = self.soap_client_employees.service.Absence_GetList(
                     EmployeeId=employee_id,
-                    _soapheaders=[auth_header]
+                    _soapheaders=[self.nmbrs.soap_auth_header]
                 )
 
             # Convert response to DataFrame
@@ -95,9 +91,6 @@ class Absence:
             if self.nmbrs.mock_mode:
                 return absence_model
 
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Use the model's built-in SOAP conversion method
             absence_settings = absence_model.to_soap_settings(self.nmbrs.soap_client_employees)
 
@@ -106,7 +99,7 @@ class Absence:
                 EmployeeId=absence_model.employee_id,
                 Dossier=absence_model.new_dossier,
                 Absence=absence_settings,
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/companies.py

@@ -51,12 +51,9 @@ class Companies:
             pd.DataFrame: DataFrame containing all companies
         """
         try:
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Make SOAP request with the proper header structure
             response = self.soap_client_companies.service.List_GetAll(
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/employees.py

@@ -22,7 +22,7 @@ from .days import VariableDays
 from .wagecomponents import EmployeeVariableWageComponents, EmployeeFixedWageComponents
 from .leave import Leave, LeaveBalance
 from .schemas.employees import (
-    EmployeeGet, EmployeeCreate, EmployeeUpdate, EmployeeDelete,
+    BsnGet, EmployeeGet, EmployeeCreate, EmployeeUpdate, EmployeeDelete,
     BasicInfo, BirthInfo, ContactInfo, PartnerInfo, Period, AdditionalEmployeeInfo,
     CreateEmployeePersonalInfo
 )
@@ -83,6 +83,24 @@ class Employees:
 
         return df
 
+    def get_private_info(self) -> str:
+        combined = []
+        for company_id in self.nmbrs.company_ids:
+            request = requests.Request(method='GET',
+                                    url=f"{self.nmbrs.base_url}companies/{company_id}/employees/privateInfos")
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.json_normalize(
+                data,
+                record_path='privateInfos',
+                meta=['employeeId']
+            )
+            df['companyId'] = company_id
+            combined.append(df)
+        df = pd.concat(combined, ignore_index=True)
+        valid_bsn, invalid_bsn = Functions.validate_data(df, BsnGet)
+
+        return valid_bsn, invalid_bsn
+
     def get_default_templates(self) -> pd.DataFrame:
         default_templates = pd.DataFrame()
         for company in self.nmbrs.company_ids:

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/salary_tables.py

@@ -50,15 +50,12 @@ class SalaryTables:
             pd.DataFrame: DataFrame containing the salary tables
         """
         try:
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Make SOAP request with the proper header structure
             response = self.soap_client_companies.service.SalaryTable2_Get(
                 CompanyId=company_id,
                 Period=period,
                 Year=year,
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame
@@ -123,15 +120,12 @@ class SalaryScales:
             pd.DataFrame: DataFrame containing the salary scales
         """
         try:
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Make SOAP request with the proper header structure
             response = self.soap_client_companies.service.SalaryTable2_GetScales(
                 CompanyId=company_id,
                 Period=period,
                 Year=year,
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame
@@ -208,9 +202,6 @@ class SalarySteps:
             pd.DataFrame: DataFrame containing the salary steps
         """
         try:
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Make SOAP request with the proper header structure
             response = self.soap_client_companies.service.SalaryTable2_GetSteps(
                 CompanyId=company_id,
@@ -223,7 +214,7 @@ class SalarySteps:
                     'ScalePercentageMax': scale.get('scale_percentage_max', 0),
                     'ScalePercentageMin': scale.get('scale_percentage_min', 0)
                 },
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/schemas/employees.py

@@ -84,7 +84,7 @@ class BirthInfo(BaseModel):
         StringConstraints(
             pattern=r'^[A-Za-z]+$',
             strip_whitespace=True,
-            min_length=2, 
+            min_length=2,
             max_length=3
         )
     ]] = Field(None, example="PT", description="Nationality Code ISO", alias="nationalityCodeISO")
@@ -140,3 +140,12 @@ class EmployeeUpdate(BaseModel):
 
 class EmployeeDelete(BaseModel):
     employee_id: str = Field(..., example="3054d4cf-b449-489d-8d2e-5dd30e5ab994", description="Employee ID", alias="employeeId")
+
+class BsnGet(BrynQPanderaDataFrameModel):
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    social_security_number: Series[String] = pa.Field(coerce=True, description="Social Security Number", alias="BSN")
+    company_id: Series[String] = pa.Field(coerce=True, description="Company ID", alias="companyId")
+    created_at: Series[DateTime] = pa.Field(coerce=True, description="Created At", alias="createdAt")
+
+    class _Annotation:
+        primary_key = "employee_id"

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/schemas/wage_tax.py

@@ -10,7 +10,7 @@ from pydantic import BaseModel, Field, StringConstraints
 from datetime import datetime
 
 
-class WageTaxGet(BrynQPanderaDataFrameModel):
+class WageTaxSettingsGet(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")
@@ -24,6 +24,47 @@ class WageTaxGet(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")
 
+# <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">
+#          <WageTax_GetListResult>
+#             <WageTaxSettings>
+#                <Id>2998190</Id>
+#                <JaarloonBT>12144.00</JaarloonBT>
+#                <AfwBijzTariefLH>0</AfwBijzTariefLH>
+#                <AutoKleineBanenRegeling>true</AutoKleineBanenRegeling>
+#                <Loonheffingkorting>true</Loonheffingkorting>
+#                <Voordeelreg>true</Voordeelreg>
+#                <Loonheffing>true</Loonheffing>
+#                <CodeAfdrachtvermindering>0</CodeAfdrachtvermindering>
+#                <KleurTabel>1</KleurTabel>
+#                <SoortInkomen>15</SoortInkomen>
+#                <SpecialeTabel>0</SpecialeTabel>
+#                <TijdvakTabel>2</TijdvakTabel>
+#                <VakantieBonnen>0</VakantieBonnen>
+#                <CodeCalc30PercRule>0</CodeCalc30PercRule>
+#             </WageTaxSettings>
+#          </WageTax_GetListResult>
+#       </WageTax_GetListResponse>
+#    </soap:Body>
+# </soap:Envelope>
+
+class WageTaxGet(BrynQPanderaDataFrameModel):
+    wage_tax_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Wage Tax ID", alias="Id")
+    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="EmployeeId")
+    yearly_salary: Series[pd.Float64Dtype] = pa.Field(coerce=True, description="Yearly Salary", alias="JaarloonBT")
+    deviation_special_rate_payroll_tax_deduction: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Afw Bijz Tarief LH", alias="AfwBijzTariefLH")
+    auto_small_jobs: Series[Bool] = pa.Field(coerce=True, description="Auto Kleine Banen Regeling", alias="AutoKleineBanenRegeling")
+    payroll_tax_deduction: Series[Bool] = pa.Field(coerce=True, description="Loonheffingkorting", alias="Loonheffingkorting")
+    benefit_scheme: Series[Bool] = pa.Field(coerce=True, description="Voordeelreg", alias="Voordeelreg")
+    payroll_tax: Series[Bool] = pa.Field(coerce=True, description="Loonheffing", alias="Loonheffing")
+    code_tax_reduction: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Code Afdrachtvermindering", alias="CodeAfdrachtvermindering")
+    color_table: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Kleur Tabel", alias="KleurTabel")
+    type_of_income: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Soort Inkomen", alias="SoortInkomen")
+    special_table: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Speciale Tabel", alias="SpecialeTabel")
+    period_table: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Tijdvak Tabel", alias="TijdvakTabel")
+    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 WageTaxUpdate(BaseModel):
     employee_id: Optional[int] = Field(None, example="1234567890", description="Employee ID", alias="EmployeeId")

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/social_insurance.py

@@ -20,9 +20,6 @@ class SocialInsurance:
             if self.nmbrs.mock_mode:
                 return social_insurance_model
 
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Use the model's built-in SOAP conversion method
             social_insurance_settings = social_insurance_model.to_soap_settings(self.nmbrs.soap_client_employees)
 
@@ -30,7 +27,7 @@ class SocialInsurance:
             response = self.nmbrs.soap_client_employees.service.SVW_UpdateCurrent(
                 EmployeeId=social_insurance_model.employee_id,
                 SVWSettings=social_insurance_settings,
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs/wage_tax.py

@@ -1,6 +1,6 @@
 from typing import Any, Dict, List, Union, Tuple
 import pandas as pd
-from .schemas.wage_tax import WageTaxGet, WageTaxUpdate
+from .schemas.wage_tax import WageTaxGet, WageTaxUpdate, WageTaxSettingsGet
 from zeep.exceptions import Fault
 from zeep.ns import WSDL, SOAP_ENV_11
 from zeep.xsd import ComplexType, Element, String
@@ -33,7 +33,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=WageTaxGet, debug=True)
+        valid_wagetax_settings, invalid_wagetax_settings = Functions.validate_data(df=wagetax_settings, schema=WageTaxSettingsGet, debug=True)
 
         # No validation schema for now, but could be added later
         return valid_wagetax_settings, invalid_wagetax_settings
@@ -51,14 +51,11 @@ class WageTax:
             pd.DataFrame: DataFrame containing the salary tables
         """
         try:
-            # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
-
             # Make SOAP request with the proper header structure
             response = self.soap_client_companies.service.WageTax_GetList(
                 CompanyId=company_id,
                 intYear=year,
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame
@@ -82,6 +79,49 @@ class WageTax:
         except Exception as e:
             raise Exception(f"Failed to get salary tables: {str(e)}")
 
+    def get(self, employee_id: int) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get wage tax settings for a specific employee.
+
+        Args:
+            employee_id (int): The ID of the employee
+
+        Returns:
+            pd.DataFrame: DataFrame containing the wage tax settings
+        """
+        try:
+            # Get the auth header using the centralized method
+            auth_header = self.nmbrs._get_soap_auth_header_employees()
+
+            # Make SOAP request with the proper header structure
+            response = self.soap_client_employees.service.WageTax_GetCurrent(
+                EmployeeId=employee_id,
+                _soapheaders=[auth_header]
+            )
+
+            # Convert response to DataFrame
+            if response:
+                # Convert Zeep objects to Python dictionaries
+                serialized_response = serialize_object(response)
+
+                # Convert to list if it's not already
+                if not isinstance(serialized_response, list):
+                    serialized_response = [serialized_response]
+
+                # Convert to DataFrame
+                df = pd.DataFrame(serialized_response)
+                df['EmployeeId'] = employee_id
+                valid_wage_tax, invalid_wage_tax = Functions.validate_data(df=df, schema=WageTaxGet, debug=True)
+
+                return valid_wage_tax, invalid_wage_tax
+            else:
+                return pd.DataFrame(), pd.DataFrame()
+
+        except Fault as e:
+            raise Exception(f"SOAP request failed: {str(e)}")
+        except Exception as e:
+            raise Exception(f"Failed to get wage tax settings: {str(e)}")
+
     def update(self, data: Dict[str, Any]) -> pd.DataFrame:
         try:
             wage_tax_model = WageTaxUpdate(**data)
@@ -90,7 +130,7 @@ class WageTax:
                 return wage_tax_model
 
             # Get the auth header using the centralized method
-            auth_header = self.nmbrs._get_soap_auth_header()
+            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)
@@ -99,7 +139,7 @@ class WageTax:
             response = self.nmbrs.soap_client_employees.service.WageTax_UpdateCurrent(
                 EmployeeId=wage_tax_model.employee_id,
                 LoonheffingSettings=wage_tax_settings,
-                _soapheaders=[auth_header]
+                _soapheaders=[self.nmbrs.soap_auth_header]
             )
 
             # Convert response to DataFrame

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/brynq_sdk_nmbrs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-nmbrs
-Version: 2.2.1
+Version: 2.3.0
 Summary: Nmbrs wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_nmbrs-2.2.1 → brynq_sdk_nmbrs-2.3.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_nmbrs',
-    version='2.2.1',
+    version='2.3.0',
     description='Nmbrs wrapper from BrynQ',
     long_description='Nmbrs wrapper from BrynQ',
     author='BrynQ',