Acquire.Accounting._account module

class Account(name=None, description=None, uid=None, bucket=None)

Bases: object

This class represents a single account in the ledger. It has a balance, and a record of the set of transactions that have been applied.

The account really holds two accounts: the liability account and actual capital account. We combine both together into a single account to ensure that updates occur atomically

All data for this account is stored in the object store

assert_valid_authorisation(authorisation)

Assert that the passed authorisation is valid for this account

available_balance(bucket=None)

Return the available balance of this account. This is the amount of value that can be spent (e.g. includes overdraft and fixed daily spend limits, and except any outstanding liabilities)

balance(bucket=None)

Return the current balance of this account

balance_status(bucket=None)

Return the overall balance status as a dictionary with keys ‘balance’, ‘liability’, ‘receivable’ and ‘spent_today’

description()

Return the description of this account

static from_data(data)

Construct and return an Account from the passed dictionary that has been decoded from json

get_overdraft_limit()

Return the overdraft limit of this account

is_beyond_overdraft_limit(bucket=None)

Return whether or not the current balance is beyond the overdraft limit

is_null()

Return whether or not this is a null account

last_update_datetime()

Return the last time the balance was updated, as a datetime object

liability(bucket=None)

Return the current total liability of this account

name()

Return the name of this account

receivable(bucket=None)

Return the current total accounts receivable of this account

set_overdraft_limit(limit, bucket=None)

Set the overdraft limit of this account to ‘limit’

spent_today(bucket=None)

Return the current amount spent today on this account

to_data()

Return a dictionary that can be encoded to json from this object

uid()

Return the UID for this account.