Ben Admin Kit

flux_sdk/benefits_administration/capabilities/process_employees_deductions/BUILD

@@ -0,0 +1 @@
+python_sources()

flux_sdk/benefits_administration/capabilities/process_employees_deductions/data_models.py

@@ -0,0 +1,23 @@
+from datetime import datetime
+from decimal import Decimal
+from enum import Enum
+
+
+class DeductionDetails:
+    company_id: str
+    employee_id: str
+    deduction_code: str
+    effective_from: datetime
+    end_date: datetime | None
+    employee_contribution: Decimal | None
+    company_contribution: Decimal | None
+
+class DeductionCodeField(Enum):
+    EMPLOYEE_CONTRIBUTION = "EMPLOYEE_CONTRIBUTION"
+    COMPANY_CONTRIBUTION = "COMPANY_CONTRIBUTION"
+
+class ExternalDeductionCodeToRipplingCode:
+    external_code: str
+    rippling_code: str
+    rippling_deduction_field: DeductionCodeField
+

flux_sdk/benefits_administration/capabilities/process_employees_deductions/interface.py

@@ -0,0 +1,29 @@
+from abc import ABC, abstractmethod
+from io import IOBase
+
+from flux_sdk.benefits_administration.capabilities.process_employees_deductions.data_models import (
+    DeductionDetails,
+    ExternalDeductionCodeToRipplingCode,
+)
+
+
+class ProcessEmployeesDeductions(ABC):
+    """
+    This class represents the "process employee deductions" capability. The developer is supposed to implement
+    the following methods in their implementation. 
+
+    The methods on this class are required to instantiate an instance of this class.
+    """
+
+    @staticmethod
+    @abstractmethod
+    def format_and_fetch_deduction_info(
+        stream: IOBase, deduction_code_mapping: list[ExternalDeductionCodeToRipplingCode]
+    ) -> list[DeductionDetails]:
+        """
+        This method receives the file which contains the deductions relevant to the companies employees and returns the
+        deductions details for each employee
+        :param IOBase:
+        :param list[ExternalDeductionCodeToRipplingCode]:
+        :return list[DeductionDetails]:
+        """

flux_sdk/benefits_administration/capabilities/report_employees_hr_data/BUILD

@@ -0,0 +1 @@
+python_sources()

flux_sdk/benefits_administration/capabilities/report_employees_hr_data/data_models.py

@@ -0,0 +1,84 @@
+from datetime import datetime
+from decimal import Decimal
+from enum import Enum
+
+from flux_sdk.flux_core.data_models import (
+    Employee,
+    EmployeeState,
+    EmploymentType,
+    PayFrequency,
+    PayTimeUnit,
+    TerminationType,
+)
+
+
+class ReportEmployeesHrDataConfig:
+    '''
+    This contains the application data gathered durring installation
+    which is necesary to prepare employee data or process deductions
+    '''
+    auto_enroll: bool
+    group_number: str
+    company_id: str
+
+
+class MonetaryValue:
+    value: Decimal
+    currency_type: str
+
+
+class Pay:
+    frequency: PayFrequency
+    frequency_effective_date: datetime
+    time_unit: PayTimeUnit
+    value_per_unit: MonetaryValue
+    value_effective_date: datetime
+    salary_or_equivalent: MonetaryValue
+    expected_commission: MonetaryValue | None
+
+class EmploymentHours:
+    type: EmploymentType
+    type_effective_date: datetime
+    hours_per_week: int | None
+    hours_effective_date: datetime
+
+
+class Employment:
+    hours: EmploymentHours
+    pay: Pay
+    is_rehire: bool
+    termination_date: datetime | None
+    termination_type: TerminationType | None
+    start_date: datetime
+    original_hire_date: datetime
+    w2_start_date: datetime
+
+
+class BenefitsEligibility(Enum):
+    # this will expand to cover cobra later
+    ELIGIBLE = 1
+    IN_ELIGIBLE = 2
+
+class BenefitsEligibilityStatus:
+    eligibility: BenefitsEligibility
+    effective_date: datetime
+
+class EmployeeStatus:
+    status: EmployeeState
+    effective_date: datetime
+
+
+class EmployeeHrData:
+    '''
+    This contains the core data about an employee
+    which is relevant to a benefits administration provider
+    '''
+    id: str
+    employee_number: int
+    company_tax_id: str
+    personal: Employee
+    employment: Employment
+    pay: Pay
+    status: EmployeeStatus
+    benefits_eligibility: BenefitsEligibilityStatus
+

flux_sdk/benefits_administration/capabilities/report_employees_hr_data/interface.py

@@ -0,0 +1,32 @@
+from abc import ABC, abstractmethod
+
+from flux_sdk.benefits_administration.capabilities.report_employees_hr_data.data_models import (
+    EmployeeHrData,
+    ReportEmployeesHrDataConfig,
+)
+from flux_sdk.flux_core.data_models import File
+
+
+class ReportEmployeesHrData(ABC):
+    """
+    This class represents the "report employee data" capability. The developer is supposed to implement
+    the following methods in their implementation. 
+
+    The methods on this class are required to instantiate an instance of this class.
+    """
+
+    @staticmethod
+    @abstractmethod
+    def format_employees_hr_data(
+            config: ReportEmployeesHrDataConfig,
+            employee_data: list[EmployeeHrData]
+    ) -> File:
+        """
+        This method receives the apps configuration data and a list of employee data.
+        The developer is expected to create a file, formated to their use case, and return that file.
+        The file will be tranfered to the partner company via SFTP
+
+        :param ReportEmployeesHrDataConfig:
+        :param list[EmployeeHrData]:
+        :return File:
+        """

flux_sdk/flux_core/data_models.py

@@ -212,3 +212,42 @@ class AppContext:
     customer_partner_settings: This dict contains the settings value specified on manifest in key-value pair
     """
     customer_partner_settings: dict
+
+
+class EmploymentType(Enum):
+    CONTRACTOR = 1
+    SALARIED_FT = 2
+    SALARIED_PT = 3
+    HOURLY_FT = 4
+    HOURLY_PT = 5
+    TEMP = 6
+
+
+class PayFrequency(Enum):
+    WEEKLY = 1
+    BI_WEEKLY = 2
+    MONTHLY = 3
+    SEMI_MONTHLY = 4
+    QUARTERLY = 5
+    ANNUALLY = 6
+
+
+class PayTimeUnit(Enum):
+    HOUR = 1
+    DAY = 2
+    WEEK = 3
+    MONTH = 4
+    YEAR = 5
+    PAY_PERIOD = 6
+
+
+class TerminationType(Enum):
+    VOLUNTARY = 0
+    INVOLUNTARY = 1
+    RETIREMENT = 2
+    DEATH = 3
+    ABANDONMENT = 4
+    OFFER_DECLINE = 5
+    RESCIND = 6
+    RENEGE = 7
+