brynq-sdk-acerta 1.0.0__tar.gz → 1.1.1__tar.gz

brynq_sdk_acerta-1.1.1/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: brynq_sdk_acerta
+Version: 1.1.1
+Summary: Acerta wrapper from BrynQ
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Requires-Dist: pandas<3.0.0,>=2.2.0
+Requires-Dist: pydantic<3.0.0,>=2.5.0
+Requires-Dist: pandera<1.0.0,>=0.16.0
+Requires-Dist: requests<3.0.0,>=2.25.1
+Requires-Dist: brynq-sdk-functions>=2.0.5
+Requires-Dist: brynq-sdk-brynq>=3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+Acerta wrapper from BrynQ

{brynq_sdk_acerta-1.0.0 → brynq_sdk_acerta-1.1.1}/brynq_sdk_acerta/__init__.py

@@ -9,5 +9,6 @@ from .code_lists import CodeLists
 from .employer import Employer
 from .employees_additional_information import EmployeesAdditionalInformation
 from .inservice import InService
+from .company_cars import CompanyCars
 
-__all__ = ['Acerta', 'CodeLists', 'Agreements', 'Employees', 'Employer', 'InService', 'EmployeesAdditionalInformation']
+__all__ = ['Acerta', 'CodeLists', 'Agreements', 'Employees', 'Employer', 'InService', 'EmployeesAdditionalInformation', 'CompanyCars']

{brynq_sdk_acerta-1.0.0 → brynq_sdk_acerta-1.1.1}/brynq_sdk_acerta/acerta.py

@@ -8,6 +8,7 @@ from brynq_sdk_brynq import BrynQ
 from .code_lists import CodeLists
 from .agreements import Agreements
 from .inservice import InService
+from .company_cars import CompanyCars
 from .employees import Employees
 from .employer import Employer
 from requests_oauthlib import OAuth2Session
@@ -96,6 +97,7 @@ class Acerta(BrynQ):
         self.employees = Employees(self)
         self.employers = Employer(self)
         self.salaries = Salaries(self)
+        self.company_cars = CompanyCars(self)
 
     def _ensure_valid_token(self):
         """Ensure the OAuth token exists and is not about to expire."""

{brynq_sdk_acerta-1.0.0 → brynq_sdk_acerta-1.1.1}/brynq_sdk_acerta/agreements.py

@@ -1,7 +1,16 @@
 from typing import Dict, Any, Optional, Tuple
 import requests
 import pandas as pd
-from .schemas.agreement import AgreementGet, AgreementRemunerationBankAccountCreate, PatchAgreementRequest
+from .schemas.agreement import (
+    AgreementGet,
+    PatchAgreementRequest,
+    AgreementBasicInformationGet,
+    AgreementEmploymentsGet,
+    AgreementWorkingTimeGet,
+    AgreementCommutingGet,
+    AgreementCustomFieldsGet,
+    AgreementCostCenterAllocationGet,
+)
 from .schemas.in_service_config import JointCommitteeGet, FunctionGet
 from brynq_sdk_functions import Functions
 from typing import TYPE_CHECKING
@@ -67,46 +76,6 @@ class Agreements:
 		combined = pd.concat(all_rows, ignore_index=True) if all_rows else pd.DataFrame()
 		return Functions.validate_data(combined, FunctionGet)
 
-	def create_bank_account(self, agreement_id: str, data: Dict[str, Any], if_match: str, accept_language: str = "en") -> requests.Response:
-		"""
-		POST /v1/agreements/{agreementId}/remuneration-bank-account - Agreement Remuneration Bank Account
-
-		Create or update the remuneration bank account for an agreement. Requires the ETag
-		of the resource for optimistic concurrency control.
-
-		Args:
-			agreement_id: Unique identifier of an agreement
-			data: Dictionary with bank account data (iban, bic)
-			if_match: The ETag of this resource (required for concurrency control)
-			accept_language: The language for the request (defaults to "en")
-
-		Returns:
-			requests.Response: Raw response object
-
-		Raises:
-			Exception: If the bank account creation fails
-		"""
-		# Validate request data
-		validated_data = AgreementRemunerationBankAccountCreate(**data)
-
-		# Prepare headers
-		headers = {
-			"If-Match": if_match,
-			"Accept-Language": accept_language
-		}
-
-		# Make API request
-		request_headers = self.acerta.session.headers.copy()
-		request_headers.update(headers)
-		response = self.acerta.session.post(
-			url=f"{self.acerta.base_url}/v1/agreements/{agreement_id}/remuneration-bank-account",
-			json=validated_data.model_dump(by_alias=True, exclude_none=True),
-			headers=request_headers,
-			timeout=self.acerta.TIMEOUT,
-		)
-		response.raise_for_status()
-
-		return response
 
 	def get(self) -> Tuple[pd.DataFrame, pd.DataFrame]:
 		"""
@@ -245,7 +214,7 @@ class Agreements:
 			)
 			frames.append(df)
 		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
+		return Functions.validate_data(combined, AgreementBasicInformationGet, debug=self.acerta.debug)
 
 	def get_employments(
 		self,
@@ -285,7 +254,7 @@ class Agreements:
 			)
 			frames.append(df)
 		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
+		return Functions.validate_data(combined, AgreementEmploymentsGet, debug=self.acerta.debug)
 
 	def get_working_time(
 		self,
@@ -327,49 +296,8 @@ class Agreements:
 			)
 			frames.append(df)
 		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
+		return Functions.validate_data(combined, AgreementWorkingTimeGet, debug=self.acerta.debug)
 
-	def get_remuneration(
-		self,
-		agreement_id: Optional[str] = None,
-		from_date: Optional[str] = None,
-		until_date: Optional[str] = None,
-		full_segments_only: Optional[bool] = None,
-		accept_language: str = "en",
-	) -> Tuple[pd.DataFrame, pd.DataFrame]:
-		"""GET /v3/agreements/{agreementId}/remuneration"""
-		params = {k: v for k, v in {
-			"fromDate": from_date,
-			"untilDate": until_date,
-			"fullSegmentsOnly": str(full_segments_only).lower() if isinstance(full_segments_only, bool) else full_segments_only,
-		}.items() if v is not None}
-		if not agreement_id and not self.acerta._agreement_ids:
-			self.get()
-		ids = [agreement_id] if agreement_id else self.acerta._agreement_ids
-		frames = []
-		headers = {"Accept-Language": accept_language} if accept_language else None
-		for agr_id in ids:
-			request_headers = self.acerta.session.headers.copy()
-			if headers:
-				request_headers.update(headers)
-			response = self.acerta.session.get(
-				url=f"{self.acerta.base_url}/{self.base_uri}/{agr_id}/remuneration",
-				params=params,
-				headers=request_headers,
-				timeout=self.acerta.TIMEOUT,
-			)
-			response.raise_for_status()
-			raw = response.json()
-			df = pd.json_normalize(
-				raw,
-				record_path=["remunerationSegments"],
-				meta=["agreementId"],
-				errors="ignore",
-				sep=".",
-			)
-			frames.append(df)
-		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
 
 	def get_commuting(
 		self,
@@ -411,7 +339,7 @@ class Agreements:
 			)
 			frames.append(df)
 		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
+		return Functions.validate_data(combined, AgreementCommutingGet, debug=self.acerta.debug)
 
 	def get_custom_fields(
 		self,
@@ -455,7 +383,7 @@ class Agreements:
 			)
 			frames.append(df)
 		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
+		return Functions.validate_data(combined, AgreementCustomFieldsGet, debug=self.acerta.debug)
 
 	def get_cost_center_allocation(
 		self,
@@ -495,4 +423,4 @@ class Agreements:
 			)
 			frames.append(df)
 		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
-		return combined, pd.DataFrame()
+		return Functions.validate_data(combined, AgreementCostCenterAllocationGet, debug=self.acerta.debug)

brynq_sdk_acerta-1.1.1/brynq_sdk_acerta/bank_accounts.py

@@ -0,0 +1,90 @@
+from typing import Dict, Any, Optional, Tuple
+import requests
+import pandas as pd
+from brynq_sdk_functions import Functions
+from .schemas.agreement import AgreementRemunerationBankAccountUpdate
+from .schemas.bank_account import AgreementBankAccountsGet
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+	from .acerta import Acerta
+
+class BankAccounts:
+	"""Resource class for Employee Bank Accounts (HAL links)."""
+
+	def __init__(self, acerta):
+		self.acerta: Acerta = acerta
+		self.base_uri = "v1"
+
+	def get(self, agreement_id: Optional[str] = None, from_date: Optional[str] = None, until_date: Optional[str] = None, full_segments_only: Optional[bool] = None, accept_language: str = "en") -> Tuple[pd.DataFrame, pd.DataFrame]:
+		"""
+		GET /v3/agreements/{agreementId}/remuneration - derive bank accounts
+
+		Fetches remuneration segments for agreements and returns only the bank account related fields
+		(via methodOfPayment.employeeBankAccounts/employerBankAccounts).
+		"""
+		# Ensure we have agreement ids
+		if not agreement_id and not self.acerta._agreement_ids:
+			self.acerta.agreements.get()
+		agreement_ids = [agreement_id] if agreement_id else self.acerta._agreement_ids
+
+		params = {k: v for k, v in {
+			"fromDate": from_date,
+			"untilDate": until_date,
+			"fullSegmentsOnly": str(full_segments_only).lower() if isinstance(full_segments_only, bool) else full_segments_only,
+		}.items() if v is not None}
+
+		frames = []
+		headers = {"Accept-Language": accept_language} if accept_language else None
+		for agr_id in agreement_ids:
+			request_headers = self.acerta.session.headers.copy()
+			if headers:
+				request_headers.update(headers)
+			response = self.acerta.session.get(
+				url=f"{self.acerta.base_url}/agreement-data-management/v3/agreements/{agr_id}/remuneration",
+				params=params,
+				headers=request_headers,
+				timeout=self.acerta.TIMEOUT,
+			)
+			response.raise_for_status()
+			raw = response.json()
+			df = pd.json_normalize(
+				raw,
+				record_path=["remunerationSegments"],
+				meta=["agreementId"],
+				errors="ignore",
+				sep=".",
+			)
+			frames.append(df)
+
+		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
+		return Functions.validate_data(combined, AgreementBankAccountsGet, debug=self.acerta.debug)
+
+	def update(self, agreement_id: str, data: Dict[str, Any]) -> requests.Response:
+		"""
+		PUT /employee-data-management/v3/employees/agreement/{agreementId}/remuneration-bank-account - Agreement Remuneration Bank Account
+
+		Set the bank account for the employee and agreement. This endpoint updates the remuneration
+		bank account associated with a specific agreement.
+
+		Args:
+			agreement_id: Unique identifier of an agreement
+			data: Dictionary with bank account data (iban, bic)
+
+		Returns:
+			requests.Response: Raw response object
+
+		Raises:
+			Exception: If the update fails
+		"""
+		# Validate the data (no nesting required for this simple schema)
+		validated_data = AgreementRemunerationBankAccountUpdate(**data)
+
+		# Make API request
+		response = self.acerta.session.put(
+			url=f"{self.acerta.base_url}/employee-data-management/v3/employees/agreement/{agreement_id}/remuneration-bank-account",
+			json=validated_data.model_dump(by_alias=True, exclude_none=True),
+			timeout=self.acerta.TIMEOUT,
+		)
+		response.raise_for_status()
+
+		return response

brynq_sdk_acerta-1.1.1/brynq_sdk_acerta/company_cars.py

@@ -0,0 +1,135 @@
+from typing import Tuple, Dict, Any, Optional
+import pandas as pd
+import requests
+from brynq_sdk_functions import Functions
+from .schemas.company_car import CompanyCarGet, CompanyCarCreate, CompanyCarUpdate
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+	from .acerta import Acerta
+
+
+class CompanyCars:
+	"""Resource class for Company Cars endpoints"""
+
+	def __init__(self, acerta):
+		self.acerta: Acerta = acerta
+		self.base_uri = "employer-data-management/v1/employers"
+
+	def get(
+		self,
+		from_date: str = "1900-01-01",
+		until_date: str = "9999-12-31",
+		license_plate: Optional[str] = None,
+		size: int = 20,
+		page: int = 0,
+	) -> Tuple[pd.DataFrame, pd.DataFrame]:
+		"""
+		GET /v1/employers/{employerId}/company-cars - Company cars
+
+		Retrieve company cars for all configured employer IDs within an optional time window
+		and optional license plate filter. Supports basic pagination parameters.
+
+		Args:
+			from_date: The lower bound of the time window (default: "1900-01-01")
+			until_date: The upper bound of the time window (default: "9999-12-31")
+			license_plate: Optional license plate filter (or part of a plate)
+			size: Number of items per page (default: 20)
+			page: Zero-based page index (default: 0)
+
+		Returns:
+			Tuple[pd.DataFrame, pd.DataFrame]: (valid_df, invalid_df) after normalizing and validating
+		"""
+		all_valid_data = []
+		all_invalid_data = []
+		for employer_id in self.acerta._employer_ids:
+			params = {
+				"fromDate": from_date,
+				"untilDate": until_date,
+				"size": size,
+				"page": page,
+			}
+			if license_plate:
+				params["licensePlate"] = license_plate
+			response = self.acerta.session.get(
+				url=f"{self.acerta.base_url}/{self.base_uri}/{employer_id}/company-cars",
+				params=params,
+				timeout=self.acerta.TIMEOUT,
+			)
+			response.raise_for_status()
+			items = response.json().get("companyCars", [])
+			df = pd.json_normalize(items, sep='.')
+			valid_data, invalid_data = Functions.validate_data(df, CompanyCarGet)
+			all_valid_data.append(valid_data)
+			all_invalid_data.append(invalid_data)
+
+		return (
+			pd.concat(all_valid_data, ignore_index=True) if all_valid_data else pd.DataFrame(),
+			pd.concat(all_invalid_data, ignore_index=True) if all_invalid_data else pd.DataFrame(),
+		)
+
+	def get_by_id(self, employer_id: str, company_car_id: str) -> Tuple[pd.DataFrame, pd.DataFrame]:
+		"""
+		GET /v1/employers/{employerId}/company-cars/{companyCarId} - Company car by ID
+
+		Args:
+			employer_id: Unique identifier of the employer (Acerta key)
+			company_car_id: Unique identifier of the company car (6 digits)
+
+		Returns:
+			Tuple[pd.DataFrame, pd.DataFrame]: (valid_df, invalid_df)
+		"""
+		response = self.acerta.session.get(
+			url=f"{self.acerta.base_url}/{self.base_uri}/{employer_id}/company-cars/{company_car_id}",
+			timeout=self.acerta.TIMEOUT,
+		)
+		response.raise_for_status()
+		raw = response.json()
+		if isinstance(raw, dict):
+			df = pd.json_normalize(raw, sep='.')
+		else:
+			df = pd.json_normalize([raw], sep='.')
+		return Functions.validate_data(df, CompanyCarGet)
+
+	def create(self, employer_id: str, data: Dict[str, Any]) -> requests.Response:
+		"""
+		POST /v1/employers/{employerId}/company-cars - Company car
+
+		Args:
+			employer_id: Unique identifier of the employer (Acerta key)
+			data: Flat dictionary with company car data
+
+		Returns:
+			requests.Response: Raw response object
+		"""
+		# Convert flat data to nested using Functions.flat_to_nested_with_prefix
+		nested = Functions.flat_to_nested_with_prefix(data, CompanyCarCreate)
+		validated = CompanyCarCreate(**nested)
+		response = self.acerta.session.post(
+			url=f"{self.acerta.base_url}/{self.base_uri}/{employer_id}/company-cars",
+			json=validated.model_dump(by_alias=True, exclude_none=True),
+			timeout=self.acerta.TIMEOUT,
+		)
+		response.raise_for_status()
+		return response
+
+	def update(self, employer_id: str, company_car_id: str, data: Dict[str, Any]) -> requests.Response:
+		"""
+		PATCH /v1/employers/{employerId}/company-cars/{companyCarId} - Update company car
+
+		Args:
+			employer_id: Unique identifier of the employer (Acerta key)
+			company_car_id: Unique identifier of the company car
+			data: Flat dictionary with update fields
+
+		Returns:
+			requests.Response: Raw response object
+		"""
+		nested = Functions.flat_to_nested_with_prefix(data, CompanyCarUpdate)
+		validated = CompanyCarUpdate(**nested)
+		response = self.acerta.session.patch(
+			url=f"{self.acerta.base_url}/{self.base_uri}/{employer_id}/company-cars/{company_car_id}",
+			json=validated.model_dump(by_alias=True, exclude_none=True),
+			timeout=self.acerta.TIMEOUT,
+		)
+		response.raise_for_status()
+		return response

{brynq_sdk_acerta-1.0.0 → brynq_sdk_acerta-1.1.1}/brynq_sdk_acerta/family_members.py

@@ -9,10 +9,11 @@ if TYPE_CHECKING:
 
 class FamilyMembers:
 	"""Resource class for Family endpoints"""
+	# According to Acerta this is hardly ever used, is not relevant for payroll.
 
 	def __init__(self, acerta):
 		self.acerta: Acerta = acerta
-		self.base_uri = "employee-data-management/v1/employees"
+		self.base_uri = "employee-data-management/v2/employees"
 
 	def get(self, employee_id: str, from_date: str = "1900-01-01", until_date: str = "9999-12-31",
 				   full_segments_only: bool = False) -> Tuple[pd.DataFrame, pd.DataFrame]:

{brynq_sdk_acerta-1.0.0 → brynq_sdk_acerta-1.1.1}/brynq_sdk_acerta/schemas/__init__.py

@@ -19,7 +19,7 @@ from .family import (
     Dependants,
     FiscalDetails
 )
-from .bank_account import BankAccountLinkGet, BankAccountUpdate, BankOwner, OwnerName, BankDetails
+from .bank_account import BankAccountUpdate, BankOwner, OwnerName, BankDetails
 from .employee import (
     AdditionalInformationGet,
     AdditionalInformationUpdate,
@@ -55,6 +55,7 @@ from .employer import JointCommitteeGet, FunctionGet, SalaryCodeGet
 from .in_service import EmploymentCreate, EmploymentRehire
 from .cost_center import CostCenterGet, CostCenterCreate, CostCenterDescription, CostCenterPeriod
 from .salaries import BasicSalaryGet, PatchBasicSalariesRequest
+from .company_car import CompanyCarGet, CompanyCarCreate, CompanyCarUpdate
 
 __all__ = [
     'AgreementGet',
@@ -127,5 +128,8 @@ __all__ = [
     'CostCenterDescription',
     'CostCenterPeriod',
     'BasicSalaryGet',
-    'PatchBasicSalariesRequest'
+    'PatchBasicSalariesRequest',
+    'CompanyCarGet',
+    'CompanyCarCreate',
+    'CompanyCarUpdate'
 ]

{brynq_sdk_acerta-1.0.0 → brynq_sdk_acerta-1.1.1}/brynq_sdk_acerta/schemas/address.py

@@ -69,6 +69,9 @@ CorrespondenceAddressUpdate = Address
 
 class AddressUpdate(BaseModel):
     """Schema for PATCH /employee-data-management/v3/employees/{employeeId}/addresses endpoint"""
+    # Function parameters
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+
     from_date: Optional[str] = Field(None, example="2022-01-01", description="Date from which this information is valid", alias="fromDate")
     official_address: Optional[Address] = Field(None, description="Official address of the employee", alias="officialAddress", json_schema_extra={"prefix": "official_address_"})
     correspondence_address: Optional[Address] = Field(None, description="Correspondence address of the employee", alias="correspondenceAddress", json_schema_extra={"prefix": "correspondence_address_"})