fortis-python-sdk 1.0.0__py3-none-any.whl

fortisapi/models/line_item_13.py

@@ -0,0 +1,449 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class LineItem13(object):
+    """Implementation of the 'LineItem13' model.
+
+    Attributes:
+        description (str): Description of the item.
+        commodity_code (str): An international description code of the individual
+            good or service being supplied.
+        discount_amount (int): Total discount amount applied against the line item
+            total ,Can accept Two (2) decimal places.
+        other_tax_amount (int): Used if city or multiple county taxes need to be
+            broken out separately ,Can accept Two (2) decimal places.
+        product_code (str): Merchant-defined description code of the item.
+        quantity (float): Quantity of the item, can accept Four (4) decimal places.
+        tax_amount (int): Amount of any value added taxes, can accept Two (2) decimal
+            places.
+        tax_rate (int): Tax rate used to calculate the sales tax amount, can accept 2
+            decimal places.
+        unit_code (str): Units of measurement as used in international trade. (See
+            Codes for Units of Measurement below for unit code abbreviations)
+        unit_cost (int): Unit cost of the item ,Can accept Four (4) decimal places.
+        alternate_tax_id (str): Tax identification number of the merchant that
+            reported the alternate tax amount.
+        debit_credit (DebitCreditEnum): Indicator used to reflect debit (D) or credit
+            (C) transaction. Allowed values: “D”, “C”.
+        discount_rate (int): Discount rate for the line item ,Can accept Two (2)
+            decimal places.
+        tax_type_applied (str): Type of value-added taxes that are being used
+            (Conditional If tax amount is supplied) >This field is only required when
+            Merchant is directed to include by Mastercard. >
+        tax_type_id (str): Indicates the type of tax collected in relationship to a
+            specific tax amount (Conditional If tax amount is supplied)
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "description": "description",
+        "commodity_code": "commodity_code",
+        "discount_amount": "discount_amount",
+        "other_tax_amount": "other_tax_amount",
+        "product_code": "product_code",
+        "quantity": "quantity",
+        "tax_amount": "tax_amount",
+        "tax_rate": "tax_rate",
+        "unit_code": "unit_code",
+        "unit_cost": "unit_cost",
+        "alternate_tax_id": "alternate_tax_id",
+        "debit_credit": "debit_credit",
+        "discount_rate": "discount_rate",
+        "tax_type_applied": "tax_type_applied",
+        "tax_type_id": "tax_type_id",
+    }
+
+    _optionals = [
+        "description",
+        "commodity_code",
+        "discount_amount",
+        "other_tax_amount",
+        "product_code",
+        "quantity",
+        "tax_amount",
+        "tax_rate",
+        "unit_code",
+        "unit_cost",
+        "alternate_tax_id",
+        "debit_credit",
+        "discount_rate",
+        "tax_type_applied",
+        "tax_type_id",
+    ]
+
+    _nullables = [
+        "discount_amount",
+        "other_tax_amount",
+        "quantity",
+        "tax_amount",
+        "tax_rate",
+        "alternate_tax_id",
+        "debit_credit",
+        "discount_rate",
+        "tax_type_applied",
+        "tax_type_id",
+    ]
+
+    def __init__(
+        self,
+        description=APIHelper.SKIP,
+        commodity_code=APIHelper.SKIP,
+        discount_amount=APIHelper.SKIP,
+        other_tax_amount=APIHelper.SKIP,
+        product_code=APIHelper.SKIP,
+        quantity=APIHelper.SKIP,
+        tax_amount=APIHelper.SKIP,
+        tax_rate=APIHelper.SKIP,
+        unit_code=APIHelper.SKIP,
+        unit_cost=APIHelper.SKIP,
+        alternate_tax_id=APIHelper.SKIP,
+        debit_credit=APIHelper.SKIP,
+        discount_rate=APIHelper.SKIP,
+        tax_type_applied=APIHelper.SKIP,
+        tax_type_id=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a LineItem13 instance."""
+        # Initialize members of the class
+        if description is not APIHelper.SKIP:
+            self.description = description
+        if commodity_code is not APIHelper.SKIP:
+            self.commodity_code = commodity_code
+        if discount_amount is not APIHelper.SKIP:
+            self.discount_amount = discount_amount
+        if other_tax_amount is not APIHelper.SKIP:
+            self.other_tax_amount = other_tax_amount
+        if product_code is not APIHelper.SKIP:
+            self.product_code = product_code
+        if quantity is not APIHelper.SKIP:
+            self.quantity = quantity
+        if tax_amount is not APIHelper.SKIP:
+            self.tax_amount = tax_amount
+        if tax_rate is not APIHelper.SKIP:
+            self.tax_rate = tax_rate
+        if unit_code is not APIHelper.SKIP:
+            self.unit_code = unit_code
+        if unit_cost is not APIHelper.SKIP:
+            self.unit_cost = unit_cost
+        if alternate_tax_id is not APIHelper.SKIP:
+            self.alternate_tax_id = alternate_tax_id
+        if debit_credit is not APIHelper.SKIP:
+            self.debit_credit = debit_credit
+        if discount_rate is not APIHelper.SKIP:
+            self.discount_rate = discount_rate
+        if tax_type_applied is not APIHelper.SKIP:
+            self.tax_type_applied = tax_type_applied
+        if tax_type_id is not APIHelper.SKIP:
+            self.tax_type_id = tax_type_id
+
+        # Add additional model properties to the instance
+        if additional_properties is None:
+            additional_properties = {}
+        self.additional_properties = additional_properties
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        description =\
+            dictionary.get("description")\
+            if dictionary.get("description")\
+                else APIHelper.SKIP
+        commodity_code =\
+            dictionary.get("commodity_code")\
+            if dictionary.get("commodity_code")\
+                else APIHelper.SKIP
+        discount_amount =\
+            dictionary.get("discount_amount")\
+            if "discount_amount" in dictionary.keys()\
+                else APIHelper.SKIP
+        other_tax_amount =\
+            dictionary.get("other_tax_amount")\
+            if "other_tax_amount" in dictionary.keys()\
+                else APIHelper.SKIP
+        product_code =\
+            dictionary.get("product_code")\
+            if dictionary.get("product_code")\
+                else APIHelper.SKIP
+        quantity =\
+            dictionary.get("quantity")\
+            if "quantity" in dictionary.keys()\
+                else APIHelper.SKIP
+        tax_amount =\
+            dictionary.get("tax_amount")\
+            if "tax_amount" in dictionary.keys()\
+                else APIHelper.SKIP
+        tax_rate =\
+            dictionary.get("tax_rate")\
+            if "tax_rate" in dictionary.keys()\
+                else APIHelper.SKIP
+        unit_code =\
+            dictionary.get("unit_code")\
+            if dictionary.get("unit_code")\
+                else APIHelper.SKIP
+        unit_cost =\
+            dictionary.get("unit_cost")\
+            if dictionary.get("unit_cost")\
+                else APIHelper.SKIP
+        alternate_tax_id =\
+            dictionary.get("alternate_tax_id")\
+            if "alternate_tax_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        debit_credit =\
+            dictionary.get("debit_credit")\
+            if "debit_credit" in dictionary.keys()\
+                else APIHelper.SKIP
+        discount_rate =\
+            dictionary.get("discount_rate")\
+            if "discount_rate" in dictionary.keys()\
+                else APIHelper.SKIP
+        tax_type_applied =\
+            dictionary.get("tax_type_applied")\
+            if "tax_type_applied" in dictionary.keys()\
+                else APIHelper.SKIP
+        tax_type_id =\
+            dictionary.get("tax_type_id")\
+            if "tax_type_id" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Clean out expected properties from dictionary
+        additional_properties =\
+            {k: v for k, v in dictionary.items() if k not in cls._names.values()}
+
+        # Return an object of this model
+        return cls(description,
+                   commodity_code,
+                   discount_amount,
+                   other_tax_amount,
+                   product_code,
+                   quantity,
+                   tax_amount,
+                   tax_rate,
+                   unit_code,
+                   unit_cost,
+                   alternate_tax_id,
+                   debit_credit,
+                   discount_rate,
+                   tax_type_applied,
+                   tax_type_id,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _commodity_code=(
+            self.commodity_code
+            if hasattr(self, "commodity_code")
+            else None
+        )
+        _discount_amount=(
+            self.discount_amount
+            if hasattr(self, "discount_amount")
+            else None
+        )
+        _other_tax_amount=(
+            self.other_tax_amount
+            if hasattr(self, "other_tax_amount")
+            else None
+        )
+        _product_code=(
+            self.product_code
+            if hasattr(self, "product_code")
+            else None
+        )
+        _quantity=(
+            self.quantity
+            if hasattr(self, "quantity")
+            else None
+        )
+        _tax_amount=(
+            self.tax_amount
+            if hasattr(self, "tax_amount")
+            else None
+        )
+        _tax_rate=(
+            self.tax_rate
+            if hasattr(self, "tax_rate")
+            else None
+        )
+        _unit_code=(
+            self.unit_code
+            if hasattr(self, "unit_code")
+            else None
+        )
+        _unit_cost=(
+            self.unit_cost
+            if hasattr(self, "unit_cost")
+            else None
+        )
+        _alternate_tax_id=(
+            self.alternate_tax_id
+            if hasattr(self, "alternate_tax_id")
+            else None
+        )
+        _debit_credit=(
+            self.debit_credit
+            if hasattr(self, "debit_credit")
+            else None
+        )
+        _discount_rate=(
+            self.discount_rate
+            if hasattr(self, "discount_rate")
+            else None
+        )
+        _tax_type_applied=(
+            self.tax_type_applied
+            if hasattr(self, "tax_type_applied")
+            else None
+        )
+        _tax_type_id=(
+            self.tax_type_id
+            if hasattr(self, "tax_type_id")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"description={_description!r}, "
+            f"commodity_code={_commodity_code!r}, "
+            f"discount_amount={_discount_amount!r}, "
+            f"other_tax_amount={_other_tax_amount!r}, "
+            f"product_code={_product_code!r}, "
+            f"quantity={_quantity!r}, "
+            f"tax_amount={_tax_amount!r}, "
+            f"tax_rate={_tax_rate!r}, "
+            f"unit_code={_unit_code!r}, "
+            f"unit_cost={_unit_cost!r}, "
+            f"alternate_tax_id={_alternate_tax_id!r}, "
+            f"debit_credit={_debit_credit!r}, "
+            f"discount_rate={_discount_rate!r}, "
+            f"tax_type_applied={_tax_type_applied!r}, "
+            f"tax_type_id={_tax_type_id!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _commodity_code=(
+            self.commodity_code
+            if hasattr(self, "commodity_code")
+            else None
+        )
+        _discount_amount=(
+            self.discount_amount
+            if hasattr(self, "discount_amount")
+            else None
+        )
+        _other_tax_amount=(
+            self.other_tax_amount
+            if hasattr(self, "other_tax_amount")
+            else None
+        )
+        _product_code=(
+            self.product_code
+            if hasattr(self, "product_code")
+            else None
+        )
+        _quantity=(
+            self.quantity
+            if hasattr(self, "quantity")
+            else None
+        )
+        _tax_amount=(
+            self.tax_amount
+            if hasattr(self, "tax_amount")
+            else None
+        )
+        _tax_rate=(
+            self.tax_rate
+            if hasattr(self, "tax_rate")
+            else None
+        )
+        _unit_code=(
+            self.unit_code
+            if hasattr(self, "unit_code")
+            else None
+        )
+        _unit_cost=(
+            self.unit_cost
+            if hasattr(self, "unit_cost")
+            else None
+        )
+        _alternate_tax_id=(
+            self.alternate_tax_id
+            if hasattr(self, "alternate_tax_id")
+            else None
+        )
+        _debit_credit=(
+            self.debit_credit
+            if hasattr(self, "debit_credit")
+            else None
+        )
+        _discount_rate=(
+            self.discount_rate
+            if hasattr(self, "discount_rate")
+            else None
+        )
+        _tax_type_applied=(
+            self.tax_type_applied
+            if hasattr(self, "tax_type_applied")
+            else None
+        )
+        _tax_type_id=(
+            self.tax_type_id
+            if hasattr(self, "tax_type_id")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"description={_description!s}, "
+            f"commodity_code={_commodity_code!s}, "
+            f"discount_amount={_discount_amount!s}, "
+            f"other_tax_amount={_other_tax_amount!s}, "
+            f"product_code={_product_code!s}, "
+            f"quantity={_quantity!s}, "
+            f"tax_amount={_tax_amount!s}, "
+            f"tax_rate={_tax_rate!s}, "
+            f"unit_code={_unit_code!s}, "
+            f"unit_cost={_unit_cost!s}, "
+            f"alternate_tax_id={_alternate_tax_id!s}, "
+            f"debit_credit={_debit_credit!s}, "
+            f"discount_rate={_discount_rate!s}, "
+            f"tax_type_applied={_tax_type_applied!s}, "
+            f"tax_type_id={_tax_type_id!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )