View Source Bookk.AccountHead (bookk v0.1.3)

An Account head is a struct contained all the values necessary to either fetch or create a Bookk.Account from/into a Bookk.Ledger.

Summary

Types

t()

The struct that describes an account head.

Types

@type t() :: %Bookk.AccountHead{
  class: Bookk.AccountClass.t(),
  meta: map(),
  name: String.t()
}

The struct that describes an account head.

Fields

An account head is composed of:

  • name: the accounts name (unique within a ledger);
  • class: a Bookk.AccountClass struct that describes the class to which the account belongs;
  • meta: a map of metadata for whatever information you find useful to hold there for when you need to fetch, create or "hydrate" a persisted account.