unit-openapi-python-sdk 0.0.2__py3-none-any.whl → 0.9.0__py3-none-any.whl

unit_finance_sdk/models/ach_payment.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.ach_payment_attributes import ACHPaymentAttributes
+from unit_finance_sdk.models.ach_payment_relationships import ACHPaymentRelationships
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ACHPayment(BaseModel):
+    """
+    `AchPayment` is a JSON:API resource.
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: ACHPaymentAttributes
+    relationships: Optional[ACHPaymentRelationships] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["type", "id", "attributes", "relationships"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['achPayment']):
+            raise ValueError("must be one of enum values ('achPayment')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ACHPayment from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of attributes
+        if self.attributes:
+            _dict['attributes'] = self.attributes.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of relationships
+        if self.relationships:
+            _dict['relationships'] = self.relationships.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ACHPayment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "id": obj.get("id"),
+            "attributes": ACHPaymentAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": ACHPaymentRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/ach_payment_attributes.py

@@ -0,0 +1,137 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.counterparty_type import CounterpartyType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ACHPaymentAttributes(BaseModel):
+    """
+    ACHPaymentAttributes
+    """ # noqa: E501
+    created_at: datetime = Field(description="The date the resource was created.", alias="createdAt")
+    status: StrictStr = Field(description="One of Pending, PendingReview, Rejected, Clearing, Sent, Canceled, Returned. See ACH Status.")
+    reason: Optional[StrictStr] = Field(default=None, description="Optional. More information about the status.")
+    counterparty: CounterpartyType = Field(description="The party on the other side of the ACH payment.")
+    direction: StrictStr = Field(description="The direction in which the funds flow (either Debit or Credit).")
+    description: StrictStr = Field(description="Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.")
+    addenda: Optional[StrictStr] = Field(default=None, description="Optional, additional payment description (maximum of 50 characters), not all institutions present that.")
+    amount: StrictInt = Field(description="The amount (cents) of the payment.")
+    settlement_date: Optional[datetime] = Field(default=None, description="Optional, for ACH debit with statuses Pending, Clearing, shows the date on which the payment will be settled.", alias="settlementDate")
+    expected_completion_date: Optional[datetime] = Field(default=None, description="Optional, for ACH credit with statuses Pending, Sent, shows the date on which the counterparty will handle the request.", alias="expectedCompletionDate")
+    tags: Dict[str, Any] = Field(description="See Tags.")
+    counterparty_verification_method: Optional[StrictStr] = Field(default=None, description="Optional, shows the verification method of the counterparty: 'Plaid'.", alias="counterpartyVerificationMethod")
+    same_day: StrictBool = Field(description="Indicates whether the payment is a Same Day ACH payment. See Same Day ACH.", alias="sameDay")
+    sec_code: StrictStr = Field(description="The 3-letter ACH Standard Entry Class (SEC) Code. One of WEB, CCD, PPD.", alias="secCode")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["createdAt", "status", "reason", "counterparty", "direction", "description", "addenda", "amount", "settlementDate", "expectedCompletionDate", "tags", "counterpartyVerificationMethod", "sameDay", "secCode"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ACHPaymentAttributes from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of counterparty
+        if self.counterparty:
+            _dict['counterparty'] = self.counterparty.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if reason (nullable) is None
+        # and model_fields_set contains the field
+        if self.reason is None and "reason" in self.model_fields_set:
+            _dict['reason'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ACHPaymentAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "createdAt": obj.get("createdAt"),
+            "status": obj.get("status"),
+            "reason": obj.get("reason"),
+            "counterparty": CounterpartyType.from_dict(obj["counterparty"]) if obj.get("counterparty") is not None else None,
+            "direction": obj.get("direction"),
+            "description": obj.get("description"),
+            "addenda": obj.get("addenda"),
+            "amount": obj.get("amount"),
+            "settlementDate": obj.get("settlementDate"),
+            "expectedCompletionDate": obj.get("expectedCompletionDate"),
+            "tags": obj.get("tags"),
+            "counterpartyVerificationMethod": obj.get("counterpartyVerificationMethod"),
+            "sameDay": obj.get("sameDay"),
+            "secCode": obj.get("secCode")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/ach_payment_relationships.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.relationship import Relationship
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ACHPaymentRelationships(BaseModel):
+    """
+    ACHPaymentRelationships
+    """ # noqa: E501
+    account: Optional[Relationship] = None
+    customer: Optional[Relationship] = None
+    customers: Optional[Relationship] = None
+    counterparty: Optional[Relationship] = None
+    transaction: Optional[Relationship] = None
+    recurring_payment: Optional[Relationship] = Field(default=None, alias="recurringPayment")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["account", "customer", "customers", "counterparty", "transaction", "recurringPayment"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ACHPaymentRelationships from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of account
+        if self.account:
+            _dict['account'] = self.account.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of customer
+        if self.customer:
+            _dict['customer'] = self.customer.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of customers
+        if self.customers:
+            _dict['customers'] = self.customers.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of counterparty
+        if self.counterparty:
+            _dict['counterparty'] = self.counterparty.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of transaction
+        if self.transaction:
+            _dict['transaction'] = self.transaction.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of recurring_payment
+        if self.recurring_payment:
+            _dict['recurringPayment'] = self.recurring_payment.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ACHPaymentRelationships from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "account": Relationship.from_dict(obj["account"]) if obj.get("account") is not None else None,
+            "customer": Relationship.from_dict(obj["customer"]) if obj.get("customer") is not None else None,
+            "customers": Relationship.from_dict(obj["customers"]) if obj.get("customers") is not None else None,
+            "counterparty": Relationship.from_dict(obj["counterparty"]) if obj.get("counterparty") is not None else None,
+            "transaction": Relationship.from_dict(obj["transaction"]) if obj.get("transaction") is not None else None,
+            "recurringPayment": Relationship.from_dict(obj["recurringPayment"]) if obj.get("recurringPayment") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/ach_received_payment.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from unit_finance_sdk.models.ach_received_payment_attributes import ACHReceivedPaymentAttributes
+from unit_finance_sdk.models.ach_received_payment_relationships import ACHReceivedPaymentRelationships
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ACHReceivedPayment(BaseModel):
+    """
+    `AchReceivedPayment` is a JSON:API resource.
+    """ # noqa: E501
+    type: StrictStr
+    id: StrictStr
+    attributes: ACHReceivedPaymentAttributes
+    relationships: Optional[ACHReceivedPaymentRelationships] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["type", "id", "attributes", "relationships"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['achReceivedPayment']):
+            raise ValueError("must be one of enum values ('achReceivedPayment')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ACHReceivedPayment from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of attributes
+        if self.attributes:
+            _dict['attributes'] = self.attributes.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of relationships
+        if self.relationships:
+            _dict['relationships'] = self.relationships.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ACHReceivedPayment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "id": obj.get("id"),
+            "attributes": ACHReceivedPaymentAttributes.from_dict(obj["attributes"]) if obj.get("attributes") is not None else None,
+            "relationships": ACHReceivedPaymentRelationships.from_dict(obj["relationships"]) if obj.get("relationships") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

unit_finance_sdk/models/ach_received_payment_attributes.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.9.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date, datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ACHReceivedPaymentAttributes(BaseModel):
+    """
+    ACHReceivedPaymentAttributes
+    """ # noqa: E501
+    created_at: datetime = Field(description="The date the transaction was created. Common to all receive payment types.", alias="createdAt")
+    status: StrictStr = Field(description="The status of the Received Payment. One of Pending, PendingReview, MarkedForReturn, Advanced, Completed or Returned. See ReceivedPayment Statuses. Common to all received payment types.")
+    was_advanced: StrictBool = Field(description="Will be true if the received payment was or is being Advanced (has or has had the status Advanced). Common to all received payment types.", alias="wasAdvanced")
+    is_advanceable: Optional[StrictBool] = Field(default=None, description="Will be true if the received payment can be advanced.", alias="isAdvanceable")
+    direction: StrictStr = Field(description="The direction in which the funds flow (either Debit or Credit).")
+    completion_date: date = Field(description="Shows the date on which the received ACH will be completed (settled or repaid).", alias="completionDate")
+    return_reason: Optional[StrictStr] = Field(default=None, description="Optional. The reason if the received payment is Returned. See ACH return reasons.", alias="returnReason")
+    amount: StrictInt = Field(description="The amount (cents) of the ACH received payment. Common to all received payment types.")
+    description: StrictStr = Field(description="ACH description (maximum of 10 characters), also known as Company Entry Description.")
+    addenda: Optional[StrictStr] = Field(default=None, description="Optional. Additional transaction description (maximum of 80 characters).")
+    company_name: StrictStr = Field(description="The name by which the originator is known to the receiver.", alias="companyName")
+    originator_entity_id: Optional[StrictStr] = Field(default=None, description="Optional. A unique identifier by which the originator is formally recognized within the ACH network.", alias="originatorEntityId")
+    receiving_entity_name: Optional[StrictStr] = Field(default=None, description="Optional. The name of the Recipient as it was declared by the originator of the payment.", alias="receivingEntityName")
+    counterparty_routing_number: StrictStr = Field(description="The routing number of the party that originated the received ACH payment.", alias="counterpartyRoutingNumber")
+    trace_number: StrictStr = Field(description="The ACH Trace Number.", alias="traceNumber")
+    sec_code: Optional[StrictStr] = Field(default=None, description="Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. WEB, CCD, PPD, etc.).", alias="secCode")
+    return_cutoff_time: Optional[datetime] = Field(default=None, description="Optional. The last time when a reprocess will be accepted. Will be the next banking day 2pm ET.", alias="returnCutoffTime")
+    can_be_reprocessed: Optional[StrictBool] = Field(default=None, description="Optional. If set to true, the Received Payment can be reprocessed until the returnCutoffTime. If empty, the Received Payments can't be reprocessed.", alias="canBeReprocessed")
+    tags: Optional[Dict[str, Any]] = Field(default=None, description="See Tags.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["createdAt", "status", "wasAdvanced", "isAdvanceable", "direction", "completionDate", "returnReason", "amount", "description", "addenda", "companyName", "originatorEntityId", "receivingEntityName", "counterpartyRoutingNumber", "traceNumber", "secCode", "returnCutoffTime", "canBeReprocessed", "tags"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ACHReceivedPaymentAttributes from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ACHReceivedPaymentAttributes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "createdAt": obj.get("createdAt"),
+            "status": obj.get("status"),
+            "wasAdvanced": obj.get("wasAdvanced"),
+            "isAdvanceable": obj.get("isAdvanceable"),
+            "direction": obj.get("direction"),
+            "completionDate": obj.get("completionDate"),
+            "returnReason": obj.get("returnReason"),
+            "amount": obj.get("amount"),
+            "description": obj.get("description"),
+            "addenda": obj.get("addenda"),
+            "companyName": obj.get("companyName"),
+            "originatorEntityId": obj.get("originatorEntityId"),
+            "receivingEntityName": obj.get("receivingEntityName"),
+            "counterpartyRoutingNumber": obj.get("counterpartyRoutingNumber"),
+            "traceNumber": obj.get("traceNumber"),
+            "secCode": obj.get("secCode"),
+            "returnCutoffTime": obj.get("returnCutoffTime"),
+            "canBeReprocessed": obj.get("canBeReprocessed"),
+            "tags": obj.get("tags")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+