brynq-sdk-acerta 1.1.1__py3-none-any.whl

brynq_sdk_acerta/schemas/family.py

@@ -0,0 +1,220 @@
+"""
+Schemas for Family resource
+"""
+
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series
+from pydantic import BaseModel, Field
+from typing import Optional, Literal
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+class FamilyMemberGet(BrynQPanderaDataFrameModel):
+    """Schema for GET /v2/employees/{employeeId}/family-members endpoint"""
+
+    employee_id: Series[pd.StringDtype] = pa.Field(coerce=True, description="The employeeId is the unique identifier for an employee", alias="employeeId")
+    external_reference_type: Series[pd.StringDtype] = pa.Field(coerce=True, description="Identifies you as a consumer and is identical for each employee of the same consumer", alias="externalReferences.externalReferenceType")
+    external_reference_number: Series[pd.StringDtype] = pa.Field(coerce=True, description="Identifies the employee for this consumer and is unique for each employee of the same consumer", alias="externalReferences.externalReferenceNumber")
+    company_organisation_number: Series[pd.StringDtype] = pa.Field(coerce=True, description="Identifies the company organisation (COR/BOR) this employee is linked to", alias="externalReferences.companyOrganisationNumber")
+    period_start_date: Series[pd.StringDtype] = pa.Field(coerce=True, description="Start date of the family member period", alias="familyMembersSegments.period.startDate")
+    period_end_date: Series[pd.StringDtype] = pa.Field(coerce=True, description="End date of the family member period", alias="familyMembersSegments.period.endDate")
+    family_member_id: Series[pd.StringDtype] = pa.Field(coerce=True, description="The identifier of the family member in the associated history segment", alias="familyMemberId")
+    first_name: Series[pd.StringDtype] = pa.Field(coerce=True, description="First name of the family member", alias="personalData.name.firstName")
+    last_name: Series[pd.StringDtype] = pa.Field(coerce=True, description="Last name of the family member", alias="personalData.name.lastName")
+    birth_day: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Birth day of the family member", alias="personalData.birthDay")
+    decease_date: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Decease date of the family member", alias="personalData.deceaseDate")
+    relationship_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Relationship code", alias="personalData.relationship.code")
+    relationship_description: Series[pd.StringDtype] = pa.Field(coerce=True, description="Relationship description", alias="personalData.relationship.description")
+    gender_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Gender code", alias="personalData.gender.code")
+    gender_description: Series[pd.StringDtype] = pa.Field(coerce=True, description="Gender description", alias="personalData.gender.description")
+    dependent_persons: Series[pd.BooleanDtype] = pa.Field(coerce=True, description="Dependant indicator", alias="dependentDisabledPersons.dependentPersons")
+    disabled_person: Series[pd.BooleanDtype] = pa.Field(coerce=True, description="Disabled indicator", alias="dependentDisabledPersons.disabledPerson")
+    degree_self_reliance: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Disability degree", alias="dependentDisabledPersons.degreeSelfReliance")
+    in_group_insurance: Series[pd.BooleanDtype] = pa.Field(coerce=True, description="Group insurance indicator", alias="insurance.inGroupInsurance")
+    in_hospital_insurance: Series[pd.BooleanDtype] = pa.Field(coerce=True, description="Hospitalisation insurance indicator", alias="insurance.inHospitalInsurance")
+    comment: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Comment of the family member", alias="comment")
+
+    class _Annotation:
+        primary_key = "family_member_id"
+        foreign_keys = {
+            "employee_id": {"parent_schema": "EmployeeGet", "parent_column": "employee_id", "cardinality": "N:1"}
+        }
+
+    class Config:
+        metadata = {"class": "FamilyMember", "dependencies": []}
+
+
+class CivilStatus(BaseModel):
+    """Reusable civil status schema - no prefix in field names"""
+    status: str = Field(..., min_length=2, max_length=2, example="06", description="Marital status code", alias="status")
+    in_effect_date: Optional[str] = Field(None, example="2022-01-01", description="Date from which the marital status is valid", alias="inEffectDate")
+    date_of_marriage_or_cohabitation: Optional[str] = Field(None, example="2022-01-01", description="Date of marriage or cohabitation", alias="dateOfMarriageOrCohabitation")
+
+    class Config:
+        populate_by_name = True
+
+
+class Partner(BaseModel):
+    """Reusable partner schema - no prefix in field names"""
+    last_name: Optional[str] = Field(None, min_length=1, max_length=35, example="Achternaam", description="Partner last name", alias="lastName")
+    first_name: Optional[str] = Field(None, min_length=1, max_length=35, example="Voornaam", description="Partner first name", alias="firstName")
+    birth_date: Optional[str] = Field(None, example="2022-01-01", description="Partner birth date", alias="birthDate")
+    is_disabled: Optional[bool] = Field(None, description="Partner disabled indicator", alias="isDisabled")
+    income: Optional[str] = Field(None, min_length=2, max_length=2, example="01", description="Partner income code", alias="income")
+
+    class Config:
+        populate_by_name = True
+
+
+class DependantsChildren(BaseModel):
+    """Reusable children dependants schema - no prefix in field names"""
+    not_disabled: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of dependant not disabled children", alias="notDisabled")
+    disabled: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of disabled dependant children", alias="disabled")
+
+    class Config:
+        populate_by_name = True
+
+
+class DependantsOver65(BaseModel):
+    """Reusable over 65 dependants schema - no prefix in field names"""
+    not_disabled: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of not disabled dependants over 65", alias="notDisabled")
+    disabled: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of disabled dependants over 65", alias="disabled")
+    needing_care: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of dependants over 65 needing care", alias="needingCare")
+
+    class Config:
+        populate_by_name = True
+
+
+class DependantsOthers(BaseModel):
+    """Reusable other dependants schema - no prefix in field names"""
+    not_disabled: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of not disabled other dependants", alias="notDisabled")
+    disabled: Optional[int] = Field(None, ge=0, le=99, example=1, description="Number of other disabled dependants", alias="disabled")
+
+    class Config:
+        populate_by_name = True
+
+
+class Dependants(BaseModel):
+    """Dependants container schema - uses json_schema_extra for prefixes"""
+    children: Optional[DependantsChildren] = Field(None, description="Number of dependent children", alias="children", json_schema_extra={"prefix": "children_"})
+    over65: Optional[DependantsOver65] = Field(None, description="Number of dependent persons 65+", alias="over65", json_schema_extra={"prefix": "over65_"})
+    others: Optional[DependantsOthers] = Field(None, description="Number of other dependent persons", alias="others", json_schema_extra={"prefix": "others_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class FiscalDetails(BaseModel):
+    """Reusable fiscal details schema - no prefix in field names"""
+    has_family_burden: Optional[bool] = Field(None, description="Dependent family in case of early retirement", alias="hasFamilyBurden")
+    is_unmarried_with_dependant_child: Optional[bool] = Field(None, description="Not married with dependent child", alias="isUnmarriedWithDependantChild")
+    is_disabled: Optional[bool] = Field(None, description="Disabled indicator", alias="isDisabled")
+    merging_gross_net_calculation: Optional[str] = Field(None, min_length=2, max_length=2, example="02", description="Merging gross net calculation code", alias="mergingGrossNetCalculation")
+    is_young_employee: Optional[bool] = Field(None, description="Young employee", alias="isYoungEmployee")
+    tax_volunteerism_amount: Optional[float] = Field(None, description="Additional monthly payroll withholding tax amount", alias="taxVolunteerismAmount")
+
+    class Config:
+        populate_by_name = True
+
+
+class FamilySituationUpdate(BaseModel):
+    """Schema for PATCH /v3/employees/{employeeId}/family-situation - uses json_schema_extra for prefixes"""
+    # Function parameters
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+
+    from_date: Optional[str] = Field(None, example="2022-01-01", description="Date from when this data is valid", alias="fromDate")
+    civil_status: Optional[CivilStatus] = Field(None, description="Civil status of the employee", alias="civilStatus", json_schema_extra={"prefix": "civil_status_"})
+    partner: Optional[Partner] = Field(None, description="Information regarding the partner", alias="partner", json_schema_extra={"prefix": "partner_"})
+    dependants: Optional[Dependants] = Field(None, description="Number of dependent persons", alias="dependants", json_schema_extra={"prefix": "dependants_"})
+    fiscal_details: Optional[FiscalDetails] = Field(None, description="Fiscal details", alias="fiscalDetails", json_schema_extra={"prefix": "fiscal_details_"})
+
+    class Config:
+        populate_by_name = True
+
+
+# POST Schemas for Family Members
+class FamilyMemberName(BaseModel):
+    """Reusable family member name schema - no prefix in field names"""
+    first_name: str = Field(..., min_length=1, max_length=35, example="SAL", description="First name of the family member", alias="firstName")
+    last_name: str = Field(..., min_length=1, max_length=35, example="FERIT", description="Last name of the family member", alias="lastName")
+
+    class Config:
+        populate_by_name = True
+
+
+class FamilyMemberPersonalia(BaseModel):
+    """Reusable family member personalia schema - no prefix in field names, uses json_schema_extra for name prefix"""
+    relationship: Optional[str] = Field(None, example="09", description="The relationship of this family member", alias="relationship")
+    name: FamilyMemberName = Field(..., description="Name", alias="name", json_schema_extra={"prefix": "name_"})
+    birth_date: Optional[str] = Field(None, example="2000-01-01", description="Birth date of the family member", alias="birthDate")
+    decease_date: Optional[str] = Field(None, example="2000-01-01", description="Death date of the family member", alias="deceaseDate")
+    gender: Optional[str] = Field(None, example="V", description="Gender of the family member", alias="gender")
+
+    class Config:
+        populate_by_name = True
+
+
+class FamilyMemberOther(BaseModel):
+    """Reusable family member other data schema - no prefix in field names"""
+    dependant_persons: bool = Field(..., example=True, description="Dependant indicator", alias="dependantPersons")
+    disabled_person: bool = Field(..., example=True, description="Disabled indicator", alias="disabledPerson")
+    degree_self_reliance: Optional[int] = Field(None, ge=0, le=99, example=18, description="Disability degree", alias="degreeSelfReliance")
+    in_group_insurance: bool = Field(..., example=True, description="Group insurance indicator", alias="inGroupInsurance")
+    in_hospital_insurance: bool = Field(..., example=True, description="Hospitalisation insurance indicator", alias="inHospitalInsurance")
+
+    class Config:
+        populate_by_name = True
+
+
+class FamilyMemberCreate(BaseModel):
+    """Schema for POST /v1/employees/{employeeId}/family-members endpoint - uses json_schema_extra for prefixes"""
+    # Function parameters
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+
+    valid_from: str = Field(..., example="2025-10-16", description="Date when the change is registered", alias="validFrom")
+    history_from_date: Optional[str] = Field(None, example="2025-10-16", description="Date on which the value of the returned historical data is valid", alias="historyFromDate")
+    sequence: Optional[str] = Field(None, min_length=3, max_length=3, example="001", description="Unique number per family member", alias="sequence")
+    personalia: FamilyMemberPersonalia = Field(..., description="Personalia", alias="personalia", json_schema_extra={"prefix": "personalia_"})
+    other: Optional[FamilyMemberOther] = Field(None, description="Other", alias="other", json_schema_extra={"prefix": "other_"})
+
+    class Config:
+        populate_by_name = True
+
+
+# GET Schema for Family Situations
+class FamilySituationGet(BrynQPanderaDataFrameModel):
+    """Schema for GET /v3/employees/{employeeId}/family-situations endpoint"""
+
+    employee_id: Series[pd.StringDtype] = pa.Field(coerce=True, description="Employee identifier", alias="employeeId")
+    period_start_date: Series[pd.StringDtype] = pa.Field(coerce=True, description="Family situation period start date", alias="period.startDate")
+    period_end_date: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Family situation period end date", alias="period.endDate")
+    civil_status_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Marital status code", alias="civilStatus.status.code")
+    civil_status_description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Marital status description", alias="civilStatus.status.description")
+    civil_status_in_effect_date: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Date from which the marital status is valid", alias="civilStatus.inEffectDate")
+    civil_status_date_of_marriage_or_cohabitation: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Date of marriage or cohabitation", alias="civilStatus.dateOfMarriageOrCohabitation")
+    partner_last_name: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Partner last name", alias="partner.lastName")
+    partner_first_name: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Partner first name", alias="partner.firstName")
+    partner_birth_date: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Partner birth date", alias="partner.birthDate")
+    partner_is_disabled: Series[pd.BooleanDtype] = pa.Field(coerce=True, nullable=True, description="Partner disabled indicator", alias="partner.isDisabled")
+    partner_income_code: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Partner income code", alias="partner.income.code")
+    partner_income_description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Partner income description", alias="partner.income.description")
+    dependants_children_not_disabled: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of dependant not disabled children", alias="dependants.children.notDisabled")
+    dependants_children_disabled: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of disabled dependant children", alias="dependants.children.disabled")
+    dependants_over65_not_disabled: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of not disabled dependants over 65", alias="dependants.over65.notDisabled")
+    dependants_over65_disabled: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of disabled dependants over 65", alias="dependants.over65.disabled")
+    dependants_over65_needing_care: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of dependants over 65 needing care", alias="dependants.over65.needingCare")
+    dependants_others_not_disabled: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of not disabled other dependants", alias="dependants.others.notDisabled")
+    dependants_others_disabled: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Number of other disabled dependants", alias="dependants.others.disabled")
+    fiscal_details_has_family_burden: Series[pd.BooleanDtype] = pa.Field(coerce=True, nullable=True, description="Dependent family in case of early retirement", alias="fiscalDetails.hasFamilyBurden")
+    fiscal_details_is_unmarried_with_dependant_child: Series[pd.BooleanDtype] = pa.Field(coerce=True, nullable=True, description="Not married with dependent child", alias="fiscalDetails.isUnmarriedWithDependantChild")
+    fiscal_details_is_disabled: Series[pd.BooleanDtype] = pa.Field(coerce=True, description="Disabled indicator", alias="fiscalDetails.isDisabled")
+    fiscal_details_merging_gross_net_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Merging gross net calculation code", alias="fiscalDetails.mergingGrossNetCalculation.code")
+    fiscal_details_merging_gross_net_description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Merging gross net calculation description", alias="fiscalDetails.mergingGrossNetCalculation.description")
+    fiscal_details_is_young_employee: Series[pd.BooleanDtype] = pa.Field(coerce=True, nullable=True, description="Young employee indicator", alias="fiscalDetails.isYoungEmployee")
+    fiscal_details_tax_volunteerism_amount: Series[pd.Float64Dtype] = pa.Field(coerce=True, nullable=True, description="Tax volunteerism amount", alias="fiscalDetails.taxVolunteerismAmount")
+
+    class _Annotation:
+        primary_key = "employee_id"
+
+    class Config:
+        metadata = {"class": "FamilySituation", "dependencies": []}

brynq_sdk_acerta/schemas/in_service.py

@@ -0,0 +1,243 @@
+"""
+Schemas for Employment resource
+
+Following BrynQ SDK standards:
+- Base schemas have no prefixes (reusable building blocks)
+- Composite schemas use json_schema_extra={"prefix": "..."} for flat-to-nested conversion
+- Uses Functions.flat_to_nested_with_prefix() in resource methods
+"""
+
+from pydantic import BaseModel, Field
+from typing import Optional, List, Literal
+
+
+# ============================================
+# BASE SCHEMAS (Reusable, No Prefixes)
+# ============================================
+
+class Name(BaseModel):
+    """Reusable name schema - no prefix in field names"""
+    last_name: str = Field(..., min_length=1, max_length=35, example="Janssens", description="The last name", alias="lastName")
+    first_name: str = Field(..., min_length=1, max_length=35, example="Ben", description="The first name", alias="firstName")
+
+    class Config:
+        populate_by_name = True
+
+
+class Birth(BaseModel):
+    """Reusable birth schema - no prefix in field names"""
+    date_of_birth: str = Field(..., example="2022-01-01", description="Date of birth", alias="dateOfBirth")
+    place_of_birth: Optional[str] = Field(None, min_length=1, max_length=35, example="Leuven", description="Place of birth", alias="placeOfBirth")
+    country_of_birth: Optional[str] = Field(None, min_length=3, max_length=3, example="150", description="NIS Code of the nationality", alias="countryOfBirth")
+
+    class Config:
+        populate_by_name = True
+
+
+class Address(BaseModel):
+    """Reusable address schema - no prefix in field names"""
+    type: Literal["OFFICIAL", "CORRESPONDENCE"] = Field(..., example="OFFICIAL", description="Type of address", alias="type")
+    street: str = Field(..., min_length=1, max_length=40, example="Bondgenotenlaan", description="Street name", alias="street")
+    house_number: str = Field(..., min_length=1, max_length=9, example="2", description="House number", alias="houseNumber")
+    post_box: Optional[str] = Field(None, min_length=1, max_length=4, example="A", description="Post box", alias="postBox")
+    postal_code: str = Field(..., min_length=1, max_length=14, example="3000", description="Postal code", alias="postalCode")
+    community: str = Field(..., min_length=1, max_length=35, example="Leuven", description="Community name", alias="community")
+    country: str = Field(..., min_length=3, max_length=3, example="150", description="NIS Code of the country", alias="country")
+
+    class Config:
+        populate_by_name = True
+
+
+class ContactInformation(BaseModel):
+    """Reusable contact information schema - no prefix in field names"""
+    contact_scope: Literal["WORK", "PERSONAL"] = Field(..., example="WORK", description="Contact scope", alias="contactScope")
+    contact_method: Literal["EMAIL", "TELEPHONE", "MOBILE"] = Field(..., example="EMAIL", description="Contact method", alias="contactMethod")
+    contact_value: str = Field(..., min_length=1, max_length=100, example="test@example.com", description="Contact value", alias="contactValue")
+
+    class Config:
+        populate_by_name = True
+
+
+class Dependant(BaseModel):
+    """Reusable dependant schema - no prefix in field names"""
+    not_disabled: int = Field(..., ge=0, le=99, example=1, description="Number of not disabled dependants", alias="notDisabled")
+    disabled: int = Field(..., ge=0, le=99, example=0, description="Number of disabled dependants", alias="disabled")
+
+    class Config:
+        populate_by_name = True
+
+
+class Dependant65plus(BaseModel):
+    """Reusable dependant 65+ schema - no prefix in field names"""
+    not_disabled: int = Field(..., ge=0, le=99, example=1, description="Number of not disabled dependants over 65", alias="notDisabled")
+    disabled: int = Field(..., ge=0, le=99, example=0, description="Number of disabled dependants over 65", alias="disabled")
+    needing_care: int = Field(..., ge=0, le=99, example=0, description="Number of dependants over 65 needing care", alias="needingCare")
+
+    class Config:
+        populate_by_name = True
+
+
+class BankAccount(BaseModel):
+    """Reusable bank account schema - no prefix in field names"""
+    iban: str = Field(..., min_length=5, max_length=34, example="BE11456373772248", description="IBAN", alias="iban")
+    bic: Optional[str] = Field(None, min_length=8, max_length=11, example="NTSBDEB1XXX", description="BIC code", alias="bic")
+
+    class Config:
+        populate_by_name = True
+
+
+class C32a(BaseModel):
+    """Reusable C32a schema - no prefix in field names"""
+    current_month: str = Field(..., min_length=3, max_length=13, description="Current month", alias="currentMonth")
+    next_month: str = Field(..., min_length=3, max_length=13, description="Next month", alias="nextMonth")
+
+    class Config:
+        populate_by_name = True
+
+
+class EmploymentPeriod(BaseModel):
+    """Reusable employment period schema - no prefix in field names"""
+    start_date: str = Field(..., example="2025-10-16", description="Employment start date", alias="startDate")
+    end_date: Optional[str] = Field(None, example="2025-10-16", description="Employment end date", alias="endDate")
+
+    class Config:
+        populate_by_name = True
+
+
+class PersonalData(BaseModel):
+    """Schema for personal data - uses json_schema_extra for prefixes"""
+    national_registration_number: str = Field(..., pattern=r"^\d{11}$", example="86022402508", description="National registration number", alias="nationalRegistrationNumber")
+    name: Name = Field(..., description="Full name of the employee", alias="name", json_schema_extra={"prefix": "name_"})
+    gender: Literal["M", "V"] = Field(..., example="M", description="Gender", alias="gender")
+    nationality: str = Field(..., pattern=r"^\d{3}$", example="150", description="NIS Code of the nationality", alias="nationality")
+    official_language: Optional[Literal["NL", "FR", "DE", "EN"]] = Field(None, example="NL", description="Official language", alias="officialLanguage")
+    spoken_language: Optional[Literal["NL", "FR", "DE", "EN"]] = Field(None, example="NL", description="Spoken language", alias="spokenLanguage")
+    birth: Birth = Field(..., description="Birth information", alias="birth", json_schema_extra={"prefix": "birth_"})
+    is_disabled: Optional[bool] = Field(None, description="Disabled indicator", alias="isDisabled")
+
+    class Config:
+        populate_by_name = True
+
+
+class AddressData(BaseModel):
+    """Schema for address data - supports list with indexed prefixes"""
+    addresses: List[Address] = Field(..., min_items=1, max_items=2, description="List of addresses", alias="addresses", json_schema_extra={"prefix": "addresses_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class ContactInformationData(BaseModel):
+    """Schema for contact information data - supports list with indexed prefixes"""
+    contact_information: List[ContactInformation] = Field(..., max_items=6, description="List of contact information", alias="contactInformation", json_schema_extra={"prefix": "contact_information_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class Dependants(BaseModel):
+    """Schema for all dependants - uses json_schema_extra for prefixes"""
+    children: Optional[Dependant] = Field(None, description="Dependent children", alias="children", json_schema_extra={"prefix": "children_"})
+    sixty_five_plus: Optional[Dependant65plus] = Field(None, description="Dependent 65+", alias="65plus", json_schema_extra={"prefix": "65plus_"})
+    others: Optional[Dependant] = Field(None, description="Other dependents", alias="others", json_schema_extra={"prefix": "others_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class PartnerInformation(BaseModel):
+    """Schema for partner information - uses json_schema_extra for prefixes"""
+    name: Optional[Name] = Field(None, description="Partner name", alias="name", json_schema_extra={"prefix": "name_"})
+    date_of_birth: Optional[str] = Field(None, example="1956-10-30", description="Partner date of birth", alias="dateOfBirth")
+    income_type: Optional[Literal["SINGLE", "DOUBLE", "NO_INCOME"]] = Field(None, example="SINGLE", description="Income type", alias="incomeType")
+    is_disabled: Optional[bool] = Field(None, description="Partner disabled indicator", alias="isDisabled")
+
+    class Config:
+        populate_by_name = True
+
+
+class FamilySituation(BaseModel):
+    """Schema for family situation - uses json_schema_extra for prefixes"""
+    marital_status: Literal["SINGLE", "MARRIED", "WIDOWED", "DIVORCED", "SEPARATED", "LEGAL_COHABITATION"] = Field(..., example="SINGLE", description="Marital status", alias="maritalStatus")
+    marital_status_date: Optional[str] = Field(None, example="1984-10-30", description="Date when civil status was applied", alias="maritalStatusDate")
+    date_of_marriage_or_cohabitation: Optional[str] = Field(None, example="1984-10-30", description="Date of marriage or cohabitation", alias="dateOfMarriageOrCohabitation")
+    partner_information: Optional[PartnerInformation] = Field(None, description="Partner information", alias="partnerInformation", json_schema_extra={"prefix": "partner_information_"})
+    dependants: Optional[Dependants] = Field(None, description="Dependants information", alias="dependants", json_schema_extra={"prefix": "dependants_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class EmployeeDetails(BaseModel):
+    """Schema for employee details - uses json_schema_extra for prefixes"""
+    personal_data: PersonalData = Field(..., description="Personal data", alias="personalData", json_schema_extra={"prefix": "personal_data_"})
+    address_data: AddressData = Field(..., description="Address data", alias="addressData", json_schema_extra={"prefix": "address_data_"})
+    contact_information_data: Optional[ContactInformationData] = Field(None, description="Contact information data", alias="contactInformationData", json_schema_extra={"prefix": "contact_information_data_"})
+    family_situation_data: Optional[FamilySituation] = Field(None, description="Family situation data", alias="familySituationData", json_schema_extra={"prefix": "family_situation_data_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class EmployerDetails(BaseModel):
+    """Schema for employer details - no nested prefixes needed"""
+    official_joint_committee: Optional[str] = Field(None, pattern=r"^\d{6}$", example="302000", description="Official joint committee code", alias="officialJointCommittee")
+    business_unit: Optional[str] = Field(None, pattern=r"^\d{10}$", example="2288734794", description="The code of the business unit", alias="businessUnit")
+
+    class Config:
+        populate_by_name = True
+
+
+class EmploymentDetails(BaseModel):
+    """Schema for employment details - uses json_schema_extra for prefixes"""
+    employee_type: Literal["WHITE_COLLAR", "LABOURER", "BLUE_COLLAR", "STUDENT_BLUE_COLLAR", "STUDENT_WHITE_COLLAR", "FLEX_BLUE_COLLAR", "FLEX_WHITE_COLLAR"] = Field(..., description="Employee type", alias="employeeType")
+    agreement_type: Optional[Literal["INTERNAL", "EXTERNAL"]] = Field(None, description="Type of the agreement", alias="agreementType")
+    employment_period: EmploymentPeriod = Field(..., description="Employment period", alias="employmentPeriod", json_schema_extra={"prefix": "employment_period_"})
+    in_organization_date: Optional[str] = Field(None, example="2025-10-16", description="In organization date", alias="inOrganizationDate")
+    remuneration: Optional[BankAccount] = Field(None, description="Remuneration bank account", alias="remuneration", json_schema_extra={"prefix": "remuneration_"})
+    c32a: Optional[C32a] = Field(None, description="C32a information", alias="c32a", json_schema_extra={"prefix": "c32a_"})
+    function: Optional[str] = Field(None, min_length=1, max_length=8, description="Function code", alias="function")
+    hours_per_week_full_time: Optional[float] = Field(None, ge=0, le=99, description="Hours per week full time", alias="hoursPerWeekFullTime")
+    number_of_numerator_employment_fraction: Optional[float] = Field(None, description="Number of numerator employment fraction", alias="numberOfNumeratorEmploymentFraction")
+    number_of_work_regime: Optional[float] = Field(None, le=7, description="Number of work regime", alias="numberOfWorkRegime")
+    students_quarters: Optional[List[int]] = Field(None, min_items=1, max_items=5, example=[10], description="Students quarters", alias="studentsQuarters")
+    is_disabled_for_nsso: Optional[bool] = Field(None, description="Is disabled for NSSO", alias="isDisabledForNSSO")
+
+    class Config:
+        populate_by_name = True
+
+
+
+class EmploymentCreate(BaseModel):
+    """
+    Schema for POST /employers/{employerId}/employments endpoint - New employee & agreement
+
+    Uses json_schema_extra with prefixes for flat-to-nested conversion support.
+    Works with Functions.flat_to_nested_with_prefix() to convert flat dictionaries
+    to properly nested structures.
+    """
+    employee: EmployeeDetails = Field(..., description="The details of a new employee", alias="employee", json_schema_extra={"prefix": "employee_"})
+    employer: Optional[EmployerDetails] = Field(None, description="Employer details", alias="employer", json_schema_extra={"prefix": "employer_"})
+    employment: EmploymentDetails = Field(..., description="Employment details", alias="employment", json_schema_extra={"prefix": "employment_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class EmploymentRehire(BaseModel):
+    """
+    Schema for POST /employers/{employerId}/employees/{employeeId}/employments endpoint - Existing employee
+
+    This endpoint enables rehiring a previously known employee. The employee is already known
+    within Connect for the employer (BOR level) and has an existing employeeId. Personal data
+    is not required.
+
+    Uses json_schema_extra with prefixes for flat-to-nested conversion support.
+    Works with Functions.flat_to_nested_with_prefix() to convert flat dictionaries
+    to properly nested structures.
+    """
+    employer: Optional[EmployerDetails] = Field(None, description="Employer details such as joint committee and business unit", alias="employer", json_schema_extra={"prefix": "employer_"})
+    employment: EmploymentDetails = Field(..., description="Employment details including period, employee type, etc.", alias="employment", json_schema_extra={"prefix": "employment_"})
+
+    class Config:
+        populate_by_name = True

brynq_sdk_acerta/schemas/in_service_config.py

@@ -0,0 +1,28 @@
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+class JointCommitteeGet(BrynQPanderaDataFrameModel):
+    code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Joint committee code")
+    description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Description")
+
+    class _Annotation:
+        primary_key = "code"
+        foreign_keys = {}
+
+    class Config:
+        metadata = {"class": "JointCommittee", "dependencies": []}
+
+
+class FunctionGet(BrynQPanderaDataFrameModel):
+    code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Function code")
+    description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Description")
+
+    class _Annotation:
+        primary_key = "code"
+        foreign_keys = {}
+
+    class Config:
+        metadata = {"class": "Function", "dependencies": []}

brynq_sdk_acerta/schemas/planning.py

@@ -0,0 +1,37 @@
+"""
+Schemas for Planning resource
+"""
+
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+# GET Schema for Countries
+class CountryGet(BrynQPanderaDataFrameModel):
+    """Schema for GET /v1/countries endpoint"""
+
+    description: Series[pd.StringDtype] = pa.Field(coerce=True, description="Country name", alias="description")
+    nis_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="NISCode of the country", alias="NISCode")
+
+    class _Annotation:
+        primary_key = "nis_code"
+
+    class Config:
+        metadata = {"class": "Country", "dependencies": []}
+
+
+# GET Schema for Belgian Cities
+class BelgianCityGet(BrynQPanderaDataFrameModel):
+    """Schema for GET /v1/belgian-cities endpoint"""
+
+    postal_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Belgian city postal code", alias="postalCode")
+    name: Series[pd.StringDtype] = pa.Field(coerce=True, description="Belgian city name", alias="name")
+    nis_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Belgian city NIS code", alias="NISCode")
+
+    class _Annotation:
+        primary_key = "nis_code"
+
+    class Config:
+        metadata = {"class": "BelgianCity", "dependencies": []}

brynq_sdk_acerta/schemas/salaries.py

@@ -0,0 +1,84 @@
+"""
+Schemas for Basic Salaries resource
+"""
+
+from typing import Optional, List, Literal
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series
+from pydantic import BaseModel, Field
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+# ============================================
+# GET SCHEMA (Pandera - DataFrame)
+# ============================================
+
+class BasicSalaryGet(BrynQPanderaDataFrameModel):
+    """Schema for GET /v1/agreements/{agreementId}/basic-salaries endpoint (rows per salary element)."""
+
+    # Meta
+    agreement_id: Series[pd.StringDtype] = pa.Field(coerce=True, description="Identifies the agreement and is unique for each agreement", alias="agreementId")
+
+    # Period (from parent basicSalaries segment)
+    period_start_date: Series[pd.StringDtype] = pa.Field(coerce=True, description="The start date of the record", alias="basicSalaries.period.startDate")
+    period_end_date: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="The end date of the record", alias="basicSalaries.period.endDate")
+
+    # Salary element details
+    salary_code_id: Series[pd.StringDtype] = pa.Field(coerce=True, description="The identifier of the salary code", alias="salaryCode.salaryCodeId")
+    salary_code_description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="The description of the salary code", alias="salaryCode.description")
+
+    unit_quantity: Series[pd.Float64Dtype] = pa.Field(coerce=True, nullable=True, description="The number of units associated with the salary code", alias="unitQuantity")
+    unit_amount: Series[pd.Float64Dtype] = pa.Field(coerce=True, nullable=True, description="The amount per unit associated with the salary code", alias="unitAmount")
+    percentage: Series[pd.Float64Dtype] = pa.Field(coerce=True, nullable=True, description="The percentage associated with the salary code", alias="percentage")
+    amount: Series[pd.Float64Dtype] = pa.Field(coerce=True, nullable=True, description="The amount associated with the salary code", alias="amount")
+    number_of_days: Series[pd.Float64Dtype] = pa.Field(coerce=True, nullable=True, description="The number of days associated with the salary code", alias="numberOfDays")
+
+    cost_center_id: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="The service receiver unique cost center identifier", alias="costCenter.costCenterId")
+    cost_center_description: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="Description of the cost center", alias="costCenter.description")
+
+    reason: Series[pd.StringDtype] = pa.Field(coerce=True, nullable=True, description="The reason of the salary code", alias="reason")
+
+    class _Annotation:
+        primary_key = "agreement_id"
+
+    class Config:
+        metadata = {"class": "BasicSalary", "dependencies": []}
+
+
+# ============================================
+# PATCH SCHEMAS (Pydantic - Request)
+# ============================================
+
+class BasicSalaryAttributes(BaseModel):
+    """Attributes for an INSERT action in a basic salary element."""
+    unit_quantity: Optional[float] = Field(None, description="The number of units associated with the salary code", alias="unitQuantity")
+    unit_amount: Optional[float] = Field(None, description="The amount per unit associated with the salary code", alias="unitAmount")
+    percentage: Optional[float] = Field(None, description="The percentage associated with the salary code", alias="percentage")
+    amount: Optional[float] = Field(None, description="The amount associated with the salary code", alias="amount")
+    number_of_days: Optional[float] = Field(None, description="The number of days associated with the salary code", alias="numberOfDays")
+    cost_center_id: Optional[str] = Field(None, min_length=1, max_length=12, description="The service receiver unique cost center identifier", alias="costCenterId")
+    reason: Optional[str] = Field(None, min_length=1, max_length=50, description="The reason of the salary code", alias="reason")
+
+    class Config:
+        populate_by_name = True
+
+
+class BasicSalaryElementUpdate(BaseModel):
+    """Schema for a single basic salary element update operation."""
+    action: Literal["DELETE", "INSERT"] = Field(..., description="DELETE will remove all elements with this salaryCodeId in the window; INSERT adds a new element", alias="action")
+    salary_code_id: str = Field(..., min_length=1, max_length=6, description="The identifier of the salary code", alias="salaryCodeId")
+    attributes: Optional[BasicSalaryAttributes] = Field(None, description="Attributes for INSERT action", alias="attributes", json_schema_extra={"prefix": "attributes_"})
+
+    class Config:
+        populate_by_name = True
+
+
+class PatchBasicSalariesRequest(BaseModel):
+    """Schema for PATCH /v1/agreements/{agreementId}/basic-salaries endpoint."""
+    from_date: str = Field(..., description="The lower bound of the time window for which data will be altered", alias="fromDate")
+    until_date: Optional[str] = Field(None, description="The upper bound of the time window for which data will be altered", alias="untilDate")
+    basic_salary_elements: List[BasicSalaryElementUpdate] = Field(..., min_items=1, description="List of inserted or deleted salary elements for the given time window", alias="basicSalaryElements", json_schema_extra={"prefix": "basic_salary_elements_"})
+
+    class Config:
+        populate_by_name = True