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

brynq_sdk_zenegy/schemas/payrolls.py

@@ -0,0 +1,134 @@
+# Generated schemas for tag: Payroll
+
+from datetime import datetime
+from pydantic import BaseModel, Field
+from typing import Dict, List, Optional, Any
+from uuid import UUID
+
+# BrynQ Pandera DataFrame Model for Payrolls
+from pandera.typing import Series
+import pandera as pa
+import pandas as pd
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+class PayrollsGet(BrynQPanderaDataFrameModel):
+    """Flattened schema for Zenegy Payrolls Output data"""
+    # Basic payroll fields
+    uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payroll UID", alias="uid")
+    type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payroll type", alias="type")
+    period_from: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Period from", alias="periodFrom")
+    period_to: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Period to", alias="periodTo")
+    disposition_date: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Disposition date", alias="dispositionDate")
+    status: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payroll status", alias="status")
+    has_holiday_payment: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has holiday payment", alias="hasHolidayPayment")
+    has_benefit_package: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has benefit package", alias="hasBenefitPackage")
+    has_benefit_package_two: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has benefit package two", alias="hasBenefitPackageTwo")
+    has_am_pension: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has AM pension", alias="hasAmPension")
+    has_approval_flow_enabled: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has approval flow enabled", alias="hasApprovalFlowEnabled")
+    has_holiday_supplement_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has holiday supplement payout", alias="hasHolidaySupplementPayout")
+    disable_payslip_notification: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Disable payslip notification", alias="disablePayslipNotification")
+    send_payslip_notification_on: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Send payslip notification on", alias="sendPayslipNotificationOn")
+    has_holiday_payment_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has holiday payment payout", alias="hasHolidayPaymentPayout")
+    has_holiday_payment_to_holiday_pay_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has holiday payment to holiday pay payout", alias="hasHolidayPaymentToHolidayPayPayout")
+    has_benefit_package_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has benefit package payout", alias="hasBenefitPackagePayout")
+    has_benefit_package_two_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has benefit package two payout", alias="hasBenefitPackageTwoPayout")
+    is_already_paid: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is already paid", alias="isAlreadyPaid")
+    is_eligible_for_revert: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is eligible for revert", alias="isEligibleForRevert")
+    note: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Note", alias="note")
+    is_forced: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is forced", alias="isForced")
+    has_time_in_lieu_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has time in lieu payout", alias="hasTimeInLieuPayout")
+    payslip_status: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payslip status", alias="payslipStatus")
+    is_payroll_approval_enabled_for_payroll: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is payroll approval enabled for payroll", alias="isPayrollApprovalEnabledForPayroll")
+    disable_payslip_generation: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Disable payslip generation", alias="disablePayslipGeneration")
+    is_tracking_negative_salary_enabled: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is tracking negative salary enabled", alias="isTrackingNegativeSalaryEnabled")
+    is_company_extra_entitlement_in_hours: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is company extra entitlement in hours", alias="isCompanyExtraEntitlementInHours")
+    is_extra_holiday_entitlement_in_hours_enabled: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is extra holiday entitlement in hours enabled", alias="isExtraHolidayEntitlementInHoursEnabled")
+    revert_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Revert type", alias="revertType")
+    has_holiday_payment_taxation_and_transfer_to_next_year: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has holiday payment taxation and transfer to next year", alias="hasHolidayPaymentTaxationAndTransferToNextYear")
+    has_holiday_payment_netto_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has holiday payment netto payout", alias="hasHolidayPaymentNettoPayout")
+    has_transfer_sh_netto_and_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has transfer SH netto and payout", alias="hasTransferShNettoAndPayout")
+    has_sh_net_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has SH net payout", alias="hasShNetPayout")
+    has_fifth_holiday_week_payout: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Has fifth holiday week payout", alias="hasFifthHolidayWeekPayout")
+    extra_payroll_run: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Extra payroll run", alias="extraPayrollRun")
+    is_completed_with_am_accounting: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Is completed with AM accounting", alias="isCompletedWithAmAccounting")
+    failed_payroll_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Failed payroll UID", alias="failedPayrollUid")
+
+    # Company fields (nested object)
+    company_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Company name", alias="company__name")
+    company_vat_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Company VAT number", alias="company__vatNumber")
+    company_company_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Company company type", alias="company__companyType")
+    company_transfer_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Company transfer type", alias="company__transferType")
+    company_transfer_sh_netto_amount: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Company transfer SH netto amount", alias="company__transferShNettoAmount")
+    company_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Company ID", alias="company__id")
+    company_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Company UID", alias="company__uid")
+
+    # Employees (as JSON string since it's a list of objects)
+    employees: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employees list", alias="employees")
+
+    # Employee fields (flattened from employees array)
+    employee_personal_identification_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee personal identification number", alias="employee__personalIdentificationNumber")
+    employee_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee UID", alias="employee__employeeUid")
+    employee_konto_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee konto number", alias="employee__kontoNumber")
+    employee_reg_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee reg number", alias="employee__regNumber")
+    employee_for_payment: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee for payment", alias="employee__forPayment")
+    employee_is_updated: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee is updated", alias="employee__isUpdated")
+    employee_note: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee note", alias="employee__note")
+    employee_payslip_status: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee payslip status", alias="employee__payslipStatus")
+    employee_email: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee email", alias="employee__email")
+    employee_is_resigned: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee is resigned", alias="employee__isResigned")
+    employee_has_payroll: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee has payroll", alias="employee__hasPayroll")
+    employee_salary_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee salary type", alias="employee__salaryType")
+    employee_has_errors: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee has errors", alias="employee__hasErrors")
+    employee_has_warnings: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee has warnings", alias="employee__hasWarnings")
+    employee_employment_date: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee employment date", alias="employee__employmentDate")
+    employee_is_resigned_within_last_year: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee is resigned within last year", alias="employee__isResignedWithinLastyear")
+    employee_is_resigned_with_registrations: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee is resigned with registrations", alias="employee__isResignedWithRegistrations")
+    employee_title: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee title", alias="employee__title")
+    employee_has_profile_image: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee has profile image", alias="employee__hasProfileImage")
+    employee_income_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee income type", alias="employee__incomeType")
+    employee_holiday_pay_receiver_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee holiday pay receiver type", alias="employee__holidayPayReceiverType")
+    employee_extra_holiday_entitlement_rule: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee extra holiday entitlement rule", alias="employee__extraHolidayEntitlementRule")
+    employee_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee name", alias="employee__name")
+    employee_employee_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee number", alias="employee__employeeNumber")
+    employee_extra_employee_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee extra employee number", alias="employee__extraEmployeeNumber")
+    employee_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee ID", alias="employee__id")
+    employee_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee UID", alias="employee__uid")
+
+    # Employee department fields (nested object)
+    employee_department_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee department name", alias="employee__department__name")
+    employee_department_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee department number", alias="employee__department__number")
+    employee_department_has_work_schema: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee department has work schema", alias="employee__department__hasWorkSchema")
+    employee_department_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee department ID", alias="employee__department__id")
+    employee_department_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee department UID", alias="employee__department__uid")
+
+    # Employee user fields (nested object)
+    employee_user_email: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee user email", alias="employee__user__email")
+    employee_user_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee user name", alias="employee__user__name")
+    employee_user_photo_url: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee user photo URL", alias="employee__user__photoUrl")
+    employee_user_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee user ID", alias="employee__user__id")
+    employee_user_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee user UID", alias="employee__user__uid")
+
+    # Employee deparment fields (nested object - note the typo in API)
+    employee_deparment_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee deparment name", alias="employee__deparment__name")
+    employee_deparment_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee deparment number", alias="employee__deparment__number")
+    employee_deparment_has_work_schema: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Employee deparment has work schema", alias="employee__deparment__hasWorkSchema")
+    employee_deparment_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee deparment ID", alias="employee__deparment__id")
+    employee_deparment_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee deparment UID", alias="employee__deparment__uid")
+
+    # Payroll registration periods (as JSON string since it's a list of objects)
+    payroll_registration_periods: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payroll registration periods", alias="payrollRegistrationPeriods")
+
+    class _Annotation:
+        primary_key = "uid"
+        foreign_keys = {
+            "company_uid": {
+                "parent_schema": "CompaniesGet",
+                "parent_column": "uid",
+                "cardinality": "N:1",
+            },
+            "employee_uid": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "uid",
+                "cardinality": "N:1",
+            },
+        }

brynq_sdk_zenegy/schemas/payslips.py

@@ -0,0 +1,32 @@
+# Generated schemas for tag: Payslip
+
+from typing import Optional
+
+# BrynQ Pandera DataFrame Model for Payslips
+from pandera.typing import Series
+import pandera as pa
+import pandas as pd
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+class PayslipsGet(BrynQPanderaDataFrameModel):
+    """Flattened schema for Zenegy Payslips Output data"""
+    # Basic payslip fields
+    payroll_number: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payroll number", alias="payrollNumber")
+    for_payment: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="For payment", alias="forPayment")
+    gross_income: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Gross income", alias="grossIncome")
+    type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payslip type", alias="type")
+    payslip_calculation_status: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payslip calculation status", alias="payslipCalculationStatus")
+    extra_payroll_run: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Extra payroll run", alias="extraPayrollRun")
+    id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payslip ID", alias="id")
+    uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payslip UID", alias="uid")
+
+    # Payroll base fields (nested object)
+    payroll_base_period_from: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payroll base period from", alias="payrollBase__periodFrom")
+    payroll_base_period_to: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payroll base period to", alias="payrollBase__periodTo")
+    payroll_base_disposition_date: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payroll base disposition date", alias="payrollBase__dispositionDate")
+    payroll_base_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Payroll base ID", alias="payrollBase__id")
+    payroll_base_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Payroll base UID", alias="payrollBase__uid")
+
+    class _Annotation:
+        primary_key = "uid"
+        foreign_keys = {}

brynq_sdk_zenegy/schemas/supplements_and_deductions_rates.py

@@ -0,0 +1,189 @@
+# Generated schemas for tag: SupplementRates
+
+from pandera.typing import Series
+import pandera as pa
+import pandas as pd
+from typing import Optional
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+class SupplementRatesGet(BrynQPanderaDataFrameModel):
+    """Flattened schema for Zenegy Supplement Rates Output data"""
+    # Basic supplement rate fields
+    id: Optional[Series[pd.Int64Dtype]] = pa.Field(
+        coerce=True, nullable=True, description="Supplement rate ID", alias="id"
+    )
+    uid: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Supplement rate UID", alias="uid"
+    )
+    created_on: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Created on date", alias="createdOn"
+    )
+    rate: Optional[Series[pd.Float64Dtype]] = pa.Field(
+        coerce=True, nullable=True, description="Rate", alias="rate"
+    )
+    hours: Optional[Series[pd.Float64Dtype]] = pa.Field(
+        coerce=True, nullable=True, description="Hours", alias="hours"
+    )
+    name: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Name", alias="name"
+    )
+    number: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Number", alias="number"
+    )
+    konto_number: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Konto number", alias="kontoNumber"
+    )
+    reg_number: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Registration number", alias="regNumber"
+    )
+    type: Optional[Series[pd.Int64Dtype]] = pa.Field(
+        coerce=True, nullable=True, description="Type", alias="type"
+    )
+    shared_to_all: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Shared to all", alias="sharedToAll"
+    )
+    limited_to_employee: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Limited to employee", alias="limitedToEmployee"
+    )
+    is_benefit_package_two_enabled: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is benefit package two enabled", alias="isBenefitPackageTwoEnabled"
+    )
+    override_rate: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Override rate", alias="overrideRate"
+    )
+    is_prorated_rate: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is prorated rate", alias="isProratedRate"
+    )
+    include_in_pension_base: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Include in pension base", alias="includeInPensionBase"
+    )
+    include_in_am_pension_base: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Include in AM pension base", alias="includeInAmPensionBase"
+    )
+    predefined_rate_type: Optional[Series[pd.Int64Dtype]] = pa.Field(
+        coerce=True, nullable=True, description="Predefined rate type", alias="predefinedRateType"
+    )
+    is_included_in_holiday_entitlement_salary: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is included in holiday entitlement salary", alias="isIncludedInHolidayEntitlementSalary"
+    )
+    override_name: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Override name", alias="overrideName"
+    )
+    use_supplement_rates: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Use supplement rates", alias="useSupplementRates"
+    )
+    use_hour_rates: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Use hour rates", alias="useHourRates"
+    )
+    composed_rates: Optional[Series[pd.StringDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Composed rates", alias="composedRates"
+    )
+    calculate_on_percentage: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Calculate on percentage", alias="calculateOnPercentage"
+    )
+    percentage: Optional[Series[pd.Float64Dtype]] = pa.Field(
+        coerce=True, nullable=True, description="Percentage", alias="percentage"
+    )
+    calculate_on_gross_salary: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Calculate on gross salary", alias="calculateOnGrossSalary"
+    )
+    has_booking_group_override: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Has booking group override", alias="hasBookingGroupOverride"
+    )
+    is_from_template: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is from template", alias="isFromTemplate"
+    )
+    is_in_use: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is in use", alias="isInUse"
+    )
+    is_included_in_holiday_entitlement_salary_reduction: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is included in holiday entitlement salary reduction", alias="isIncludedInHolidayEntitlementSalaryReduction"
+    )
+    is_overridden: Optional[Series[pd.BooleanDtype]] = pa.Field(
+        coerce=True, nullable=True, description="Is overridden", alias="isOverridden"
+    )
+
+    class _Annotation:
+        primary_key = "uid"
+        foreign_keys = {}
+
+
+# Employee-level supplement registrations (moved from employee_supplements_and_deductions_rates.py)
+class SupplementRegistrationsGet(BrynQPanderaDataFrameModel):
+    """Flattened schema for Zenegy Supplement Registrations Output data"""
+    # Basic registration fields
+    id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Registration ID", alias="id")
+    uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Registration UID", alias="uid")
+    date: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Date", alias="date")
+    units: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Units", alias="units")
+    rate: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Rate", alias="rate")
+    total: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Total", alias="total")
+    name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Name", alias="name")
+    description: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Description", alias="description")
+    status: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Status", alias="status")
+    project_id: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Project ID", alias="projectId")
+    attachment_count: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Attachment count", alias="attachmentCount")
+    country_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Country UID", alias="countryUid")
+    country_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Country name", alias="countryName")
+    country_code: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Country code", alias="countryCode")
+    country_id: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Country ID", alias="countryId")
+    country_tax_percentage: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Country tax percentage", alias="countryTaxPercentage")
+    country_taxable_income: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Country taxable income", alias="countryTaxableIncome")
+    cost_center_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Cost center UID", alias="costCenterUid")
+    cost_center_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Cost center name", alias="costCenterName")
+    cost_center_code: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Cost center code", alias="costCenterCode")
+    trigger_retro: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Trigger retro", alias="triggerRetro")
+    company_department_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Company department UID", alias="companyDepartmentUid")
+    company_profit_center_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Company profit center UID", alias="companyProfitCenterUid")
+    percentage: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Percentage", alias="percentage")
+    reference_id: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Reference ID", alias="referenceId")
+
+    # Employee fields (nested object)
+    employee_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee ID", alias="employee__id")
+    employee_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee UID", alias="employee__uid")
+    employee_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Employee name", alias="employee__name")
+    employee_income_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Employee income type", alias="employee__incomeType")
+
+    # Department fields (nested object)
+    department_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Department ID", alias="department__id")
+    department_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Department UID", alias="department__uid")
+    department_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Department name", alias="department__name")
+    department_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Department number", alias="department__number")
+    department_has_work_schema: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Department has work schema", alias="department__hasWorkSchema")
+
+    # Supplement rate fields (nested object)
+    supplement_rate_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate ID", alias="supplementRate__id")
+    supplement_rate_uid: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate UID", alias="supplementRate__uid")
+    supplement_rate_created_on: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate created on", alias="supplementRate__createdOn")
+    supplement_rate_rate: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate rate", alias="supplementRate__rate")
+    supplement_rate_hours: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate hours", alias="supplementRate__hours")
+    supplement_rate_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate name", alias="supplementRate__name")
+    supplement_rate_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate number", alias="supplementRate__number")
+    supplement_rate_konto_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate konto number", alias="supplementRate__kontoNumber")
+    supplement_rate_reg_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate reg number", alias="supplementRate__regNumber")
+    supplement_rate_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate type", alias="supplementRate__type")
+    supplement_rate_shared_to_all: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate shared to all", alias="supplementRate__sharedToAll")
+    supplement_rate_limited_to_employee: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate limited to employee", alias="supplementRate__limitedToEmployee")
+    supplement_rate_is_benefit_package_two_enabled: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate is benefit package two enabled", alias="supplementRate__isBenefitPackageTwoEnabled")
+    supplement_rate_override_rate: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate override rate", alias="supplementRate__overrideRate")
+    supplement_rate_is_prorated_rate: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate is prorated rate", alias="supplementRate__isProratedRate")
+    supplement_rate_include_in_pension_base: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate include in pension base", alias="supplementRate__includeInPensionBase")
+    supplement_rate_include_in_am_pension_base: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate include in AM pension base", alias="supplementRate__includeInAmPensionBase")
+    supplement_rate_predefined_rate_type: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate predefined rate type", alias="supplementRate__predefinedRateType")
+    supplement_rate_is_included_in_holiday_entitlement_salary: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate is included in holiday entitlement salary", alias="supplementRate__isIncludedInHolidayEntitlementSalary")
+    supplement_rate_override_name: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate override name", alias="supplementRate__overrideName")
+    supplement_rate_use_supplement_rates: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate use supplement rates", alias="supplementRate__useSupplementRates")
+    supplement_rate_use_hour_rates: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate use hour rates", alias="supplementRate__useHourRates")
+    supplement_rate_composed_rates: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate composed rates", alias="supplementRate__composedRates")
+    supplement_rate_calculate_on_percentage: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate calculate on percentage", alias="supplementRate__calculateOnPercentage")
+    supplement_rate_percentage: Optional[Series[pd.Float64Dtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate percentage", alias="supplementRate__percentage")
+    supplement_rate_calculate_on_gross_salary: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate calculate on gross salary", alias="supplementRate__calculateOnGrossSalary")
+    supplement_rate_has_booking_group_override: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate has booking group override", alias="supplementRate__hasBookingGroupOverride")
+    supplement_rate_is_from_template: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate is from template", alias="supplementRate__isFromTemplate")
+    supplement_rate_is_in_use: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate is in use", alias="supplementRate__isInUse")
+    supplement_rate_is_included_in_holiday_entitlement_salary_reduction: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Supplement rate is included in holiday entitlement salary reduction", alias="supplementRate__isIncludedInHolidayEntitlementSalaryReduction")
+
+    class _Annotation:
+        primary_key = "uid"
+        foreign_keys = {}

brynq_sdk_zenegy/supplements_and_deductions_rates.py

@@ -0,0 +1,71 @@
+from .schemas.supplements_and_deductions_rates import SupplementRatesGet, SupplementRegistrationsGet
+from uuid import UUID
+from typing import Dict, Any, List, Tuple
+import pandas as pd
+from brynq_sdk_functions import Functions
+
+class SupplementsAndDeductionsRates:
+    """
+    Handles all companysupplementsanddeductionsrates-related operations in Zenegy API
+    """
+    def __init__(self, zenegy):
+        """
+        Initialize the SupplementsAndDeductionsRates class.
+
+        Args:
+            zenegy: The Zenegy instance to use for API calls
+        """
+        self.zenegy = zenegy
+        self.endpoint = f"api/companies/{self.zenegy.company_uid}/supplementsanddeductions/rates"
+
+    def get(self) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        GetSupplementRatesListDtoAsync
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        endpoint = f"{self.endpoint}/list"
+        try:
+            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='__'
+                )
+                # Validate data using schema
+                valid_data, invalid_data = Functions.validate_data(df, SupplementRatesGet)
+                return valid_data, invalid_data
+            return pd.DataFrame(), pd.DataFrame()
+        except Exception as e:
+            raise Exception(f"Failed to retrieve supplement rates: {str(e)}") from e
+
+    def get_registrations(self, employee_uid: UUID) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        GetRegistrationDtoQueryAsync
+        Args:
+            employee_uid (UUID): The employee uid
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        endpoint = f"api/companies/{self.zenegy.company_uid}/employees/{employee_uid}/supplementsanddeductions/registrations"
+        try:
+            content = self.zenegy.get(endpoint=endpoint)
+
+            # Get data from response
+            data = content.get("data", [])
+            if data:
+                # Normalize the data with nested objects
+                df = pd.json_normalize(
+                    data,
+                    sep='__'
+                )
+                # Validate data using schema
+                valid_data, invalid_data = Functions.validate_data(df, SupplementRegistrationsGet)
+                return valid_data, invalid_data
+            return pd.DataFrame(), pd.DataFrame()
+        except Exception as e:
+            raise Exception(f"Failed to retrieve supplement registrations: {str(e)}") from e