pay.models.payable
==================

.. py:module:: pay.models.payable


Classes
-------

.. autoapisummary::

   pay.models.payable.PayableBase
   pay.models.payable.Payable
   pay.models.payable.PayableManyTimes


Functions
---------

.. autoapisummary::

   pay.models.payable.hash_primary_key


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

.. py:function:: hash_primary_key(text: str) -> str

.. py:class:: PayableBase

   .. py:attribute:: __tablename__
      :type:  ClassVar[str]


   .. py:property:: payable_reference
      :type: str


      A string which identifies this payable in payment lists. Do not
      join any values here as it can lead to an explosion of executed
      queries!

      By default we use the table name plus a hash derived from the
      primary key values of the table. This ensures that we do not
      accidentally leak secrets.

      In practice, this reference should be customised for each payable.




.. py:class:: Payable

   Bases: :py:obj:`PayableBase`


   Links the parent model with 0 to n :class:`~onegov.pay.models.Payment`
   records through an automatically generated association table.



   .. py:attribute:: payment
      :value: None



.. py:class:: PayableManyTimes

   Bases: :py:obj:`PayableBase`


   Same as :class:`Payable`, but using a list of payments instead of
   a single one (proper many-to-many payments).



   .. py:attribute:: payments
      :value: None