pay.utils

Classes

`_PriceBase`
`Price`	A single price.
`InvoiceItemMeta`
`_InvoiceDiscountMetaBase`
`InvoiceDiscountMeta`	Built-in immutable sequence.

Functions

payments_association_table_for(→ sqlalchemy.Table)

Module Contents

class pay.utils._PriceBase[source]

Bases: NamedTuple

amount: decimal.Decimal[source]

currency: str | None[source]

fee: decimal.Decimal[source]

credit_card_payment: bool[source]

class pay.utils.Price[source]

Bases: _PriceBase

A single price.

The amount includes the fee. To get the net amount use the net_amount property.

__bool__() → bool[source]

__lt__(other: Price) → bool[source]: Return self<value.

__add__(other: Price) → Self[source]: Return self+value.

__sub__(other: Price) → Self[source]

__mul__(other: decimal.Decimal | float | SupportsIndex) → Self[source]: Return self*value.

__rmul__[source]: Return value*self.

__str__() → str[source]: Return str(self).

__repr__() → str[source]: Return repr(self).

classmethod zero() → Self[source]

as_dict() → onegov.pay.types.PriceDict[source]

property net_amount: decimal.Decimal[source]

apply_discount(discount: decimal.Decimal) → Self[source]

class pay.utils.InvoiceItemMeta[source]

text: str[source]

group: str[source]

unit: decimal.Decimal[source]

quantity: decimal.Decimal[source]

vat_rate: decimal.Decimal | None = None[source]

family: str | None = None[source]

extra: dict[str, Any] | None = None[source]

property amount: decimal.Decimal[source]

property vat: decimal.Decimal[source]

property net_amount: decimal.Decimal[source]

static total(items: collections.abc.Iterable[InvoiceItemMeta]) → decimal.Decimal[source]

static total_vat(items: collections.abc.Iterable[InvoiceItemMeta]) → decimal.Decimal[source]

add_to_invoice(invoice: onegov.pay.models.Invoice) → onegov.pay.models.InvoiceItem[source]

refresh_item(item: onegov.pay.models.InvoiceItem) → None[source]

class pay.utils._InvoiceDiscountMetaBase[source]

Bases: NamedTuple

text: str[source]

group: str[source]

discount: decimal.Decimal[source]

vat_rate: decimal.Decimal | None = None[source]

family: str | None = None[source]

extra: dict[str, Any] | None = None[source]

class pay.utils.InvoiceDiscountMeta[source]

Bases: _InvoiceDiscountMetaBase

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable’s items.

If the argument is a tuple, the return value is the same object.

apply_discount(total: decimal.Decimal, remainder: decimal.Decimal) → InvoiceItemMeta[source]

pay.utils.payments_association_table_for(cls: type[onegov.core.orm.Base]) → sqlalchemy.Table[source]