feriennet.collections.billing
=============================

.. py:module:: feriennet.collections.billing


Classes
-------

.. autoapisummary::

   feriennet.collections.billing.InvoicesByPeriodRow
   feriennet.collections.billing.BillingCollection
   feriennet.collections.billing.BookingInvoiceBridge


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

.. py:class:: InvoicesByPeriodRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: realname
      :type:  str


   .. py:attribute:: username
      :type:  str


   .. py:attribute:: group
      :type:  str


   .. py:attribute:: attendee_id
      :type:  uuid.UUID | None


   .. py:attribute:: text
      :type:  str


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


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


   .. py:attribute:: paid
      :type:  bool


   .. py:attribute:: has_online_payments
      :type:  bool


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


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


   .. py:attribute:: period_id
      :type:  uuid.UUID


   .. py:attribute:: changes
      :type:  Literal['possible', 'discouraged', 'impossible']


   .. py:attribute:: invoice_id
      :type:  uuid.UUID


   .. py:attribute:: invoice_paid
      :type:  bool


   .. py:attribute:: invoice_amount
      :type:  decimal.Decimal


   .. py:attribute:: invoice_outstanding
      :type:  decimal.Decimal


   .. py:attribute:: invoice_changes
      :type:  Literal['possible', 'discouraged', 'impossible']


.. py:class:: BillingCollection(request: onegov.feriennet.request.FeriennetRequest, period: onegov.activity.models.Period | onegov.activity.models.PeriodMeta, username: str | None = None, expand: bool = False, state: Literal['paid', 'unpaid'] | None = None)

   .. py:attribute:: request


   .. py:attribute:: session


   .. py:attribute:: app


   .. py:attribute:: period


   .. py:attribute:: username
      :value: None



   .. py:attribute:: expand
      :value: False



   .. py:attribute:: invoices


   .. py:attribute:: state
      :value: None



   .. py:property:: user_id
      :type: uuid.UUID | None



   .. py:property:: period_id
      :type: uuid.UUID



   .. py:method:: for_period(period: onegov.activity.models.Period) -> Self


   .. py:method:: for_username(username: str) -> Self


   .. py:method:: for_expand(expand: bool) -> Self


   .. py:method:: for_state(state: Literal['paid', 'unpaid'] | None) -> Self


   .. py:property:: invoices_by_period_query
      :type: sqlalchemy.sql.selectable.Alias



   .. py:property:: invoices_by_period
      :type: sqlalchemy.orm.Query[InvoicesByPeriodRow]



   .. py:class:: Bill

      Bases: :py:obj:`NamedTuple`


      .. py:attribute:: items
         :type:  tuple[InvoicesByPeriodRow, Ellipsis]


      .. py:attribute:: first
         :type:  InvoicesByPeriodRow


      .. py:attribute:: id
         :type:  uuid.UUID


      .. py:attribute:: invoice_id
         :type:  uuid.UUID


      .. py:attribute:: title
         :type:  str


      .. py:attribute:: paid
         :type:  bool


      .. py:attribute:: total
         :type:  decimal.Decimal


      .. py:attribute:: outstanding
         :type:  decimal.Decimal


      .. py:attribute:: discourage_changes
         :type:  bool


      .. py:attribute:: disable_changes
         :type:  bool


      .. py:attribute:: has_online_payments
         :type:  bool



   .. py:property:: bills
      :type: dict[str, Bill]



   .. py:property:: total
      :type: decimal.Decimal



   .. py:property:: outstanding
      :type: decimal.Decimal



   .. py:method:: add_position(users: collections.abc.Collection[str], text: str, amount: decimal.Decimal, group: str) -> int


   .. py:method:: add_manual_position(users: collections.abc.Collection[str], text: str, amount: decimal.Decimal) -> int


   .. py:method:: include_donation(text: str, user_id: uuid.UUID, amount: decimal.Decimal) -> onegov.activity.InvoiceItem | None

      Includes a donation for the given user and period.

      Unlike manual positions, donations are supposed to be off/on per
      period. Therefore this interface is somewhat different and has an
      exclude_donation counterpart.




   .. py:method:: exclude_donation(user_id: uuid.UUID) -> bool | None


   .. py:method:: create_invoices(all_inclusive_booking_text: str | None = None) -> None


.. py:class:: BookingInvoiceBridge(session: sqlalchemy.orm.Session, period: onegov.activity.models.Period | onegov.activity.models.PeriodMeta)

   Creates invoices from bookings.

   Should be used in a two-phase process, with one exception:

   1. The bookings are processed using `process`.
   2. Premiums are applied by calling `complete`.

   The exception is if you want to simply process a single booking after
   the premiums have been processed already. This is an exception for admins
   which may add bookings after all bills have been processed already.



   .. py:attribute:: attendees
      :type:  dict[uuid.UUID, tuple[str, str]]


   .. py:attribute:: processed_attendees
      :type:  set[uuid.UUID]


   .. py:attribute:: billed_attendees
      :type:  set[uuid.UUID]


   .. py:attribute:: session


   .. py:attribute:: period


   .. py:attribute:: invoices


   .. py:attribute:: activities


   .. py:attribute:: existing


   .. py:attribute:: users


   .. py:method:: process(booking: onegov.activity.Booking) -> None

      Processes a single booking. This may be a tuple that includes
      the following fields, though a model may also work:

      * `Booking.username`
      * `Booking.cost`
      * `Booking.occasion_id`
      * `Booking.attendee_id`




   .. py:method:: complete(all_inclusive_booking_text: str | None) -> None

      Finalises the processed bookings.