Packages

accounting

0.10.1
0.11.0 0.10.5 0.10.4 0.10.3 0.10.2 0.10.1 0.10.0 0.9.0 0.8.0 0.7.1 0.7.0 0.6.0 0.5.0 0.4.2 0.4.1 0.4.0 0.3.3 0.3.2 0.3.1 0.3.0 0.2.2 0.2.1 0.2.0 0.1.2 0.1.1 0.1.0

Accounting.

HexDocs

Current section

Files

Jump to
Readme
26 Versions
3 Dependencies
Dependants
Files
Activity
accounting lib accounting adapter.ex
Raw

lib/accounting/adapter.ex 

defmodule Accounting.Adapter do

  @moduledoc """

  A behaviour module for implementing the adapter for a particular journal.

  """



  alias Accounting.{Entry, Journal}



  @typep account_number :: Accounting.account_number



  @callback child_spec(keyword) :: Supervisor.child_spec

  @callback fetch_accounts(Journal.id, [account_number], timeout) :: {:ok, Journal.accounts} | {:error, term}

  @callback record_entries(Journal.id, [Entry.t, ...], timeout) :: :ok | {:error, [Entry.Error.t] | term}

  @callback register_account(Journal.id, account_number, String.t, timeout) :: :ok | {:error, term}

  @callback register_categories(Journal.id, [atom], timeout) :: :ok | {:error, term}

  @callback start_link(opts :: any) :: Supervisor.on_start

end