brynq-sdk-nmbrs 2.3.1__py3-none-any.whl → 2.3.1.dev0__py3-none-any.whl

brynq_sdk_nmbrs/employment.py

@@ -1,9 +1,17 @@
 import math
+from typing import Any, Dict
+
 import pandas as pd
 import requests
+
 from brynq_sdk_functions import Functions
-from typing import Dict, Any
-from .schemas.employment import EmploymentGet, EmploymentCreate, EmploymentUpdate, EmploymentDelete
+
+from .schemas.employment import (
+    EmploymentCreate,
+    EmploymentDelete,
+    EmploymentGet,
+    EmploymentUpdate,
+)
 
 
 class Employment:
@@ -66,7 +74,7 @@ class Employment:
             return employment_model
 
         # Convert validated model to dict for API payload
-        payload = employment_model.model_dump(exclude_none=True, by_alias=True)
+        payload = employment_model.model_dump(exclude_none=True, by_alias=True, mode='json')
 
         # Send request
         resp = self.nmbrs.session.post(
@@ -96,7 +104,7 @@ class Employment:
             return employment_model
 
         # Convert validated model to dict for API payload
-        payload = employment_model.model_dump(exclude_none=True, by_alias=True)
+        payload = employment_model.model_dump(exclude_none=True, by_alias=True, mode='json')
 
         # Send request
         resp = self.nmbrs.session.put(

brynq_sdk_nmbrs/salaries.py

@@ -1,9 +1,12 @@
 import math
+from typing import Any, Dict
+
 import pandas as pd
 import requests
-from typing import Dict, Any
+
 from brynq_sdk_functions import Functions
-from .schemas.salary import SalaryGet, SalaryCreate
+
+from .schemas.salary import SalaryCreate, SalaryGet
 
 
 class Salaries:

brynq_sdk_nmbrs/schemas/address.py

@@ -26,7 +26,7 @@ class AddressGet(BrynQPanderaDataFrameModel):
     postal_code: Series[String] = pa.Field(coerce=True, description="Postal Code", alias="postalCode")
     city: Series[String] = pa.Field(coerce=True, description="City", alias="city")
     state_province: Series[String] = pa.Field(coerce=True, nullable=True, description="State or Province", alias="stateProvince")
-    country_i_s_o_code: Series[String] = pa.Field(coerce=True, nullable=True, description="Country ISO code", alias="countryISOCode")
+    country_iso_code: Series[String] = pa.Field(coerce=True, nullable=True, description="Country ISO code", alias="countryISOCode")
     period_year: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Year", alias="period.year")
     period_period: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Period", alias="period.period")
 
@@ -45,11 +45,10 @@ class AddressGet(BrynQPanderaDataFrameModel):
 # ---------------------------
 
 class Period(BaseModel):
-    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
-    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+    period_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
 
 class AddressCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     is_default: Optional[bool] = Field(None, description="Default Address", alias="isDefault")
     type: Annotated[
         str,
@@ -64,7 +63,7 @@ class AddressCreate(BaseModel):
     postal_code: Optional[str] = Field(None, max_length=15, example="1043BZ", description="Postal Code", alias="postalCode")
     city: str = Field(..., min_length=1, max_length=100, example="Amsterdam", description="City", alias="city")
     state_province: Optional[str] = Field(None, max_length=100, example="Noord-Holland", description="State or Province", alias="stateProvince")
-    country_code: Annotated[
+    country_iso_code: Annotated[
         str,
         StringConstraints(
             pattern=r'^[A-Za-z]+$',

brynq_sdk_nmbrs/schemas/bank.py

@@ -53,7 +53,6 @@ class BankGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class BankCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     number: Optional[str] = Field(None, max_length=34, example="123456789", description="Bank Account Number", alias="number")
     description: Optional[str] = Field(None, max_length=100, example="Salary Bank", description="Bank Account Description", alias="description")
     iban: str = Field(..., min_length=5, max_length=34, example="NL20INGB0001234567", description="IBAN", alias="IBAN")
@@ -62,7 +61,6 @@ class BankCreate(BaseModel):
     bank_account_type: Optional[BankAccountType] = Field(None, example=BankAccountType.BANK_ACCOUNT_1.value, description="Bank Account Type", alias="bankAccountType")
 
 class BankUpdate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     bank_account_id: str = Field(..., example="49a69eda-252e-4ccb-a220-38ea90511d4f", description="Bank Account ID", alias="bankAccountId")
     number: Optional[str] = Field(None, max_length=34, example="123456789", description="Bank Account Number", alias="number")
     description: Optional[str] = Field(None, max_length=100, example="Main Checking Account", description="Bank Account Description", alias="description")

brynq_sdk_nmbrs/schemas/contracts.py

@@ -5,7 +5,7 @@ from pandera.typing import Series, String, Float, DateTime
 import pandera.extensions as extensions
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
 from typing import Optional
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 from datetime import datetime
 
 # ---------------------------
@@ -19,7 +19,7 @@ class ContractGet(BrynQPanderaDataFrameModel):
     end_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="End Date Contract", alias="endDate")
     indefinite: Series[Bool] = pa.Field(coerce=True, description="Indefinite Contract", alias="indefinite")
     written_contract: Series[Bool] = pa.Field(coerce=True, description="Written Contract", alias="writtenContract")
-    weekly_hours: Series[Float] = pa.Field(coerce=True, nullable=True, description="Contract Hours per Week", alias="hoursPerWeek")
+    hours_per_week: Series[Float] = pa.Field(coerce=True, nullable=True, description="Contract Hours per Week", alias="hoursPerWeek")
     created_at: Series[DateTime] = pa.Field(coerce=True, description="Contract Created At", alias="createdAt")
 
     class _Annotation:
@@ -36,22 +36,36 @@ class ContractGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class ContractCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
-    start_date_contract: datetime = Field(..., example="2021-01-01T09:29:18Z", description="Start Date Contract", alias="startDate")
+    start_date: datetime = Field(..., example="2021-01-01T09:29:18Z", description="Start Date Contract", alias="startDate")
     trial_period: Optional[datetime] = Field(None, example="2021-02-01T00:00:00Z", description="Trial Period Contract", alias="trialPeriod")
-    end_date_contract: Optional[datetime] = Field(None, example="2021-08-24T14:15:22Z", description="End Date Contract", alias="endDate")
-    indefinite_contract: bool = Field(..., example=True, description="Indefinite Contract", alias="indefinite")
+    end_date: Optional[datetime] = Field(None, example="2021-08-24T14:15:22Z", description="End Date Contract", alias="endDate")
+    indefinite: bool = Field(..., example=True, description="Indefinite Contract", alias="indefinite")
     written_contract: Optional[bool] = Field(None, example=True, description="Written Contract", alias="writtenContract")
-    weekly_hours: Optional[float] = Field(None, ge=0, le=168, example=40, description="Contract Hours per Week", alias="hoursPerWeek")
+    hours_per_week: Optional[float] = Field(None, ge=0, le=168, example=40, description="Contract Hours per Week", alias="hoursPerWeek")
+
+    @field_validator("start_date", "trial_period", "end_date", mode="before")
+    @classmethod
+    def empty_str_to_none(cls, v):
+        """Convert empty strings to None for date fields"""
+        if v == "":
+            return None
+        return v
 
 class ContractUpdate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     contract_id: str = Field(..., example="e35e343b-55a3-4e44-bc4b-f41c3b93bcf5", description="Contract ID", alias="contractId")
     trial_period: Optional[datetime] = Field(None, example="2021-07-31T00:00:00Z", description="Trial Period Contract", alias="trialPeriod")
-    end_date_contract: Optional[datetime] = Field(None, example="2021-12-31T00:00:00Z", description="End Date Contract", alias="endDate")
-    indefinite_contract: bool = Field(..., example=True, description="Indefinite Contract", alias="indefinite")
+    end_date: Optional[datetime] = Field(None, example="2021-12-31T00:00:00Z", description="End Date Contract", alias="endDate")
+    indefinite: bool = Field(..., example=True, description="Indefinite Contract", alias="indefinite")
     written_contract: Optional[bool] = Field(None, example=True, description="Written Contract", alias="writtenContract")
-    weekly_hours: Optional[float] = Field(None, ge=0, le=168, example=20, description="Contract Hours per Week", alias="hoursPerWeek")
+    hours_per_week: Optional[float] = Field(None, ge=0, le=168, example=20, description="Contract Hours per Week", alias="hoursPerWeek")
+
+    @field_validator("trial_period", "end_date", mode="before")
+    @classmethod
+    def empty_str_to_none(cls, v):
+        """Convert empty strings to None for date fields"""
+        if v == "":
+            return None
+        return v
 
     class Config:
         primary_key = "contractId"

brynq_sdk_nmbrs/schemas/costcenter.py

@@ -1,12 +1,13 @@
+from typing import List, Optional
+
 import pandas as pd
 import pandera as pa
 from pandera import Bool
-from pandera.typing import Series, String, Float, DateTime
-import pandera.extensions as extensions
-from brynq_sdk_functions import BrynQPanderaDataFrameModel
-from typing import Optional, List
+from pandera.typing import DateTime, Float, Series, String
 from pydantic import BaseModel, Field
-from datetime import datetime
+
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
 
 # ---------------------------
 # Get Schemas
@@ -14,12 +15,12 @@ from datetime import datetime
 class EmployeeCostcenterGet(BrynQPanderaDataFrameModel):
     employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     employee_cost_center_id: Series[String] = pa.Field(coerce=True, description="Employee Cost Center ID", alias="employeeCostCenterId")
-    cost_centers_cost_center_id: Series[String] = pa.Field(coerce=True, description="Cost Center ID", alias="costCenters.costCenterId")
+    cost_center_id: Series[String] = pa.Field(coerce=True, description="Cost Center ID", alias="costCenters.costCenterId")
     cost_centers_code: Series[String] = pa.Field(coerce=True, description="Cost Centers Code", alias="costCenters.code")
     cost_centers_description: Series[String] = pa.Field(coerce=True, description="Cost Centers Description", alias="costCenters.description")
-    cost_units_cost_unit_id: Series[String] = pa.Field(coerce=True, description="Cost Unit ID", alias="costUnits.costUnitId")
-    cost_units_code: Series[String] = pa.Field(coerce=True, description="Cost Unit Code", alias="costUnits.code")
-    cost_units_description: Series[String] = pa.Field(coerce=True, description="Cost Unit Description", alias="costUnits.description")
+    cost_unit_id: Series[String] = pa.Field(coerce=True, nullable=True, description="Cost Unit ID", alias="costUnits.costUnitId")
+    cost_units_code: Series[String] = pa.Field(coerce=True, nullable=True, description="Cost Unit Code", alias="costUnits.code")
+    cost_units_description: Series[String] = pa.Field(coerce=True, nullable=True, description="Cost Unit Description", alias="costUnits.description")
     percentage: Series[Float] = pa.Field(coerce=True, description="Percentage", alias="percentage")
     default: Series[Bool] = pa.Field(coerce=True, description="Default", alias="default")
     period_year: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Year", alias="period.year")
@@ -27,7 +28,7 @@ class EmployeeCostcenterGet(BrynQPanderaDataFrameModel):
     created_at: Series[DateTime] = pa.Field(coerce=True, description="Created At", alias="createdAt")
 
     class _Annotation:
-        primary_key = "employee_cost_center_id"
+        primary_key = "cost_center_id"
         foreign_keys = {
             "employee_id": {
                 "parent_schema": "EmployeeSchema",
@@ -44,19 +45,59 @@ class CostcenterGet(BrynQPanderaDataFrameModel):
     class _Annotation:
         primary_key = "cost_center_id"
 
+# ---------------------------
+# API Response Models (Pydantic)
+# ---------------------------
+class CostCenter(BaseModel):
+    cost_center_id: str = Field(..., description="Cost Center ID", alias="costCenterId")
+    code: str = Field(..., description="Cost Center Code", alias="code")
+    description: str = Field(..., description="Cost Center Description", alias="description")
+
+
+class CostUnit(BaseModel):
+    cost_unit_id: Optional[str] = Field(None, description="Cost Unit ID", alias="costUnitId")
+    code: Optional[str] = Field(None, description="Cost Unit Code", alias="code")
+    description: Optional[str] = Field(None, description="Cost Unit Description", alias="description")
+
+
+class Period(BaseModel):
+    period_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+
+
+class EmployeeCostCenterItem(BaseModel):
+    employee_cost_center_id: str = Field(..., description="Employee Cost Center ID", alias="employeeCostCenterId")
+    cost_centers: CostCenter = Field(..., description="Cost Center", alias="costCenters")
+    cost_units: Optional[CostUnit] = Field(None, description="Cost Unit", alias="costUnits")
+    percentage: float = Field(..., description="Percentage", alias="percentage")
+    default: bool = Field(..., description="Default", alias="default")
+    period: Period = Field(..., description="Period", alias="period")
+    created_at: str = Field(..., description="Created At", alias="createdAt")
+
+
+class EmployeeCostCentersList(BaseModel):
+    employee_id: str = Field(..., description="Employee ID", alias="employeeId")
+    employee_cost_centers: List[EmployeeCostCenterItem] = Field(..., description="Employee Cost Centers", alias="employeeCostCenters")
+
+
+class EmployeeCostCentersResponse(BaseModel):
+    data: List[EmployeeCostCentersList] = Field(..., description="List of employee cost centers")
+
+
+class CostCentersResponse(BaseModel):
+    data: List[CostCenter] = Field(..., description="List of cost centers")
+
+
 # ---------------------------
 # Upload Schemas
 # ---------------------------
 class CostcenterTable(BaseModel):
-    costcenter_id: str = Field(..., example="a405f980-1c4c-42c1-8ddb-2d90c58da0b1", description="Cost Center ID", alias="costCenterId")
-    costunit_id: Optional[str] = Field(None, example="b505f980-1c4c-42c1-8ddb-2d90c58da0b2", description="Cost Unit ID", alias="costUnitId")
+    cost_center_id: str = Field(..., example="a405f980-1c4c-42c1-8ddb-2d90c58da0b1", description="Cost Center ID", alias="costCenterId")
+    cost_unit_id: Optional[str] = Field(None, example="b505f980-1c4c-42c1-8ddb-2d90c58da0b2", description="Cost Unit ID", alias="costUnitId")
     percentage: Optional[float] = Field(100, example=100, description="Percentage", alias="percentage")
     default: Optional[bool] = Field(True, example=True, description="Default", alias="default")
 
 
-class Period(BaseModel):
-    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
-    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
 
 
 class EmployeeCostcenterUpdate(BaseModel):
@@ -69,17 +110,15 @@ class EmployeeCostcenterUpdate(BaseModel):
 
 
 class EmployeeCostcenterDelete(BaseModel):
-    employee_cost_center_id: str = Field(..., example="c605f980-1c4c-42c1-8ddb-2d90c58da0b3", description="Employee Cost Center ID", alias="employeeCostCenterId")
+    cost_center_id: str = Field(..., example="c605f980-1c4c-42c1-8ddb-2d90c58da0b3", description="Employee Cost Center ID", alias="employeeCostCenterId")
 
 # CostCenter CRUD schemas - These are hypothetical since the API doesn't have create/update/delete endpoints
 # but we add them for consistency with other schema files
 class CostcenterCreate(BaseModel):
-    company_id: str = Field(..., description="Company identifier", alias="companyId")
     code: str = Field(..., example="CC001", description="Code", alias="code")
     description: str = Field(..., example="Sales Department", description="Description", alias="description")
 
 class CostcenterUpdate(BaseModel):
-    company_id: str = Field(..., description="Company identifier", alias="companyId")
     cost_center_id: str = Field(..., example="a405f980-1c4c-42c1-8ddb-2d90c58da0b1", description="Cost Center ID", alias="costCenterId")
     code: str = Field(..., example="CC001", description="Code", alias="code")
     description: str = Field(..., example="Sales Department", description="Description", alias="description")

brynq_sdk_nmbrs/schemas/costunit.py

@@ -23,12 +23,10 @@ class CostunitGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class CostunitCreate(BaseModel):
-    company_id: str = Field(..., description="Company identifier", alias="companyId")
     code: str = Field(..., example="CU001", description="Code", alias="code")
     description: str = Field(..., example="Marketing Unit", description="Description", alias="description")
 
 class CostunitUpdate(BaseModel):
-    company_id: str = Field(..., description="Company identifier", alias="companyId")
     cost_unit_id: str = Field(..., example="b505f980-1c4c-42c1-8ddb-2d90c58da0b2", description="Cost Unit ID", alias="costUnitId")
     code: str = Field(..., example="CU001", description="Code", alias="code")
     description: str = Field(..., example="Marketing Unit", description="Description", alias="description")

brynq_sdk_nmbrs/schemas/days.py

@@ -86,13 +86,11 @@ class HoursDelete(BaseModel):
 
 
 class FixedDaysCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     number_of_days: int = Field(..., ge=0, le=1000, example=40, description="Days", alias="days")
     days_for_wage_components_per_day: Optional[int] = Field(None, ge=0, le=1000, example=40, description="Days for Wage Components per Day", alias="daysForWageComponentsPerDay")
     period_details: Optional[PeriodPost] = Field(None, example="Period details", description="Period details", alias="periodDetails")
 
 class VariableDaysCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     number_of_days: int = Field(..., ge=0, le=1000, example=40, description="Days", alias="days")
     days_for_wage_components_per_day: Optional[int] = Field(None, ge=0, le=1000, example=40, description="Days for Wage Components per Day", alias="daysForWageComponentsPerDay")
     period_details: Optional[PeriodPost] = Field(None, example="Period details", description="Period details", alias="periodDetails")

brynq_sdk_nmbrs/schemas/department.py

@@ -1,12 +1,15 @@
 from datetime import datetime
+from typing import Optional
+
 import pandas as pd
 import pandera as pa
-from pandera.typing import Series, String, Float, DateTime
 import pandera.extensions as extensions
-from brynq_sdk_functions import BrynQPanderaDataFrameModel
-from typing import Optional
+from pandera.typing import DateTime, Float, Series, String
 from pydantic import BaseModel, Field
 
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
 # ---------------------------
 # Get Schemas
 # ---------------------------
@@ -33,8 +36,8 @@ class EmployeeDepartmentGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class Period(BaseModel):
-    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
-    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+    period_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
 
 class DepartmentGet(BrynQPanderaDataFrameModel):
     department_id: Series[String] = pa.Field(coerce=True, description="Department ID", alias="departmentId")
@@ -44,12 +47,10 @@ class DepartmentGet(BrynQPanderaDataFrameModel):
     managers: Series[String] = pa.Field(coerce=True, description="List of managers", alias="managers")
 
 class DepartmentCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     code: int = Field(..., ge=1, example=2, description="Department Code", alias="code")
     description: str = Field(..., min_length=1, max_length=200, example="Sales", description="Department Description", alias="description")
 
 class EmployeeDepartmentUpdate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     department_id: str = Field(..., example="3214", description="Department ID", alias="departmentId")
     period_details: Period = Field(..., example=Period(year=2021, period=4), description="Period details", alias="periodDetails")
 

brynq_sdk_nmbrs/schemas/employees.py

@@ -1,12 +1,15 @@
 import math
+from typing import Annotated, Optional
+
 import pandas as pd
 import pandera as pa
-from pandera.typing import Series, String, DateTime
 import pandera.extensions as extensions
-from brynq_sdk_functions import BrynQPanderaDataFrameModel
-from typing import Optional, Annotated
+from pandera.typing import DateTime, Series, String
 from pydantic import BaseModel, Field, StringConstraints
 
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
 # ---------------------------
 # Get Schemas
 # ---------------------------
@@ -14,29 +17,28 @@ class EmployeeGet(BrynQPanderaDataFrameModel):
     employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     personal_info_id: Series[String] = pa.Field(coerce=True, description="Personal Info ID", alias="personalInfoId")
     created_at: Series[DateTime] = pa.Field(coerce=True, description="Employee Created At", alias="createdAt", nullable=True)
-    basic_info_employee_number: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee Number", alias="basicInfo.employeeNumber")
-    basic_info_first_name: Series[String] = pa.Field(coerce=True, nullable=True, description="First Name", alias="basicInfo.firstName")
-    basic_info_first_name_in_full: Series[String] = pa.Field(coerce=True, nullable=True, description="First Name In Full", alias="basicInfo.firstNameInFull")
-    basic_info_prefix: Series[String] = pa.Field(coerce=True, nullable=True, description="Prefix", alias="basicInfo.prefix")
-    basic_info_initials: Series[String] = pa.Field(coerce=True, nullable=True, description="Initials", alias="basicInfo.initials")
-    basic_info_last_name: Series[String] = pa.Field(coerce=True, description="Last Name", alias="basicInfo.lastName")
-    basic_info_employee_type: Series[String] = pa.Field(coerce=True, description="Employee Type", alias="basicInfo.employeeType")
-    birth_info_birth_date: Series[DateTime] = pa.Field(coerce=True, description="Birth Date", alias="birthInfo.birthDate")
-    birth_info_birth_country_code_iso: Series[String] = pa.Field(coerce=True, nullable=True, description="Birth Country Code ISO", alias="birthInfo.birthCountry.codeISO")
-    birth_info_nationality_code_iso: Series[String] = pa.Field(coerce=True, nullable=True, description="Nationality Code ISO", alias="birthInfo.nationality.codeISO")
-    birth_info_gender: Series[String] = pa.Field(coerce=True, nullable=True, description="Gender", alias="birthInfo.gender")
-    contact_info_private_email: Series[String] = pa.Field(coerce=True, nullable=True, description="Private Email", alias="contactInfo.privateEmail")
-    contact_info_business_email: Series[String] = pa.Field(coerce=True, nullable=True, description="Business Email", alias="contactInfo.businessEmail")
-    contact_info_business_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Business Phone", alias="contactInfo.businessPhone")
-    contact_info_business_mobile_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Business Mobile Phone", alias="contactInfo.businessMobilePhone")
-    contact_info_private_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Private Phone", alias="contactInfo.privatePhone")
-    contact_info_private_mobile_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Private Mobile Phone", alias="contactInfo.privateMobilePhone")
-    contact_info_other_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Other Phone", alias="contactInfo.otherPhone")
-    partner_info_partner_prefix: Series[String] = pa.Field(coerce=True, nullable=True, description="Partner Prefix", alias="partnerInfo.partnerPrefix")
-    partner_info_partner_name: Series[String] = pa.Field(coerce=True, nullable=True, description="Partner Name", alias="partnerInfo.partnerName")
+    employee_number: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee Number", alias="basicInfo.employeeNumber")
+    first_name: Series[String] = pa.Field(coerce=True, nullable=True, description="First Name", alias="basicInfo.firstName")
+    first_name_in_full: Series[String] = pa.Field(coerce=True, nullable=True, description="First Name In Full", alias="basicInfo.firstNameInFull")
+    prefix: Series[String] = pa.Field(coerce=True, nullable=True, description="Prefix", alias="basicInfo.prefix")
+    initials: Series[String] = pa.Field(coerce=True, nullable=True, description="Initials", alias="basicInfo.initials")
+    last_name: Series[String] = pa.Field(coerce=True, description="Last Name", alias="basicInfo.lastName")
+    employee_type: Series[String] = pa.Field(coerce=True, description="Employee Type", alias="basicInfo.employeeType")
+    birth_date: Series[DateTime] = pa.Field(coerce=True, description="Birth Date", alias="birthInfo.birthDate")
+    birth_country_code_iso: Series[String] = pa.Field(coerce=True, nullable=True, description="Birth Country Code ISO", alias="birthInfo.birthCountry")
+    nationality_code_iso: Series[String] = pa.Field(coerce=True, nullable=True, description="Nationality Code ISO", alias="birthInfo.nationality.codeISO")
+    gender: Series[String] = pa.Field(coerce=True, nullable=True, description="Gender", alias="birthInfo.gender")
+    private_email: Series[String] = pa.Field(coerce=True, nullable=True, description="Private Email", alias="contactInfo.privateEmail")
+    business_email: Series[String] = pa.Field(coerce=True, nullable=True, description="Business Email", alias="contactInfo.businessEmail")
+    business_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Business Phone", alias="contactInfo.businessPhone")
+    business_mobile_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Business Mobile Phone", alias="contactInfo.businessMobilePhone")
+    private_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Private Phone", alias="contactInfo.privatePhone")
+    private_mobile_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Private Mobile Phone", alias="contactInfo.privateMobilePhone")
+    other_phone: Series[String] = pa.Field(coerce=True, nullable=True, description="Other Phone", alias="contactInfo.otherPhone")
+    partner_prefix: Series[String] = pa.Field(coerce=True, nullable=True, description="Partner Prefix", alias="partnerInfo.partnerPrefix")
+    partner_name: Series[String] = pa.Field(coerce=True, nullable=True, description="Partner Name", alias="partnerInfo.partnerName")
     period_year: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Year", alias="period.year")
     period_period: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Period", alias="period.period")
-    birth_info_birth_country: Series[String] = pa.Field(coerce=True, nullable=True, description="Birth Country", alias="birthInfo.birthCountry")
     company_id: Series[String] = pa.Field(coerce=True, description="Company ID", alias="companyId")
 
     class _Annotation:
@@ -46,7 +48,7 @@ class EmployeeGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class BasicInfo(BaseModel):
-    employee_id: Optional[int] = Field(None, ge=1, example=98072, description="Employee Number", alias="employeeNumber")
+    employee_number: Optional[int] = Field(None, ge=1, example=98072, description="Employee Number", alias="employeeNumber")
     first_name: Optional[str] = Field(None, max_length=50, example="John", description="First Name", alias="firstName")
     first_name_in_full: Optional[str] = Field(None, max_length=100, example="John in Full", description="First Name In Full", alias="firstNameInFull")
     prefix: Optional[str] = Field(None, max_length=50, example="van der", description="Prefix", alias="prefix")
@@ -61,7 +63,7 @@ class BasicInfo(BaseModel):
     ] = Field(..., example="payroll", description="Employee Type", alias="employeeType")
 
 class BasicInfoUpdate(BaseModel):
-    employee_id: Optional[int] = Field(None, ge=1, example=98072, description="Employee Number", alias="employeeNumber")
+    employee_number: Optional[int] = Field(None, ge=1, example=98072, description="Employee Number", alias="employeeNumber")
     first_name: Optional[str] = Field(None, max_length=50, example="John", description="First Name", alias="firstName")
     first_name_in_full: Optional[str] = Field(None, max_length=100, example="John in Full", description="First Name In Full", alias="firstNameInFull")
     prefix: Optional[str] = Field(None, max_length=50, example="van der", description="Prefix", alias="prefix")
@@ -79,7 +81,7 @@ class BirthInfo(BaseModel):
             max_length=3
         )
     ]] = Field(None, example="NL", description="Birth Country Code ISO", alias="birthCountryCodeISO")
-    nationality: Optional[Annotated[
+    nationality_code_iso: Optional[Annotated[
         str,
         StringConstraints(
             pattern=r'^[A-Za-z]+$',
@@ -92,16 +94,16 @@ class BirthInfo(BaseModel):
     gender: Optional[Annotated[
         str,
         StringConstraints(
-            pattern=r'^(unspecified|male|female|unknown)$',
+            pattern=r'^(|unspecified|male|female|unknown)$',
             strip_whitespace=True
         )
     ]] = Field(None, example="male", description="Gender", alias="gender")
 
 class ContactInfo(BaseModel):
-    email_private: Optional[str] = Field(None, max_length=100, example="doe@private.com", description="Private Email", alias="privateEmail")
-    email_work: Optional[str] = Field(None, max_length=100, example="doe@business.com", description="Business Email", alias="businessEmail")
-    phone_work: Optional[str] = Field(None, max_length=50, example="+351222222", description="Business Phone", alias="businessPhone")
-    mobile_work: Optional[str] = Field(None, max_length=50, example="+351222222", description="Business Mobile Phone", alias="businessMobilePhone")
+    private_email: Optional[str] = Field(None, max_length=100, example="doe@private.com", description="Private Email", alias="privateEmail")
+    business_email: Optional[str] = Field(None, max_length=100, example="doe@business.com", description="Business Email", alias="businessEmail")
+    business_phone: Optional[str] = Field(None, max_length=50, example="+351222222", description="Business Phone", alias="businessPhone")
+    business_mobile_phone: Optional[str] = Field(None, max_length=50, example="+351222222", description="Business Mobile Phone", alias="businessMobilePhone")
     private_phone: Optional[str] = Field(None, max_length=50, example="+351222222", description="Private Phone", alias="privatePhone")
     private_mobile_phone: Optional[str] = Field(None, max_length=50, example="+351222222", description="Private Mobile Phone", alias="privateMobilePhone")
     other_phone: Optional[str] = Field(None, max_length=50, example="+351222222", description="Other Phone", alias="otherPhone")
@@ -112,12 +114,12 @@ class PartnerInfo(BaseModel):
     ascription_code: Optional[int] = Field(None, ge=0, example=0, description="Ascription Code", alias="ascriptionCode")
 
 class Period(BaseModel):
-    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
-    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+    period_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
 
 class AdditionalEmployeeInfo(BaseModel):
-    in_service_date: str = Field(..., example="2019-08-24", description="In Service Date", alias="inServiceDate")
-    default_employee_template: Optional[str] = Field(None, description="Default Employee Template", alias="defaultEmployeeTemplate")
+    in_service_date: Optional[str] = Field(None, example="2019-08-24", description="In Service Date", alias="inServiceDate")
+    default_employee_template: Optional[str] = Field(None, description="Default employee template unique identifier to be only used for employee's of type Payroll", alias="defaultEmployeeTemplate")
 
 class CreateEmployeePersonalInfo(BaseModel):
     basic_info: BasicInfo  = Field(..., alias="basicInfo")
@@ -128,12 +130,10 @@ class CreateEmployeePersonalInfo(BaseModel):
     created_at: Optional[str] = Field(None, example="2021-07-01T10:15:08Z", description="Created At", alias="createdAt")
 
 class EmployeeCreate(BaseModel):
-    company_id: str = Field(..., description="Company identifier", alias="companyId")
     personal_info: CreateEmployeePersonalInfo = Field(..., alias="personalInfo")
     additional_employee_info: AdditionalEmployeeInfo = Field(..., alias="additionalEmployeeInfo")
 
 class EmployeeUpdate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     basic_info: Optional[BasicInfoUpdate] = Field(None, alias="basicInfo")
     birth_info: Optional[BirthInfo] = Field(None, alias="birthInfo")
     contact_info: Optional[ContactInfo] = Field(None, alias="contactInfo")
@@ -151,3 +151,7 @@ class BsnGet(BrynQPanderaDataFrameModel):
 
     class _Annotation:
         primary_key = "employee_id"
+
+class DefaultEmployeeTemplates(BrynQPanderaDataFrameModel):
+    default_employee_template: Series[String] = pa.Field(coerce=True, description="UID of the default employee tempalte", alias="defaultEmployeeTemplateId")
+    description: Series[String] = pa.Field(coerce=True, description="The description of the default employee template ")

brynq_sdk_nmbrs/schemas/employment.py

@@ -1,13 +1,15 @@
+from datetime import datetime
+from typing import Optional
+
 import pandas as pd
 import pandera as pa
-from pandera import Bool
-from pandera.typing import Series, String, Float, DateTime
 import pandera.extensions as extensions
+from pandera import Bool
+from pandera.typing import DateTime, Float, Series, String
+from pydantic import BaseModel, Field
+
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
-from typing import Optional
-from pydantic import BaseModel, Field
-from datetime import datetime
 
 # ---------------------------
 # Get Schemas
@@ -33,16 +35,14 @@ class EmploymentGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class EmploymentCreate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     start_date: datetime = Field(..., example="2021-06-07T07:59:11Z", description="Start Date Employment", alias="startDate")
     seniority_date: Optional[datetime] = Field(None, example="2021-06-09T07:59:11Z", description="Seniority Date Employment", alias="seniorityDate")
 
 class EmploymentUpdate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     employment_id: str = Field(..., example="a405f980-1c4c-42c1-8ddb-2d90c58da0b1", description="Employment ID", alias="employmentId")
     seniority_date: Optional[datetime] = Field(None, example="2021-06-07T07:59:11Z", description="Seniority Date Employment", alias="seniorityDate")
-    end_of_service_date: Optional[datetime] = Field(None, example="2021-10-01T00:00:00Z", description="End of Service Date Employment", alias="endOfServiceDate")
-    end_of_contract_reason: Optional[int] = Field(None, ge=0, example=3, description="End of Contract Reason Employment", alias="endOfContractReason")
+    end_date: Optional[datetime] = Field(None, example="2021-10-01T00:00:00Z", description="End of Service Date Employment", alias="endOfServiceDate")
+    end_contract_reason: Optional[int] = Field(None, ge=0, example=3, description="End of Contract Reason Employment", alias="endOfContractReason")
 
 class EmploymentDelete(BaseModel):
-    employment_id: str = Field(..., example="a405f980-1c4c-42c1-8ddb-2d90c58da0b1", description="Employment ID", alias="employmentId")
+    employment_id: str = Field(..., example="a405f980-1c4c-42c1-8ddb-2d90c58da0b1", description="Employment ID", alias="employmentId")

brynq_sdk_nmbrs/schemas/function.py

@@ -1,13 +1,14 @@
 from datetime import datetime
+from typing import Optional
 
 import pandas as pd
 import pandera as pa
-from pandera.typing import Series, String, Float, DateTime
 import pandera.extensions as extensions
+from pandera.typing import DateTime, Float, Series, String
+from pydantic import BaseModel, Field
+
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
-from typing import Optional
-from pydantic import BaseModel, Field
 
 # ---------------------------
 # Get Schemas
@@ -35,16 +36,14 @@ class EmployeeFunctionGet(BrynQPanderaDataFrameModel):
 # Upload Schemas
 # ---------------------------
 class Period(BaseModel):
-    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
-    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+    period_year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period_period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
 
 class FunctionGet(BrynQPanderaDataFrameModel):
     function_id: Series[pa.String] = pa.Field(coerce=True, description="Function ID", alias="functionId")
     code: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Function Code", alias="code")
     description: Series[pa.String] = pa.Field(coerce=True, description="Function Description", alias="description")
-    created_at: Series[datetime] = pa.Field(coerce=True, description="Function Created At", alias="createdAt")
 
 class FunctionUpdate(BaseModel):
-    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
     function_id: str = Field(..., example="5981", description="Function ID", alias="functionId")
     period_details: Period = Field(..., alias="periodDetails")