pay.collections.invoice

Attributes

InvoiceT
ItemT

Classes

InvoiceCollection

Abstract base class for generic types.

Module Contents

pay.collections.invoice.InvoiceT

pay.collections.invoice.ItemT

class pay.collections.invoice.InvoiceCollection(session: sqlalchemy.orm.Session, type: Literal['*', 'generic'] = '*', item_type: Literal['*', 'generic'] = '*')

class pay.collections.invoice.InvoiceCollection(session: sqlalchemy.orm.Session, type: str, item_type: str)

Bases: onegov.core.collection.GenericCollection[InvoiceT], Generic[InvoiceT, ItemT]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

type = '*'

item_type = '*'

property model_class: type[InvoiceT]

property item_model_class: type[ItemT]

query() → sqlalchemy.orm.Query[InvoiceT]

query_items() → sqlalchemy.orm.Query[ItemT]

_invoice_ids() → sqlalchemy.orm.Query[tuple[uuid.UUID]]

_sum(condition: sqlalchemy.sql.ColumnElement[bool]) → decimal.Decimal

property total_amount: decimal.Decimal

property outstanding_amount: decimal.Decimal

property paid_amount: decimal.Decimal

unpaid_count() → int

add(flush: bool = True, **kwargs: Any) → InvoiceT