pay.models.payment
==================

.. py:module:: pay.models.payment


Classes
-------

.. autoapisummary::

   pay.models.payment.Payment
   pay.models.payment.ManualPayment


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

.. py:class:: Payment

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.abstract.associable.Associable`


   Represents a payment done through various means. 


   .. py:attribute:: __tablename__
      :value: 'payments'



   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: source
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: amount
      :type:  sqlalchemy.Column[decimal.Decimal | None]


   .. py:attribute:: currency
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: remote_id
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: state
      :type:  sqlalchemy.Column[onegov.pay.types.PaymentState]


   .. py:attribute:: provider_id
      :type:  sqlalchemy.Column[uuid.UUID | None]


   .. py:attribute:: provider
      :type:  sqlalchemy.orm.relationship[onegov.pay.models.PaymentProvider[Self] | None]


   .. py:attribute:: __mapper_args__


   .. py:property:: fee
      :type: decimal.Decimal


      The fee associated with this payment. The payment amount includes
      the fee. To get the net amount use the net_amount property.




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



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

      Our states are essentially one paid and n unpaid states (indicating
      various ways in which the payment can end up being unpaid).

      So this boolean acts as coarse filter to divide payemnts into the
      two states that really matter.




   .. py:property:: remote_url
      :type: str

      :abstractmethod:


      Returns the url of this object on the payment provider. 



   .. py:method:: sync(remote_obj: Any | None = None) -> None
      :abstractmethod:


      Updates the local payment information with the information from
      the remote payment provider.




.. py:class:: ManualPayment

   Bases: :py:obj:`Payment`


   A manual payment is a payment without associated payment provider.

   For example, a payment paid in cash.



   .. py:attribute:: __mapper_args__


   .. py:method:: sync(remote_obj: None = None) -> None

      Updates the local payment information with the information from
      the remote payment provider.