solvimon-python-sdk 0.0.4b0__py3-none-any.whl

solvimon_python_sdk/models/invoice.py

@@ -0,0 +1,566 @@
+# coding: utf-8
+
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.com
+    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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from solvimon_python_sdk.models.amount import Amount
+from solvimon_python_sdk.models.billing_entity import BillingEntity
+from solvimon_python_sdk.models.credit_type import CreditType
+from solvimon_python_sdk.models.custom_field_value import CustomFieldValue
+from solvimon_python_sdk.models.customer import Customer
+from solvimon_python_sdk.models.e_invoice import EInvoice
+from solvimon_python_sdk.models.invoice_coupon import InvoiceCoupon
+from solvimon_python_sdk.models.invoice_credit_detail import InvoiceCreditDetail
+from solvimon_python_sdk.models.invoice_dunning_action import InvoiceDunningAction
+from solvimon_python_sdk.models.invoice_meter_property_variable import InvoiceMeterPropertyVariable
+from solvimon_python_sdk.models.invoice_payment_action import InvoicePaymentAction
+from solvimon_python_sdk.models.invoice_period import InvoicePeriod
+from solvimon_python_sdk.models.invoice_promotion_code import InvoicePromotionCode
+from solvimon_python_sdk.models.invoice_reprocess import InvoiceReprocess
+from solvimon_python_sdk.models.invoice_tax_category_summary import InvoiceTaxCategorySummary
+from solvimon_python_sdk.models.invoice_tax_total_summary import InvoiceTaxTotalSummary
+from solvimon_python_sdk.models.invoice_validation_result import InvoiceValidationResult
+from solvimon_python_sdk.models.linked_integration import LinkedIntegration
+from solvimon_python_sdk.models.linked_invoice_detail import LinkedInvoiceDetail
+from solvimon_python_sdk.models.meter_value import MeterValue
+from solvimon_python_sdk.models.other_custom_field_value import OtherCustomFieldValue
+from solvimon_python_sdk.models.period import Period
+from solvimon_python_sdk.models.portal_url_link import PortalUrlLink
+from solvimon_python_sdk.models.tax_registration import TaxRegistration
+from solvimon_python_sdk.models.used_exchange_rate import UsedExchangeRate
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class Invoice(BaseModel):
+    """
+    Invoice
+    """ # noqa: E501
+    object_type: Optional[StrictStr] = None
+    id: Optional[StrictStr] = None
+    invoice_number: Optional[StrictStr] = None
+    purchase_order_number: Optional[StrictStr] = None
+    platform_id: Optional[StrictStr] = None
+    customer_id: Optional[StrictStr] = Field(default=None, description="id of the customer, can only be provided when creating a one-off invoice, and either id or reference is mandatory in that case")
+    customer_reference: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=256)]] = Field(default=None, description="reference of the customer, can only be provided when creating a one-off invoice, and either id or reference is mandatory in that case")
+    sales_tax_percentage: Optional[StrictStr] = Field(default=None, description="Sales tax percentage. Needs to be present if both customer and billing entity are US-based. Optional if one of them is US-based")
+    customer: Optional[Customer] = None
+    billing_entity_id: Optional[StrictStr] = Field(default=None, description="id of the billing entity, can only be provided for a one-off invoice. If not provided, the default of the platform will be used")
+    billing_entity: Optional[BillingEntity] = None
+    status: Optional[StrictStr] = None
+    on_hold: Optional[StrictBool] = None
+    paid: Optional[StrictBool] = None
+    type: Optional[StrictStr] = None
+    created_at: Optional[StrictStr] = None
+    updated_at: Optional[StrictStr] = None
+    invoice_date: Optional[datetime] = None
+    delivery_date: Optional[StrictStr] = None
+    due_date: Optional[datetime] = None
+    billing_period_date: Optional[StrictStr] = None
+    billing_currency: Optional[StrictStr] = None
+    invoice_amount_including_tax: Optional[Amount] = None
+    open_invoice_amount: Optional[Amount] = None
+    closed_invoice_amount: Optional[Amount] = None
+    paid_invoice_amount: Optional[Amount] = None
+    timezone: Optional[StrictStr] = None
+    billing_period: Optional[Period] = None
+    pricing_plan_subscription_ids: Optional[List[StrictStr]] = None
+    pricing_plan_schedule_ids: Optional[List[StrictStr]] = Field(default=None, description="The pricing plan schedules this invoice bills for.")
+    pricing_amount_type: Optional[StrictStr] = Field(default=None, description="Indicates whether the amounts provided, e.g. from the pricing plan, are including or excluding tax.")
+    periods: Optional[List[InvoicePeriod]] = Field(default=None, description="Periods that are applicable for this invoice, use either periods or groups for summation, groups will be removed in later version")
+    closed_periods: Optional[List[InvoicePeriod]] = None
+    tax_categories: Optional[List[InvoiceTaxCategorySummary]] = None
+    tax_summary: Optional[InvoiceTaxTotalSummary] = None
+    auto_rescues: Optional[List[InvoiceDunningAction]] = None
+    dunning_actions: Optional[List[InvoiceDunningAction]] = None
+    payment_acceptor_ids: Optional[List[StrictStr]] = None
+    payment_actions: Optional[List[InvoicePaymentAction]] = None
+    pay_invoice_link: Optional[PortalUrlLink] = None
+    notes: Optional[List[StrictStr]] = None
+    linked_invoices: Optional[List[LinkedInvoiceDetail]] = None
+    linked_invoices_ids: Optional[List[StrictStr]] = Field(default=None, description="Can currently only be used for 'ONE_OFF_CREDIT' invoices, indicates original invoices that this invoice links to")
+    custom_fields: Optional[List[CustomFieldValue]] = None
+    other_custom_fields: Optional[List[OtherCustomFieldValue]] = None
+    credit: Optional[InvoiceCreditDetail] = None
+    e_invoices: Optional[List[EInvoice]] = None
+    used_exchange_rates: Optional[List[UsedExchangeRate]] = None
+    processing_only_customers: Optional[List[Customer]] = None
+    meter_values: Optional[List[MeterValue]] = None
+    credit_types: Optional[List[CreditType]] = None
+    meter_property_variables: Optional[List[InvoiceMeterPropertyVariable]] = Field(default=None, description="The meter property variables a pricing condition of this invoice was billed through, once each; their values are not included.")
+    display_invoice_sub_lines_per_processing_only_customer: Optional[StrictBool] = None
+    show_original_customer_invoice_line: Optional[StrictBool] = None
+    show_tax_per_line_item: Optional[StrictBool] = None
+    forwarded_from_customers: Optional[List[Customer]] = None
+    validation_result: Optional[List[InvoiceValidationResult]] = None
+    to_be_reprocessed: Optional[StrictBool] = None
+    to_be_reprocessed_at: Optional[StrictStr] = None
+    reprocess: Optional[InvoiceReprocess] = None
+    used_tax_registration: Optional[TaxRegistration] = Field(default=None, description="The tax registrations that are used to calculate the tax for this invoice. If empty, the billing entity was used")
+    footnote: Optional[StrictStr] = Field(default=None, description="Footnote to be shown on the invoice")
+    approval_status: Optional[StrictStr] = Field(default=None, description="Approval status for invoices that are associated with an approval request")
+    updated_to_final_at: Optional[StrictStr] = Field(default=None, description="The invoice finalization date")
+    has_usage_based_pricing: Optional[StrictBool] = None
+    coupons: Optional[List[InvoiceCoupon]] = Field(default=None, description="Coupons applied to this invoice")
+    promotion_codes: Optional[List[InvoicePromotionCode]] = Field(default=None, description="Promotion codes applied to this invoice")
+    linked_integrations: Optional[List[LinkedIntegration]] = None
+    billing_type: Optional[StrictStr] = None
+    payment_status: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["object_type", "id", "invoice_number", "purchase_order_number", "platform_id", "customer_id", "customer_reference", "sales_tax_percentage", "customer", "billing_entity_id", "billing_entity", "status", "on_hold", "paid", "type", "created_at", "updated_at", "invoice_date", "delivery_date", "due_date", "billing_period_date", "billing_currency", "invoice_amount_including_tax", "open_invoice_amount", "closed_invoice_amount", "paid_invoice_amount", "timezone", "billing_period", "pricing_plan_subscription_ids", "pricing_plan_schedule_ids", "pricing_amount_type", "periods", "closed_periods", "tax_categories", "tax_summary", "auto_rescues", "dunning_actions", "payment_acceptor_ids", "payment_actions", "pay_invoice_link", "notes", "linked_invoices", "linked_invoices_ids", "custom_fields", "other_custom_fields", "credit", "e_invoices", "used_exchange_rates", "processing_only_customers", "meter_values", "credit_types", "meter_property_variables", "display_invoice_sub_lines_per_processing_only_customer", "show_original_customer_invoice_line", "show_tax_per_line_item", "forwarded_from_customers", "validation_result", "to_be_reprocessed", "to_be_reprocessed_at", "reprocess", "used_tax_registration", "footnote", "approval_status", "updated_to_final_at", "has_usage_based_pricing", "coupons", "promotion_codes", "linked_integrations", "billing_type", "payment_status"]
+
+    @field_validator('customer_reference', mode="before")
+    def customer_reference_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^\S+$", value):
+            raise ValueError(r"must validate the regular expression /^\S+$/")
+        return value
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['STANDARD', 'CREDIT', 'ONE_OFF', 'ONE_OFF_CREDIT']):
+            raise ValueError("must be one of enum values ('STANDARD', 'CREDIT', 'ONE_OFF', 'ONE_OFF_CREDIT')")
+        return value
+
+    @field_validator('pricing_amount_type')
+    def pricing_amount_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['EXCLUDING_TAX', 'INCLUDING_TAX']):
+            raise ValueError("must be one of enum values ('EXCLUDING_TAX', 'INCLUDING_TAX')")
+        return value
+
+    @field_validator('approval_status')
+    def approval_status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['PENDING_REVIEW', 'APPROVED', 'DECLINED', 'CANCELLED']):
+            raise ValueError("must be one of enum values ('PENDING_REVIEW', 'APPROVED', 'DECLINED', 'CANCELLED')")
+        return value
+
+    @field_validator('billing_type')
+    def billing_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEFAULT', 'SELF_BILLING']):
+            raise ValueError("must be one of enum values ('DEFAULT', 'SELF_BILLING')")
+        return value
+
+    @field_validator('payment_status')
+    def payment_status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['UNPAID', 'PARTIALLY_PAID', 'PAID', 'OVERPAID']):
+            raise ValueError("must be one of enum values ('UNPAID', 'PARTIALLY_PAID', 'PAID', 'OVERPAID')")
+        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 Invoice 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "object_type",
+            "id",
+            "invoice_number",
+            "platform_id",
+            "customer",
+            "billing_entity",
+            "created_at",
+            "updated_at",
+            "delivery_date",
+            "billing_period_date",
+            "billing_currency",
+            "invoice_amount_including_tax",
+            "open_invoice_amount",
+            "closed_invoice_amount",
+            "paid_invoice_amount",
+            "timezone",
+            "billing_period",
+            "pricing_plan_subscription_ids",
+            "pricing_plan_schedule_ids",
+            "closed_periods",
+            "tax_categories",
+            "tax_summary",
+            "auto_rescues",
+            "dunning_actions",
+            "payment_actions",
+            "linked_invoices",
+            "other_custom_fields",
+            "credit",
+            "e_invoices",
+            "used_exchange_rates",
+            "processing_only_customers",
+            "meter_values",
+            "credit_types",
+            "meter_property_variables",
+            "display_invoice_sub_lines_per_processing_only_customer",
+            "show_original_customer_invoice_line",
+            "show_tax_per_line_item",
+            "forwarded_from_customers",
+            "validation_result",
+            "to_be_reprocessed",
+            "to_be_reprocessed_at",
+            "used_tax_registration",
+            "footnote",
+            "approval_status",
+            "updated_to_final_at",
+            "has_usage_based_pricing",
+            "coupons",
+            "promotion_codes",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # 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 billing_entity
+        if self.billing_entity:
+            _dict['billing_entity'] = self.billing_entity.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of invoice_amount_including_tax
+        if self.invoice_amount_including_tax:
+            _dict['invoice_amount_including_tax'] = self.invoice_amount_including_tax.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of open_invoice_amount
+        if self.open_invoice_amount:
+            _dict['open_invoice_amount'] = self.open_invoice_amount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of closed_invoice_amount
+        if self.closed_invoice_amount:
+            _dict['closed_invoice_amount'] = self.closed_invoice_amount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of paid_invoice_amount
+        if self.paid_invoice_amount:
+            _dict['paid_invoice_amount'] = self.paid_invoice_amount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of billing_period
+        if self.billing_period:
+            _dict['billing_period'] = self.billing_period.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in periods (list)
+        _items = []
+        if self.periods:
+            for _item_periods in self.periods:
+                _items.append(_item_periods.to_dict() if _item_periods is not None else None)
+            _dict['periods'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in closed_periods (list)
+        _items = []
+        if self.closed_periods:
+            for _item_closed_periods in self.closed_periods:
+                _items.append(_item_closed_periods.to_dict() if _item_closed_periods is not None else None)
+            _dict['closed_periods'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tax_categories (list)
+        _items = []
+        if self.tax_categories:
+            for _item_tax_categories in self.tax_categories:
+                _items.append(_item_tax_categories.to_dict() if _item_tax_categories is not None else None)
+            _dict['tax_categories'] = _items
+        # override the default output from pydantic by calling `to_dict()` of tax_summary
+        if self.tax_summary:
+            _dict['tax_summary'] = self.tax_summary.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in auto_rescues (list)
+        _items = []
+        if self.auto_rescues:
+            for _item_auto_rescues in self.auto_rescues:
+                _items.append(_item_auto_rescues.to_dict() if _item_auto_rescues is not None else None)
+            _dict['auto_rescues'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in dunning_actions (list)
+        _items = []
+        if self.dunning_actions:
+            for _item_dunning_actions in self.dunning_actions:
+                _items.append(_item_dunning_actions.to_dict() if _item_dunning_actions is not None else None)
+            _dict['dunning_actions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in payment_actions (list)
+        _items = []
+        if self.payment_actions:
+            for _item_payment_actions in self.payment_actions:
+                _items.append(_item_payment_actions.to_dict() if _item_payment_actions is not None else None)
+            _dict['payment_actions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of pay_invoice_link
+        if self.pay_invoice_link:
+            _dict['pay_invoice_link'] = self.pay_invoice_link.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in linked_invoices (list)
+        _items = []
+        if self.linked_invoices:
+            for _item_linked_invoices in self.linked_invoices:
+                _items.append(_item_linked_invoices.to_dict() if _item_linked_invoices is not None else None)
+            _dict['linked_invoices'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list)
+        _items = []
+        if self.custom_fields:
+            for _item_custom_fields in self.custom_fields:
+                _items.append(_item_custom_fields.to_dict() if _item_custom_fields is not None else None)
+            _dict['custom_fields'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in other_custom_fields (list)
+        _items = []
+        if self.other_custom_fields:
+            for _item_other_custom_fields in self.other_custom_fields:
+                _items.append(_item_other_custom_fields.to_dict() if _item_other_custom_fields is not None else None)
+            _dict['other_custom_fields'] = _items
+        # override the default output from pydantic by calling `to_dict()` of credit
+        if self.credit:
+            _dict['credit'] = self.credit.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in e_invoices (list)
+        _items = []
+        if self.e_invoices:
+            for _item_e_invoices in self.e_invoices:
+                _items.append(_item_e_invoices.to_dict() if _item_e_invoices is not None else None)
+            _dict['e_invoices'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in used_exchange_rates (list)
+        _items = []
+        if self.used_exchange_rates:
+            for _item_used_exchange_rates in self.used_exchange_rates:
+                _items.append(_item_used_exchange_rates.to_dict() if _item_used_exchange_rates is not None else None)
+            _dict['used_exchange_rates'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in processing_only_customers (list)
+        _items = []
+        if self.processing_only_customers:
+            for _item_processing_only_customers in self.processing_only_customers:
+                _items.append(_item_processing_only_customers.to_dict() if _item_processing_only_customers is not None else None)
+            _dict['processing_only_customers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in meter_values (list)
+        _items = []
+        if self.meter_values:
+            for _item_meter_values in self.meter_values:
+                _items.append(_item_meter_values.to_dict() if _item_meter_values is not None else None)
+            _dict['meter_values'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in credit_types (list)
+        _items = []
+        if self.credit_types:
+            for _item_credit_types in self.credit_types:
+                _items.append(_item_credit_types.to_dict() if _item_credit_types is not None else None)
+            _dict['credit_types'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in meter_property_variables (list)
+        _items = []
+        if self.meter_property_variables:
+            for _item_meter_property_variables in self.meter_property_variables:
+                _items.append(_item_meter_property_variables.to_dict() if _item_meter_property_variables is not None else None)
+            _dict['meter_property_variables'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in forwarded_from_customers (list)
+        _items = []
+        if self.forwarded_from_customers:
+            for _item_forwarded_from_customers in self.forwarded_from_customers:
+                _items.append(_item_forwarded_from_customers.to_dict() if _item_forwarded_from_customers is not None else None)
+            _dict['forwarded_from_customers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in validation_result (list)
+        _items = []
+        if self.validation_result:
+            for _item_validation_result in self.validation_result:
+                _items.append(_item_validation_result.to_dict() if _item_validation_result is not None else None)
+            _dict['validation_result'] = _items
+        # override the default output from pydantic by calling `to_dict()` of reprocess
+        if self.reprocess:
+            _dict['reprocess'] = self.reprocess.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of used_tax_registration
+        if self.used_tax_registration:
+            _dict['used_tax_registration'] = self.used_tax_registration.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in coupons (list)
+        _items = []
+        if self.coupons:
+            for _item_coupons in self.coupons:
+                _items.append(_item_coupons.to_dict() if _item_coupons is not None else None)
+            _dict['coupons'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in promotion_codes (list)
+        _items = []
+        if self.promotion_codes:
+            for _item_promotion_codes in self.promotion_codes:
+                _items.append(_item_promotion_codes.to_dict() if _item_promotion_codes is not None else None)
+            _dict['promotion_codes'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in linked_integrations (list)
+        _items = []
+        if self.linked_integrations:
+            for _item_linked_integrations in self.linked_integrations:
+                _items.append(_item_linked_integrations.to_dict() if _item_linked_integrations is not None else None)
+            _dict['linked_integrations'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Invoice from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "object_type": obj.get("object_type"),
+            "id": obj.get("id"),
+            "invoice_number": obj.get("invoice_number"),
+            "purchase_order_number": obj.get("purchase_order_number"),
+            "platform_id": obj.get("platform_id"),
+            "customer_id": obj.get("customer_id"),
+            "customer_reference": obj.get("customer_reference"),
+            "sales_tax_percentage": obj.get("sales_tax_percentage"),
+            "customer": Customer.from_dict(obj["customer"]) if obj.get("customer") is not None else None,
+            "billing_entity_id": obj.get("billing_entity_id"),
+            "billing_entity": BillingEntity.from_dict(obj["billing_entity"]) if obj.get("billing_entity") is not None else None,
+            "status": obj.get("status"),
+            "on_hold": obj.get("on_hold"),
+            "paid": obj.get("paid"),
+            "type": obj.get("type"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "invoice_date": obj.get("invoice_date"),
+            "delivery_date": obj.get("delivery_date"),
+            "due_date": obj.get("due_date"),
+            "billing_period_date": obj.get("billing_period_date"),
+            "billing_currency": obj.get("billing_currency"),
+            "invoice_amount_including_tax": Amount.from_dict(obj["invoice_amount_including_tax"]) if obj.get("invoice_amount_including_tax") is not None else None,
+            "open_invoice_amount": Amount.from_dict(obj["open_invoice_amount"]) if obj.get("open_invoice_amount") is not None else None,
+            "closed_invoice_amount": Amount.from_dict(obj["closed_invoice_amount"]) if obj.get("closed_invoice_amount") is not None else None,
+            "paid_invoice_amount": Amount.from_dict(obj["paid_invoice_amount"]) if obj.get("paid_invoice_amount") is not None else None,
+            "timezone": obj.get("timezone"),
+            "billing_period": Period.from_dict(obj["billing_period"]) if obj.get("billing_period") is not None else None,
+            "pricing_plan_subscription_ids": obj.get("pricing_plan_subscription_ids"),
+            "pricing_plan_schedule_ids": obj.get("pricing_plan_schedule_ids"),
+            "pricing_amount_type": obj.get("pricing_amount_type"),
+            "periods": [InvoicePeriod.from_dict(_item) for _item in obj["periods"]] if obj.get("periods") is not None else None,
+            "closed_periods": [InvoicePeriod.from_dict(_item) for _item in obj["closed_periods"]] if obj.get("closed_periods") is not None else None,
+            "tax_categories": [InvoiceTaxCategorySummary.from_dict(_item) for _item in obj["tax_categories"]] if obj.get("tax_categories") is not None else None,
+            "tax_summary": InvoiceTaxTotalSummary.from_dict(obj["tax_summary"]) if obj.get("tax_summary") is not None else None,
+            "auto_rescues": [InvoiceDunningAction.from_dict(_item) for _item in obj["auto_rescues"]] if obj.get("auto_rescues") is not None else None,
+            "dunning_actions": [InvoiceDunningAction.from_dict(_item) for _item in obj["dunning_actions"]] if obj.get("dunning_actions") is not None else None,
+            "payment_acceptor_ids": obj.get("payment_acceptor_ids"),
+            "payment_actions": [InvoicePaymentAction.from_dict(_item) for _item in obj["payment_actions"]] if obj.get("payment_actions") is not None else None,
+            "pay_invoice_link": PortalUrlLink.from_dict(obj["pay_invoice_link"]) if obj.get("pay_invoice_link") is not None else None,
+            "notes": obj.get("notes"),
+            "linked_invoices": [LinkedInvoiceDetail.from_dict(_item) for _item in obj["linked_invoices"]] if obj.get("linked_invoices") is not None else None,
+            "linked_invoices_ids": obj.get("linked_invoices_ids"),
+            "custom_fields": [CustomFieldValue.from_dict(_item) for _item in obj["custom_fields"]] if obj.get("custom_fields") is not None else None,
+            "other_custom_fields": [OtherCustomFieldValue.from_dict(_item) for _item in obj["other_custom_fields"]] if obj.get("other_custom_fields") is not None else None,
+            "credit": InvoiceCreditDetail.from_dict(obj["credit"]) if obj.get("credit") is not None else None,
+            "e_invoices": [EInvoice.from_dict(_item) for _item in obj["e_invoices"]] if obj.get("e_invoices") is not None else None,
+            "used_exchange_rates": [UsedExchangeRate.from_dict(_item) for _item in obj["used_exchange_rates"]] if obj.get("used_exchange_rates") is not None else None,
+            "processing_only_customers": [Customer.from_dict(_item) for _item in obj["processing_only_customers"]] if obj.get("processing_only_customers") is not None else None,
+            "meter_values": [MeterValue.from_dict(_item) for _item in obj["meter_values"]] if obj.get("meter_values") is not None else None,
+            "credit_types": [CreditType.from_dict(_item) for _item in obj["credit_types"]] if obj.get("credit_types") is not None else None,
+            "meter_property_variables": [InvoiceMeterPropertyVariable.from_dict(_item) for _item in obj["meter_property_variables"]] if obj.get("meter_property_variables") is not None else None,
+            "display_invoice_sub_lines_per_processing_only_customer": obj.get("display_invoice_sub_lines_per_processing_only_customer"),
+            "show_original_customer_invoice_line": obj.get("show_original_customer_invoice_line"),
+            "show_tax_per_line_item": obj.get("show_tax_per_line_item"),
+            "forwarded_from_customers": [Customer.from_dict(_item) for _item in obj["forwarded_from_customers"]] if obj.get("forwarded_from_customers") is not None else None,
+            "validation_result": [InvoiceValidationResult.from_dict(_item) for _item in obj["validation_result"]] if obj.get("validation_result") is not None else None,
+            "to_be_reprocessed": obj.get("to_be_reprocessed"),
+            "to_be_reprocessed_at": obj.get("to_be_reprocessed_at"),
+            "reprocess": InvoiceReprocess.from_dict(obj["reprocess"]) if obj.get("reprocess") is not None else None,
+            "used_tax_registration": TaxRegistration.from_dict(obj["used_tax_registration"]) if obj.get("used_tax_registration") is not None else None,
+            "footnote": obj.get("footnote"),
+            "approval_status": obj.get("approval_status"),
+            "updated_to_final_at": obj.get("updated_to_final_at"),
+            "has_usage_based_pricing": obj.get("has_usage_based_pricing"),
+            "coupons": [InvoiceCoupon.from_dict(_item) for _item in obj["coupons"]] if obj.get("coupons") is not None else None,
+            "promotion_codes": [InvoicePromotionCode.from_dict(_item) for _item in obj["promotion_codes"]] if obj.get("promotion_codes") is not None else None,
+            "linked_integrations": [LinkedIntegration.from_dict(_item) for _item in obj["linked_integrations"]] if obj.get("linked_integrations") is not None else None,
+            "billing_type": obj.get("billing_type"),
+            "payment_status": obj.get("payment_status")
+        })
+        return _obj
+
+