Database Utilities

GetBalance()

class hordak.utilities.db_functions.GetBalance(*args, **kwargs)

Django representation of the get_balance() custom database function provided by Hordak

__init__(account_id: Combinable | int, as_of: Combinable | date | str | None = None, as_of_leg_id: Combinable | int | None = None, output_field=None, **extra)

Create a new GetBalance()

Examples

from hordak.utilities.db_functions import GetBalance

GetBalance(account_id=5)
GetBalance(account_id=5, as_of='2000-01-01')

Account.objects.all().annotate(
    balance=GetBalance(F("id"), as_of='2000-01-01')
)