pay.models.invoice
==================

.. py:module:: pay.models.invoice


Classes
-------

.. autoapisummary::

   pay.models.invoice.Invoice


Functions
---------

.. autoapisummary::

   pay.models.invoice.sync_invoice_items


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

.. py:function:: sync_invoice_items(items: collections.abc.Iterable[onegov.pay.models.invoice_item.InvoiceItem], capture: bool = True) -> None

.. py:class:: Invoice

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   A grouping of invoice items. 


   .. py:attribute:: __tablename__
      :value: 'invoices'



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


   .. py:attribute:: __mapper_args__


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


   .. py:attribute:: items
      :type:  sqlalchemy.orm.relationship[list[onegov.pay.models.invoice_item.InvoiceItem]]


   .. py:attribute:: references
      :type:  sqlalchemy.orm.relationship[list[onegov.pay.models.InvoiceReference]]


   .. py:attribute:: __table_args__


   .. py:property:: price
      :type: onegov.pay.utils.Price



   .. py:method:: readable_by_bucket(bucket: str) -> str | None


   .. py:method:: sync(capture: bool = True) -> None


   .. py:method:: add(group: str, text: str, unit: decimal.Decimal, quantity: decimal.Decimal, *, type: str = 'generic', family: str | None = None, vat_rate: decimal.Decimal | None = None, tid: str | None = None, source: str | None = None, flush: bool = True, **kwargs: Any) -> onegov.pay.models.invoice_item.InvoiceItem


   .. py:attribute:: paid
      :type:  sqlalchemy.Column[bool]


   .. py:method:: total_amount() -> decimal.Decimal


   .. py:method:: outstanding_amount() -> decimal.Decimal


   .. py:method:: paid_amount() -> decimal.Decimal


   .. py:property:: total_excluding_manual_entries
      :type: decimal.Decimal



   .. py:property:: total_vat
      :type: decimal.Decimal