brynq-sdk-zenegy 1.3.3__py3-none-any.whl

brynq_sdk_zenegy/payroll.py

@@ -0,0 +1,117 @@
+from .schemas.payrolls import PayrollsGet
+import requests
+from uuid import UUID
+from typing import Tuple
+import pandas as pd
+from brynq_sdk_functions import Functions
+
+
+class Payrolls:
+    """
+    Handles all payroll-related operations in Zenegy API
+    """
+
+    def __init__(self, zenegy):
+        """
+        Initialize the Payrolls class.
+
+        Args:
+            zenegy: The Zenegy instance to use for API calls
+        """
+        self.zenegy = zenegy
+        self.endpoint = f"api/companies/{self.zenegy.company_uid}/payroll"
+
+    def get_employee_payrolls(self, payroll_uid: UUID, employee_uid: UUID) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get employee payrolls for a specific payroll and employee.
+
+        Args:
+            payroll_uid (UUID): The payroll uid
+            employee_uid (UUID): The employee uid
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        try:
+            endpoint = f"{self.endpoint}/{payroll_uid}/employees/{employee_uid}"
+            content = self.zenegy.get(endpoint=endpoint)
+
+            # Normalize the response (direct list of dicts)
+            df = pd.DataFrame(content)
+            if df.empty:
+                return pd.DataFrame(), pd.DataFrame()
+
+            # Validate against schema
+            valid_data, invalid_data = Functions.validate_data(df, PayrollsGet)
+
+            return valid_data, invalid_data
+        except Exception as e:
+            raise Exception(f"Failed to retrieve employee payrolls: {str(e)}") from e
+
+    def get_by_id(self, payroll_uid: UUID) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        GetPayroll
+
+        Args:
+            payroll_uid (UUID): The payroll uid
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        try:
+            endpoint = f"{self.endpoint}/{payroll_uid}"
+            content = self.zenegy.get(endpoint=endpoint)
+
+            # Normalize the response using record_path for employees array
+            df = pd.json_normalize(
+                [content],
+                record_path='employees',
+                meta=['uid', 'type', 'periodFrom', 'periodTo', 'dispositionDate', 'status', 'hasHolidayPayment', 'hasBenefitPackage', 'hasBenefitPackageTwo', 'hasAmPension', 'hasApprovalFlowEnabled', 'company', 'hasHolidaySupplementPayout', 'disablePayslipNotification', 'sendPayslipNotificationOn', 'hasHolidayPaymentPayout', 'hasHolidayPaymentToHolidayPayPayout', 'hasBenefitPackagePayout', 'hasBenefitPackageTwoPayout', 'isAlreadyPaid', 'isEligibleForRevert', 'payrollRegistrationPeriods', 'note', 'isForced', 'hasTimeInLieuPayout', 'payslipStatus', 'isPayrollApprovalEnabledForPayroll', 'disablePayslipGeneration', 'isTrackingNegativeSalaryEnabled', 'isCompanyExtraEntitlementInHours', 'isExtraHolidayEntitlementInHoursEnabled', 'revertType', 'hasHolidayPaymentTaxationAndTransferToNextYear', 'hasHolidayPaymentNettoPayout', 'hasTransferShNettoAndPayout', 'hasShNetPayout', 'hasFifthHolidayWeekPayout', 'extraPayrollRun', 'isCompletedWithAmAccounting', 'failedPayrollUid'],
+                record_prefix='employee__',
+                sep='__'
+            )
+            if df.empty:
+                return pd.DataFrame(), pd.DataFrame()
+
+            # Validate against schema
+            valid_data, invalid_data = Functions.validate_data(df, PayrollsGet)
+
+            return valid_data, invalid_data
+        except Exception as e:
+            raise Exception(f"Failed to retrieve payroll by ID: {str(e)}") from e
+
+    def delete(self, payroll_uid: UUID) -> requests.Response:
+        """
+        CancelPayroll
+
+        Args:
+            company_uid (UUID): The company uid
+        Args:
+            payroll_uid (UUID): The payroll uid
+        Returns:
+            requests.Response: The API response
+        """
+        endpoint = f"{self.endpoint}/{payroll_uid}"
+        try:
+            response = self.zenegy.delete(endpoint=endpoint)
+            self.zenegy.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to delete payroll: {str(e)}")
+
+    def delete_employee_payroll(self, payroll_uid: UUID,
+                                      employee_payroll_uid: UUID) -> requests.Response:
+        """
+        DeleteEmployeePayrollAsync
+        Args:
+            payroll_uid (UUID): The payroll uid
+        Args:
+            employee_payroll_uid (UUID): The employee payroll uid
+        Returns:
+            requests.Response: The API response
+        """
+        endpoint_path = f"{self.endpoint}/{payroll_uid}/employees/{employee_payroll_uid}"
+        try:
+            response = self.zenegy.delete(endpoint=endpoint_path)
+            self.zenegy.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to delete employee payroll: {str(e)}")

brynq_sdk_zenegy/payslips.py

@@ -0,0 +1,43 @@
+from .schemas.payslips import PayslipsGet
+from uuid import UUID
+from typing import Tuple
+import pandas as pd
+from brynq_sdk_functions import Functions
+
+class Payslips:
+    """
+    Handles all payslip-related operations in Zenegy API
+    """
+
+    def __init__(self, zenegy):
+        """
+        Initialize the Payslips class.
+
+        Args:
+            zenegy: The Zenegy instance to use for API calls
+        """
+        self.zenegy = zenegy
+
+    def get(self, employee_uid: UUID) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        GetEmployeePayslips
+        Args:
+            employee_uid (UUID): The employee uid
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        try:
+            endpoint = f"api/companies/{self.zenegy.company_uid}/employees/{employee_uid}/payslips"
+            content = self.zenegy.get(endpoint=endpoint)
+
+            # Normalize the response (data field contains the list)
+            df = pd.json_normalize(content.get("data", []), sep='__')
+            if df.empty:
+                return pd.DataFrame(), pd.DataFrame()
+
+            # Validate against schema
+            valid_data, invalid_data = Functions.validate_data(df, PayslipsGet)
+
+            return valid_data, invalid_data
+        except Exception as e:
+            raise Exception(f"Failed to retrieve payslips: {str(e)}") from e

brynq_sdk_zenegy/pensions.py

@@ -0,0 +1,118 @@
+import requests
+from uuid import UUID
+from .schemas.employee_pensions import (EmployeePensionCreate,
+                                        PensionGet)
+from brynq_sdk_functions import Functions
+from typing import Dict, Any, List, Tuple
+import pandas as pd
+
+
+class Pensions:
+    """
+    Handles all employeepensions-related operations in Zenegy API
+    """
+    def __init__(self, zenegy):
+        """
+        Initialize the Employeepensions class.
+
+        Args:
+            zenegy: The Zenegy instance to use for API calls
+        """
+        self.zenegy = zenegy
+        self.endpoint = f"api/companies/{self.zenegy.company_uid}/pensions/bulk"
+
+    def get(self, employee_uid: UUID) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        GetEmployeePensionsAsync
+        Args:
+            employee_uid (UUID): The employee uid
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        try:
+            endpoint = f"api/companies/{self.zenegy.company_uid}/employees/{employee_uid}/pensions"
+            content = self.zenegy.get(endpoint=endpoint)
+
+            # Get data from response
+            data = content.get("data", [])
+            if data:
+                # Normalize the data
+                df = pd.json_normalize(
+                    data,
+                    sep='__'
+                )
+                if df.empty:
+                    return pd.DataFrame(), pd.DataFrame()
+                # Validate data using schema
+                valid_data, invalid_data = Functions.validate_data(df, PensionGet)
+                return valid_data, invalid_data
+            return pd.DataFrame(), pd.DataFrame()
+        except Exception as e:
+            raise Exception(f"Failed to retrieve pensions: {str(e)}") from e
+
+    def get_by_id(self, employee_uid: UUID, employee_pension_uid: UUID) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        GetEmployeePensionAsync
+        Args:
+            employee_uid (UUID): The employee uid
+            employee_pension_uid (UUID): The employee pension uid
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        try:
+            endpoint = f"api/companies/{self.zenegy.company_uid}/employees/{employee_uid}/pensions/{employee_pension_uid}"
+            content = self.zenegy.get(endpoint=endpoint)
+
+            # Normalize the data (content is already a dict)
+            df = pd.json_normalize(
+                [content],  # Wrap single object in list for normalization
+                sep='__'
+            )
+            if df.empty:
+                return pd.DataFrame(), pd.DataFrame()
+
+            # Validate data using schema
+            valid_data, invalid_data = Functions.validate_data(df, PensionGet)
+            return valid_data, invalid_data
+        except Exception as e:
+            raise Exception(f"Failed to retrieve pension by ID: {str(e)}") from e
+
+    def create(self, employee_uid: UUID, data: Dict[str, Any]) -> requests.Response:
+        """
+        InsertEmployeePensionAsync
+        Args:
+            employee_uid (UUID): The employee uid
+        Args:
+            data (Dict[str, Any]): The data
+        Returns:
+            requests.Response: The API response
+        """
+        endpoint = f"api/companies/{self.zenegy.company_uid}/employees/{employee_uid}/pensions"
+        # Validate the data using Pydantic
+        try:
+            valid_data = EmployeePensionCreate(**data)
+            if valid_data:
+                req_body = valid_data.model_dump(by_alias=True, exclude_none=True,mode="json")
+                response = self.zenegy.post(endpoint=endpoint, json=req_body)
+                self.zenegy.raise_for_status_with_details(response)
+                return response
+        except Exception as e:
+            raise Exception(f"Error creating pension data: {str(e)}")
+
+    def delete(self, employee_uid: UUID, employee_pension_uid: UUID) -> requests.Response:
+        """
+        DeleteEmployeePensionAsync
+        Args:
+            employee_uid (UUID): The employee uid
+        Args:
+            employee_pension_uid (UUID): The employee pension uid
+        Returns:
+            requests.Response: The API response
+        """
+        endpoint = f"api/companies/{self.zenegy.company_uid}/employees/{employee_uid}/pensions/{employee_pension_uid}"
+        try:
+            response = self.zenegy.delete(endpoint=endpoint)
+            self.zenegy.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to delete pension: {str(e)}")

brynq_sdk_zenegy/schemas/__init__.py

@@ -0,0 +1,30 @@
+"""Schema definitions for Zenegy package"""
+
+from .absences import AbsenceGet, CreateAbsenceRequest, UpdateAbsenceRequest
+from .companies import CompaniesGet
+from .company_cost_centers import CostCentersGet, CostCenterCreate
+from .company_departments import DepartmentsGet
+from .employees import EmployeesGet, EmployeesGetById, EmployeeCreate, EmployeeUpsert, EmployeeUpdate
+from .employee_pensions import PensionGet, EmployeePensionCreate
+from .global_values import GlobalValuesGet, CompanyGlobalValueCreate, CompanyGlobalValueResponse, CompanyGlobalValueUpdate, GlobalValueAssign, AssignedGlobalValuesGet
+from .global_value_sets import GlobalValueSetsGet, GlobalValueSetCreate, GlobalValueSetUpdate, GlobalValueSetEmployeeAssignment, GlobalValueSetEmployeeAssignmentResponse
+from .employee_pay_checks import PayChecksGet, PaycheckCreate, PaycheckUpdate
+from .payrolls import PayrollsGet
+from .payslips import PayslipsGet
+from .supplements_and_deductions_rates import SupplementRatesGet, SupplementRegistrationsGet
+
+__all__ = [
+    'AbsenceGet', 'CreateAbsenceRequest', 'UpdateAbsenceRequest',
+    'CompaniesGet',
+    'CostCentersGet', 'CostCenterCreate',
+    'DepartmentsGet',
+    'EmployeesGet', 'EmployeesGetById', 'EmployeeCreate', 'EmployeeUpsert', 'EmployeeUpdate',
+    'PensionGet', 'EmployeePensionCreate',
+    'SupplementRegistrationsGet',
+    'GlobalValuesGet', 'CompanyGlobalValueCreate', 'CompanyGlobalValueResponse', 'CompanyGlobalValueUpdate', 'GlobalValueAssign', 'AssignedGlobalValuesGet',
+    'GlobalValueSetsGet', 'GlobalValueSetCreate', 'GlobalValueSetUpdate', 'GlobalValueSetEmployeeAssignment', 'GlobalValueSetEmployeeAssignmentResponse',
+    'PayChecksGet', 'PaycheckCreate', 'PaycheckUpdate',
+    'PayrollsGet',
+    'PayslipsGet',
+    'SupplementRatesGet'
+]