pay.utils
=========

.. py:module:: pay.utils


Classes
-------

.. autoapisummary::

   pay.utils._PriceBase
   pay.utils.Price


Functions
---------

.. autoapisummary::

   pay.utils.payments_association_table_for


Module Contents
---------------

.. py:class:: _PriceBase

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: amount
      :type:  decimal.Decimal


   .. py:attribute:: currency
      :type:  str | None


   .. py:attribute:: fee
      :type:  decimal.Decimal


   .. py:attribute:: credit_card_payment
      :type:  bool


.. py:class:: Price

   Bases: :py:obj:`_PriceBase`


   A single price.

   The amount includes the fee. To get the net amount use the net_amount
   property.



   .. py:method:: __bool__() -> bool


   .. py:method:: __lt__(other: Price) -> bool

      Return self<value.



   .. py:method:: __add__(other: Price) -> Self

      Return self+value.



   .. py:method:: __sub__(other: Price) -> Self


   .. py:method:: __str__() -> str

      Return str(self).



   .. py:method:: __repr__() -> str

      Return repr(self).



   .. py:method:: zero() -> Self
      :classmethod:



   .. py:method:: as_dict() -> onegov.pay.types.PriceDict


   .. py:property:: net_amount
      :type: decimal.Decimal



.. py:function:: payments_association_table_for(cls: type[onegov.core.orm.Base]) -> sqlalchemy.Table