Beancount.Directives.Note (beancount_ex v0.6.0)

Copy Markdown View Source

The note directive attaches a dated comment to an account.

See Notes.

Beancount syntax

2026-01-01 note Assets:Bank "Called the bank about fees"

General form: YYYY-MM-DD note Account "Comment"

Elixir struct

%Beancount.Directives.Note{
  date: ~D[2026-01-01],
  account: "Assets:Bank",
  comment: "Called the bank about fees",
  metadata: %{}
}

Or use Beancount.note/4:

Beancount.note(~D[2026-01-01], "Assets:Bank", "Called the bank about fees")

Fields

  • date - Date.t() the note applies to.
  • account - account the comment is attached to.
  • comment - free-text string (rendered quoted).
  • metadata - optional map rendered below the directive.

Summary

Types

t()

Types

t()

@type t() :: %Beancount.Directives.Note{
  account: String.t(),
  comment: String.t(),
  date: Date.t(),
  metadata: map()
}