@spec balanced?(t()) :: boolean()

Checks whether the interledger entry is balanced. It is balance if all of its journal entries are balanced.

Examples

Balanced entry:

iex> interledger = %Bookk.InterledgerEntry{
iex>   entries_by_ledger: %{
iex>     "acme" => [
iex>       %Bookk.JournalEntry{
iex>         operations: [
iex>           fixture_account_head(:cash) |> debit(30_00),
iex>           fixture_account_head(:deposits) |> credit(30_00)
iex>         ]
iex>       }
iex>     ]
iex>   }
iex> }
iex>
iex> Bookk.InterledgerEntry.balanced?(interledger)
true

Unbalanced entry:

iex> interledger = %Bookk.InterledgerEntry{
iex>   entries_by_ledger: %{
iex>     "acme" => [
iex>       %Bookk.JournalEntry{
iex>         operations: [
iex>           fixture_account_head(:cash) |> debit(30_00),
iex>         ]
iex>       }
iex>     ]
iex>   }
iex> }
iex>
iex> Bookk.InterledgerEntry.balanced?(interledger)
false

@spec empty?(t()) :: boolean()

Checks whether an interledger entry is empty. It is empty when it has now journal entries or when all its journal entries are empty.

See Bookk.JournalEntry.empty?/1 to learn more about empty journal entries.

Examples

Is empty when there's no entries:

iex> Bookk.InterledgerEntry.empty?(%Bookk.InterledgerEntry{})
true

Is empty when all entries are empty:

iex> interledger = %Bookk.InterledgerEntry{
iex>   entries_by_ledger: %{
iex>     "acme" => [
iex>       %Bookk.JournalEntry{
iex>         operations: [%Bookk.Operation{amount: 0}]
iex>       }
iex>     ]
iex>   }
iex> }
iex>
iex> Bookk.InterledgerEntry.empty?(interledger)
true

Is not empty when at least one entry isn't empty:

iex> interledger = %Bookk.InterledgerEntry{
iex>   entries_by_ledger: %{
iex>     "acme" => [
iex>       %Bookk.JournalEntry{
iex>         operations: [
iex>           %Bookk.Operation{amount: 0},
iex>           %Bookk.Operation{amount: 1},
iex>         ]
iex>       }
iex>     ]
iex>   }
iex> }
iex>
iex> Bookk.InterledgerEntry.empty?(interledger)
false

@spec reverse(t()) :: t()

Produces a new interledger entry that is equaly opposite of the given interledger entry, meaning its capable of reverting all the changes that the given entry causes.

Examples

Reverses all of its journal entries:

iex> interledger = %Bookk.InterledgerEntry{
iex>   entries_by_ledger: %{
iex>     "acme" => [
iex>       %Bookk.JournalEntry{
iex>         operations: [
iex>           fixture_account_head(:cash) |> debit(10_00),
iex>           fixture_account_head(:deposits) |> credit(10_00)
iex>         ]
iex>       }
iex>     ]
iex>   }
iex> }
iex>
iex> Bookk.InterledgerEntry.reverse(interledger)
%Bookk.InterledgerEntry{
  entries_by_ledger: %{
    "acme" => [
      %Bookk.JournalEntry{
        operations: [
          fixture_account_head(:deposits) |> debit(10_00),
          fixture_account_head(:cash) |> credit(10_00)
        ]
      }
    ]
  }
}

@spec to_journal_entries(t()) :: [{ledger_name :: String.t(), Bookk.JournalEntry.t()}]

Given an interledger entry, it returns all its journal entries in the form of a list of tuples where the first element is the ledger's name and the second element is a list of journal entries that are meant to be posted to such ledger.

Examples

Returns a list of tuple where the first element is the ledger name and the second element is a journal entry:

iex> user_id = "b13a81cf-ff78-414d-b5b2-042e9ecf2082"
iex> cash = fixture_account_head(:cash)
iex> deposits = fixture_account_head(:deposits)
iex> unspent_cash = fixture_account_head({:unspent_cash, {:user, user_id}})
iex>
iex> interledger = %Bookk.InterledgerEntry{
iex>   entries_by_ledger: %{
iex>     "acme" => [
iex>       Bookk.JournalEntry.new([
iex>         debit(cash, 50_00),
iex>         credit(unspent_cash, 50_00)
iex>       ])
iex>     ],
iex>     "user(b13a81cf-ff78-414d-b5b2-042e9ecf2082)" => [
iex>       Bookk.JournalEntry.new([
iex>         debit(cash, 50_00),
iex>         credit(deposits, 50_00)
iex>       ])
iex>     ]
iex>   }
iex> }
iex>
iex> Bookk.InterledgerEntry.to_journal_entries(interledger)
[
  {"acme", Bookk.JournalEntry.new([
    debit(fixture_account_head(:cash), 50_00),
    credit(fixture_account_head({:unspent_cash, {:user, "b13a81cf-ff78-414d-b5b2-042e9ecf2082"}}), 50_00)
  ])},
  {"user(b13a81cf-ff78-414d-b5b2-042e9ecf2082)", Bookk.JournalEntry.new([
    debit(fixture_account_head(:cash), 50_00),
    credit(fixture_account_head(:deposits), 50_00)
  ])}
]