cloudbeds-fiscal-document 1.6.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

cloudbeds_fiscal_document/models/fiscal_document_filters.py

@@ -0,0 +1,133 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from cloudbeds_fiscal_document.models.fiscal_document_kind import FiscalDocumentKind
+from cloudbeds_fiscal_document.models.fiscal_document_status import FiscalDocumentStatus
+from cloudbeds_fiscal_document.models.source_kind import SourceKind
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FiscalDocumentFilters(BaseModel):
+    """
+    FiscalDocumentFilters
+    """ # noqa: E501
+    ids: Optional[List[StrictStr]] = Field(default=None, description="List of IDs to filter by")
+    source_ids: Optional[List[StrictStr]] = Field(default=None, description="List of source IDs to filter by", alias="sourceIds")
+    source_identifiers: Optional[List[StrictStr]] = Field(default=None, description="List of source-specific identifiers", alias="sourceIdentifiers")
+    source_kind: Optional[SourceKind] = Field(default=None, alias="sourceKind")
+    source_kinds: Optional[List[SourceKind]] = Field(default=None, description="Filter by source kind", alias="sourceKinds")
+    number_contains: Optional[StrictStr] = Field(default=None, description="Filter by document number partial match", alias="numberContains")
+    statuses: Optional[List[FiscalDocumentStatus]] = Field(default=None, description="List of fiscal document statuses to filter by")
+    kinds: Optional[List[FiscalDocumentKind]] = Field(default=None, description="List of fiscal document kinds to filter by")
+    created_at_from: Optional[datetime] = Field(default=None, description="Creation date-time range start", alias="createdAtFrom")
+    created_at_to: Optional[datetime] = Field(default=None, description="Creation date-time range end", alias="createdAtTo")
+    invoice_date_from: Optional[date] = Field(default=None, description="Invoice date range start", alias="invoiceDateFrom")
+    invoice_date_to: Optional[date] = Field(default=None, description="Invoice date range end", alias="invoiceDateTo")
+    invoice_date_property_timezone_from: Optional[date] = Field(default=None, description="Invoice date range start", alias="invoiceDatePropertyTimezoneFrom")
+    invoice_date_property_timezone_to: Optional[date] = Field(default=None, description="Invoice date range end", alias="invoiceDatePropertyTimezoneTo")
+    due_date_from: Optional[date] = Field(default=None, description="Due date range start", alias="dueDateFrom")
+    due_date_to: Optional[date] = Field(default=None, description="Due date range end", alias="dueDateTo")
+    due_date_property_timezone_from: Optional[date] = Field(default=None, description="Due date range start", alias="dueDatePropertyTimezoneFrom")
+    due_date_property_timezone_to: Optional[date] = Field(default=None, description="Due date range end", alias="dueDatePropertyTimezoneTo")
+    amount_from: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Minimum document amount", alias="amountFrom")
+    amount_to: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Maximum document amount", alias="amountTo")
+    balance_from: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Minimum document balance", alias="balanceFrom")
+    balance_to: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Maximum document balance", alias="balanceTo")
+    __properties: ClassVar[List[str]] = ["ids", "sourceIds", "sourceIdentifiers", "sourceKind", "sourceKinds", "numberContains", "statuses", "kinds", "createdAtFrom", "createdAtTo", "invoiceDateFrom", "invoiceDateTo", "invoiceDatePropertyTimezoneFrom", "invoiceDatePropertyTimezoneTo", "dueDateFrom", "dueDateTo", "dueDatePropertyTimezoneFrom", "dueDatePropertyTimezoneTo", "amountFrom", "amountTo", "balanceFrom", "balanceTo"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FiscalDocumentFilters 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FiscalDocumentFilters from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ids": obj.get("ids"),
+            "sourceIds": obj.get("sourceIds"),
+            "sourceIdentifiers": obj.get("sourceIdentifiers"),
+            "sourceKind": obj.get("sourceKind"),
+            "sourceKinds": obj.get("sourceKinds"),
+            "numberContains": obj.get("numberContains"),
+            "statuses": obj.get("statuses"),
+            "kinds": obj.get("kinds"),
+            "createdAtFrom": obj.get("createdAtFrom"),
+            "createdAtTo": obj.get("createdAtTo"),
+            "invoiceDateFrom": obj.get("invoiceDateFrom"),
+            "invoiceDateTo": obj.get("invoiceDateTo"),
+            "invoiceDatePropertyTimezoneFrom": obj.get("invoiceDatePropertyTimezoneFrom"),
+            "invoiceDatePropertyTimezoneTo": obj.get("invoiceDatePropertyTimezoneTo"),
+            "dueDateFrom": obj.get("dueDateFrom"),
+            "dueDateTo": obj.get("dueDateTo"),
+            "dueDatePropertyTimezoneFrom": obj.get("dueDatePropertyTimezoneFrom"),
+            "dueDatePropertyTimezoneTo": obj.get("dueDatePropertyTimezoneTo"),
+            "amountFrom": obj.get("amountFrom"),
+            "amountTo": obj.get("amountTo"),
+            "balanceFrom": obj.get("balanceFrom"),
+            "balanceTo": obj.get("balanceTo")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/fiscal_document_kind.py

@@ -30,6 +30,7 @@ class FiscalDocumentKind(str, Enum):
     CREDIT_NOTE = 'CREDIT_NOTE'
     RECEIPT = 'RECEIPT'
     RECTIFY_INVOICE = 'RECTIFY_INVOICE'
+    PRO_FORMA_INVOICE = 'PRO_FORMA_INVOICE'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

cloudbeds_fiscal_document/models/fiscal_document_status.py

@@ -30,16 +30,20 @@ class FiscalDocumentStatus(str, Enum):
     VOIDED = 'VOIDED'
     PAID = 'PAID'
     PENDING_INTEGRATION = 'PENDING_INTEGRATION'
+    PARTIALLY_PAID = 'PARTIALLY_PAID'
     COMPLETED_INTEGRATION = 'COMPLETED_INTEGRATION'
     FAILED_INTEGRATION = 'FAILED_INTEGRATION'
     CORRECTION_NEEDED = 'CORRECTION_NEEDED'
     CANCELED = 'CANCELED'
+    CANCEL_REQUESTED = 'CANCEL_REQUESTED'
     OPEN = 'OPEN'
     REQUESTED = 'REQUESTED'
     VOID_REQUESTED = 'VOID_REQUESTED'
     FAILED = 'FAILED'
     MANUALLY_RECONCILED = 'MANUALLY_RECONCILED'
     REJECTED = 'REJECTED'
+    ACCEPTED = 'ACCEPTED'
+    PENDING_TRANSACTION = 'PENDING_TRANSACTION'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

cloudbeds_fiscal_document/models/fiscal_document_transaction_response.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from cloudbeds_fiscal_document.models.source_kind import SourceKind
 from typing import Optional, Set
@@ -38,7 +38,18 @@ class FiscalDocumentTransactionResponse(BaseModel):
     internal_code: Optional[StrictStr] = Field(default=None, alias="internalCode")
     amount: Optional[Union[StrictFloat, StrictInt]] = None
     folio_id: Optional[StrictStr] = Field(default=None, alias="folioId")
-    __properties: ClassVar[List[str]] = ["id", "propertyId", "sourceId", "sourceKind", "transactionDate", "guestName", "description", "internalCode", "amount", "folioId"]
+    status: Optional[StrictStr] = Field(default=None, description="Status of the transaction - PENDING for unpaid transactions, POSTED for paid transactions")
+    __properties: ClassVar[List[str]] = ["id", "propertyId", "sourceId", "sourceKind", "transactionDate", "guestName", "description", "internalCode", "amount", "folioId", "status"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['PENDING', 'POSTED']):
+            raise ValueError("must be one of enum values ('PENDING', 'POSTED')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -100,7 +111,8 @@ class FiscalDocumentTransactionResponse(BaseModel):
             "description": obj.get("description"),
             "internalCode": obj.get("internalCode"),
             "amount": obj.get("amount"),
-            "folioId": obj.get("folioId")
+            "folioId": obj.get("folioId"),
+            "status": obj.get("status")
         })
         return _obj
 

cloudbeds_fiscal_document/models/fiscal_document_transactions_for_allocation_paginated.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cloudbeds_fiscal_document.models.transaction_for_allocation_response import TransactionForAllocationResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FiscalDocumentTransactionsForAllocationPaginated(BaseModel):
+    """
+    FiscalDocumentTransactionsForAllocationPaginated
+    """ # noqa: E501
+    transactions: Optional[List[TransactionForAllocationResponse]] = None
+    next_page_token: Optional[StrictStr] = Field(default=None, description="Token for fetching the next page of results", alias="nextPageToken")
+    __properties: ClassVar[List[str]] = ["transactions", "nextPageToken"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FiscalDocumentTransactionsForAllocationPaginated 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in transactions (list)
+        _items = []
+        if self.transactions:
+            for _item_transactions in self.transactions:
+                if _item_transactions:
+                    _items.append(_item_transactions.to_dict())
+            _dict['transactions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FiscalDocumentTransactionsForAllocationPaginated from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "transactions": [TransactionForAllocationResponse.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None,
+            "nextPageToken": obj.get("nextPageToken")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/fiscal_document_transactions_summary.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cloudbeds_fiscal_document.models.fiscal_document_transactions_summary_taxes_inner import FiscalDocumentTransactionsSummaryTaxesInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FiscalDocumentTransactionsSummary(BaseModel):
+    """
+    FiscalDocumentTransactionsSummary
+    """ # noqa: E501
+    charges_and_adjustments: Optional[StrictStr] = Field(default=None, alias="chargesAndAdjustments")
+    taxes: Optional[List[FiscalDocumentTransactionsSummaryTaxesInner]] = None
+    paid: Optional[StrictStr] = None
+    refunded: Optional[StrictStr] = None
+    total: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["chargesAndAdjustments", "taxes", "paid", "refunded", "total"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FiscalDocumentTransactionsSummary 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in taxes (list)
+        _items = []
+        if self.taxes:
+            for _item_taxes in self.taxes:
+                if _item_taxes:
+                    _items.append(_item_taxes.to_dict())
+            _dict['taxes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FiscalDocumentTransactionsSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "chargesAndAdjustments": obj.get("chargesAndAdjustments"),
+            "taxes": [FiscalDocumentTransactionsSummaryTaxesInner.from_dict(_item) for _item in obj["taxes"]] if obj.get("taxes") is not None else None,
+            "paid": obj.get("paid"),
+            "refunded": obj.get("refunded"),
+            "total": obj.get("total")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/fiscal_document_transactions_summary_taxes_inner.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FiscalDocumentTransactionsSummaryTaxesInner(BaseModel):
+    """
+    FiscalDocumentTransactionsSummaryTaxesInner
+    """ # noqa: E501
+    name: Optional[StrictStr] = None
+    amount: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "amount"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FiscalDocumentTransactionsSummaryTaxesInner 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FiscalDocumentTransactionsSummaryTaxesInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "amount": obj.get("amount")
+        })
+        return _obj
+
+

cloudbeds_fiscal_document/models/get_credit_note_preview_request.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    Fiscal document service API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cloudbeds_fiscal_document.models.creation_method import CreationMethod
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetCreditNotePreviewRequest(BaseModel):
+    """
+    GetCreditNotePreviewRequest
+    """ # noqa: E501
+    sequence_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, alias="sequenceId")
+    invoice_id: Annotated[int, Field(strict=True, ge=1)] = Field(alias="invoiceId")
+    reason: Optional[StrictStr] = None
+    user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="userId")
+    method: CreationMethod
+    transaction_ids: Optional[List[StrictInt]] = Field(default=None, description="Include transactions with the specified IDs (deprecated, use `includeTransactionIds` instead)", alias="transactionIds")
+    folio_ids: Optional[List[StrictInt]] = Field(default=None, description="Include all transactions from the specified folio IDs", alias="folioIds")
+    exclude_transaction_ids: Optional[List[StrictInt]] = Field(default=None, description="Exclude transactions with the specified IDs associated with selected folio IDs", alias="excludeTransactionIds")
+    include_transaction_ids: Optional[List[StrictInt]] = Field(default=None, description="Include transactions with the specified IDs", alias="includeTransactionIds")
+    __properties: ClassVar[List[str]] = ["sequenceId", "invoiceId", "reason", "userId", "method", "transactionIds", "folioIds", "excludeTransactionIds", "includeTransactionIds"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GetCreditNotePreviewRequest 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if sequence_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.sequence_id is None and "sequence_id" in self.model_fields_set:
+            _dict['sequenceId'] = None
+
+        # 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
+
+        # set to None if user_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_id is None and "user_id" in self.model_fields_set:
+            _dict['userId'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetCreditNotePreviewRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sequenceId": obj.get("sequenceId"),
+            "invoiceId": obj.get("invoiceId"),
+            "reason": obj.get("reason"),
+            "userId": obj.get("userId"),
+            "method": obj.get("method"),
+            "transactionIds": obj.get("transactionIds"),
+            "folioIds": obj.get("folioIds"),
+            "excludeTransactionIds": obj.get("excludeTransactionIds"),
+            "includeTransactionIds": obj.get("includeTransactionIds")
+        })
+        return _obj
+
+