This is the cl-ledger Reference Manual, version 4.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 19:17:36 2025 GMT+0.
cl-ledger/cl-ledger.asdcl-ledger/core/packages.lispcl-ledger/core/types.lispcl-ledger/core/general.lispcl-ledger/core/ledger.lispcl-ledger/core/transaction.lispcl-ledger/core/normalize.lispcl-ledger/core/valexpr.lispcl-ledger/core/emacs.lispcl-ledger/transforms/totals.lispcl-ledger/transforms/filter.lispcl-ledger/transforms/periodic.lispcl-ledger/transforms/sort.lispcl-ledger/transforms/collapse.lispcl-ledger/transforms/invert.lispcl-ledger/transforms/subtotal.lispcl-ledger/transforms/related.lispcl-ledger/transforms/transform.lispcl-ledger/reports/report.lispcl-ledger/reports/register.lispcl-ledger/reports/sexp.lispcl-ledger/reports/balance.lispcl-ledger/reports/print.lispcl-ledger/reports/entry.lispcl-ledger/reports/csv.lispcl-ledger/parsers/textual/textual.lispcl-ledger/parsers/textual/autoentry.lispcl-ledger/parsers/textual/perentry.lispcl-ledger/driver.lispThe main system appears first, followed by any subsystem dependency.
cl-ledgerDouble-entry accounting system.
Guillaume LE VAILLANT <glv@posteo.net>
John Wiegley <jwiegley@gmail.com>
BSD-3
4.0.0
local-time (system).
periods-series (system).
cambl (system).
cl-ppcre (system).
core (module).
transforms (module).
reports (module).
parsers (module).
driver.lisp (file).
Modules are listed depth-first from the system components tree.
cl-ledger/corecl-ledger (system).
packages.lisp (file).
types.lisp (file).
general.lisp (file).
ledger.lisp (file).
transaction.lisp (file).
normalize.lisp (file).
valexpr.lisp (file).
emacs.lisp (file).
cl-ledger/transformscore (module).
cl-ledger (system).
totals.lisp (file).
filter.lisp (file).
periodic.lisp (file).
sort.lisp (file).
collapse.lisp (file).
invert.lisp (file).
subtotal.lisp (file).
related.lisp (file).
transform.lisp (file).
cl-ledger/reportstransforms (module).
cl-ledger (system).
report.lisp (file).
register.lisp (file).
sexp.lisp (file).
balance.lisp (file).
print.lisp (file).
entry.lisp (file).
csv.lisp (file).
cl-ledger/parsersreports (module).
cl-ledger (system).
textual (module).
cl-ledger/parsers/textualparsers (module).
textual.lisp (file).
autoentry.lisp (file).
perentry.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-ledger/cl-ledger.asdcl-ledger/core/packages.lispcl-ledger/core/types.lispcl-ledger/core/general.lispcl-ledger/core/ledger.lispcl-ledger/core/transaction.lispcl-ledger/core/normalize.lispcl-ledger/core/valexpr.lispcl-ledger/core/emacs.lispcl-ledger/transforms/totals.lispcl-ledger/transforms/filter.lispcl-ledger/transforms/periodic.lispcl-ledger/transforms/sort.lispcl-ledger/transforms/collapse.lispcl-ledger/transforms/invert.lispcl-ledger/transforms/subtotal.lispcl-ledger/transforms/related.lispcl-ledger/transforms/transform.lispcl-ledger/reports/report.lispcl-ledger/reports/register.lispcl-ledger/reports/sexp.lispcl-ledger/reports/balance.lispcl-ledger/reports/print.lispcl-ledger/reports/entry.lispcl-ledger/reports/csv.lispcl-ledger/parsers/textual/textual.lispcl-ledger/parsers/textual/autoentry.lispcl-ledger/parsers/textual/perentry.lispcl-ledger/driver.lispcl-ledger/core/types.lisppackages.lisp (file).
core (module).
account (class).
account-children (reader method).
(setf account-children) (writer method).
account-data (reader method).
(setf account-data) (writer method).
account-fullname (reader method).
(setf account-fullname) (writer method).
account-name (reader method).
(setf account-name) (writer method).
account-parent (reader method).
(setf account-parent) (writer method).
add-journal (generic function).
add-transaction (generic function).
binder (class).
binder-commodity-pool (reader method).
(setf binder-commodity-pool) (writer method).
binder-data (reader method).
(setf binder-data) (writer method).
binder-journals (reader method).
(setf binder-journals) (writer method).
binder-root-account (reader method).
(setf binder-root-account) (writer method).
copy-item-position (function).
entries-iterator (generic function).
entry (class).
entry-actual-date (reader method).
(setf entry-actual-date) (writer method).
entry-code (reader method).
(setf entry-code) (writer method).
entry-data (reader method).
(setf entry-data) (writer method).
entry-effective-date (reader method).
(setf entry-effective-date) (writer method).
entry-journal (reader method).
(setf entry-journal) (writer method).
entry-note (reader method).
(setf entry-note) (writer method).
entry-payee (reader method).
(setf entry-payee) (writer method).
entry-position (reader method).
(setf entry-position) (writer method).
entry-status (reader method).
(setf entry-status) (writer method).
entry-transactions (reader method).
(setf entry-transactions) (writer method).
find-account (generic function).
item-position (structure).
item-position-begin-line (reader).
(setf item-position-begin-line) (writer).
item-position-end-line (reader).
(setf item-position-end-line) (writer).
item-position-source (reader).
(setf item-position-source) (writer).
item-status (type).
journal (class).
journal-binder (reader method).
(setf journal-binder) (writer method).
journal-contents (reader method).
(setf journal-contents) (writer method).
journal-data (reader method).
(setf journal-data) (writer method).
journal-date-format (reader method).
(setf journal-date-format) (writer method).
journal-default-account (reader method).
(setf journal-default-account) (writer method).
journal-default-year (reader method).
(setf journal-default-year) (writer method).
journal-source (reader method).
(setf journal-source) (writer method).
make-item-position (function).
make-transaction (function).
make-value-expr (function).
print-object (method).
transaction (structure).
transactions-iterator (generic function).
value-expr-function (reader).
(setf value-expr-function) (writer).
value-expr-p (function).
value-expr-string (reader).
(setf value-expr-string) (writer).
binderp (function).
copy-transaction (function).
copy-value-expr (function).
entry-normalizedp (reader method).
(setf entry-normalizedp) (writer method).
get-xact-account (reader).
(setf get-xact-account) (writer).
get-xact-actual-date (reader).
(setf get-xact-actual-date) (writer).
get-xact-amount (reader).
(setf get-xact-amount) (writer).
get-xact-calculatedp (reader).
(setf get-xact-calculatedp) (writer).
get-xact-cost (reader).
(setf get-xact-cost) (writer).
get-xact-data (reader).
(setf get-xact-data) (writer).
get-xact-effective-date (reader).
(setf get-xact-effective-date) (writer).
get-xact-entry (reader).
(setf get-xact-entry) (writer).
get-xact-generatedp (reader).
(setf get-xact-generatedp) (writer).
get-xact-must-balance-p (reader).
(setf get-xact-must-balance-p) (writer).
get-xact-note (reader).
(setf get-xact-note) (writer).
get-xact-position (reader).
(setf get-xact-position) (writer).
get-xact-status (reader).
(setf get-xact-status) (writer).
get-xact-virtualp (reader).
(setf get-xact-virtualp) (writer).
item-position-p (function).
journal-last-content-cell (reader method).
(setf journal-last-content-cell) (writer method).
journal-read-date (reader method).
(setf journal-read-date) (writer method).
transaction-p (function).
value-expr (structure).
cl-ledger/core/general.lisptypes.lisp (file).
core (module).
add-to-plist (macro).
chain-functions (function).
do-iterator (macro).
do-recurse (macro).
if-let (macro).
ignore-args (function).
ignore-rest (function).
list-iterator (function).
map-iterator (function).
negatef (macro).
split-string-at-char (function).
while (macro).
cl-ledger/core/ledger.lispgeneral.lisp (file).
core (module).
*allow-embedded-lisp* (special variable).
*last-binder* (special variable).
*registered-parsers* (special variable).
*use-effective-dates* (special variable).
add-journal (method).
add-journal (method).
add-journal (method).
add-journal (method).
add-to-contents (function).
add-transaction (method).
binder (function).
binder-statistics (function).
copy-entry (function).
do-entries (macro).
do-transactions (macro).
entries-iterator (method).
entries-iterator (method).
entries-iterator (method).
entries-list (function).
entry-date (function).
find-account (method).
find-account (method).
find-child-account (function).
map-entries (macro).
map-transactions (macro).
parse-journal-date (function).
read-journal (function).
scan-entries (function).
scan-transactions (function).
transactions-iterator (method).
transactions-iterator (method).
transactions-iterator (method).
transactions-iterator (method).
transactions-list (function).
account-set-value (function).
(setf account-value) (setf expander).
account-value (function).
add-journal-from-path (function).
binder-time-range (function).
compare-path-lists (function).
reset-accounts (function).
with-temporary-journal (macro).
cl-ledger/core/transaction.lispledger.lisp (file).
core (module).
group-transactions-by-entry (function).
(setf xact-account) (setf expander).
xact-account (function).
xact-actual-date (function).
(setf xact-amount) (setf expander).
xact-amount (function).
(setf xact-amount*) (setf expander).
xact-amount* (function).
xact-cleared-p (function).
(setf xact-cost) (setf expander).
xact-cost (function).
(setf xact-data) (setf expander).
xact-data (function).
xact-date (function).
(setf xact-effective-date) (setf expander).
xact-effective-date (function).
(setf xact-entry) (setf expander).
xact-entry (function).
(setf xact-must-balance-p) (setf expander).
xact-must-balance-p (function).
(setf xact-note) (setf expander).
xact-note (function).
xact-pending-p (function).
(setf xact-position) (setf expander).
xact-position (function).
(setf xact-status) (setf expander).
xact-status (function).
xact-uncleared-p (function).
(setf xact-value) (setf expander).
xact-value (function).
(setf xact-virtualp) (setf expander).
xact-virtualp (function).
print-transaction (function).
set-xact-account (function).
set-xact-actual-date (function).
set-xact-amount (function).
set-xact-amount* (function).
set-xact-calculatedp (function).
set-xact-cost (function).
set-xact-data (function).
set-xact-effective-date (function).
set-xact-entry (function).
set-xact-generatedp (function).
set-xact-must-balance-p (function).
set-xact-note (function).
set-xact-position (function).
set-xact-status (function).
set-xact-virtualp (function).
xact-amount-expr (function).
(setf xact-calculatedp) (setf expander).
xact-calculatedp (function).
xact-cost-total (function).
xact-display-amount (function).
xact-display-total (function).
(setf xact-generatedp) (setf expander).
xact-generatedp (function).
xact-total (function).
cl-ledger/core/normalize.lisptransaction.lisp (file).
core (module).
*post-normalization-functions* (special variable).
*pre-normalization-functions* (special variable).
normalize-entry (function).
cl-ledger/core/valexpr.lispnormalize.lisp (file).
core (module).
parse-value-expr (function).
read-value-expr (function).
*value-expr-commodity-pool* (special variable).
*value-expr-last-xact* (special variable).
*value-expr-observe-properties-p* (special variable).
*value-expr-readtable* (special variable).
*value-expr-reduce-to-smallest-units-p* (special variable).
*value-expr-series-offset* (special variable).
apply-this-or-last (function).
as-boolean (function).
ignore-character (function).
ignore-xact (function).
make-comparator (macro).
read-add-expr (function).
read-and-expr (function).
read-comma-expr (function).
read-logic-expr (function).
read-mul-expr (function).
read-or-expr (function).
read-unary-expr (function).
read-value-term (function).
value-expr-call (function).
cl-ledger/core/emacs.lispvalexpr.lisp (file).
core (module).
find-current-entity (function).
cl-ledger/transforms/totals.lisptransforms (module).
calculate-totals (function).
bridge-running-totals (function).
calculate-account-totals (function).
displayed-amount-setter (function).
get-computed-amount (function).
get-computed-total (function).
cl-ledger/transforms/filter.lisptotals.lisp (file).
transforms (module).
*predicate-keywords* (special variable).
apply-filter (function).
choose-if-value-expr (function).
parse-predicate-keywords (function).
account-matcher (function).
eq-matcher (function).
fixed-time-matcher (function).
not-matcher (function).
note-matcher (function).
payee-matcher (function).
regex-matcher (function).
status-matcher (function).
time-range-matcher (function).
value-expr-matcher (function).
cl-ledger/transforms/periodic.lispfilter.lisp (file).
transforms (module).
group-by-period (function).
periodic-transform (function).
cl-ledger/transforms/sort.lispperiodic.lisp (file).
transforms (module).
sort-entries (function).
sort-transactions (function).
cl-ledger/transforms/collapse.lispsort.lisp (file).
transforms (module).
collapse-entries (function).
cl-ledger/transforms/invert.lispcollapse.lisp (file).
transforms (module).
invert-transactions (function).
cl-ledger/transforms/subtotal.lispinvert.lisp (file).
transforms (module).
group-by-account (function).
cl-ledger/transforms/transform.lisprelated.lisp (file).
transforms (module).
apply-key-transforms (function).
cl-ledger/reports/report.lispreports (module).
accounts-report (function).
basic-reporter (function).
find-all-transactions (function).
print-account (function).
transaction-printer (function).
transactions-report (function).
cl-ledger/reports/register.lispreport.lisp (file).
reports (module).
abbreviate-string (function).
register-report (function).
maybe-subseq (function).
register-reporter (function).
cl-ledger/reports/sexp.lispregister.lisp (file).
reports (module).
find-account-tree (function).
find-sibling-accounts (function).
find-unique-accounts (function).
find-unique-payees (function).
sexp-report (function).
transactions-to-sexp (function).
xacts-to-sexp (function).
cl-ledger/reports/balance.lispsexp.lisp (file).
reports (module).
balance-report (function).
balance-print-reporter (function).
balance-reporter (function).
report-accounts (function).
cl-ledger/reports/print.lispbalance.lisp (file).
reports (module).
account-names-report (function).
equity-report (function).
payees-report (function).
print-entry (function).
print-report (function).
print-reporter (function).
print-transactions (function).
cl-ledger/reports/entry.lispprint.lisp (file).
reports (module).
derive-entry (function).
print-new-entry (function).
cl-ledger/reports/csv.lispentry.lisp (file).
reports (module).
csv-report (function).
csv-reporter (function).
cl-ledger/parsers/textual/textual.lisptextual (module).
*directive-handlers* (special variable).
*comment-line-scanner* (special variable).
*comment-regexp* (special variable).
*date-regexp* (special variable).
*entry-heading-scanner* (special variable).
*price-scanner* (special variable).
*spacing-regexp* (special variable).
*transaction-scanner* (special variable).
ledger-text-directive/account (function).
ledger-text-directive/alias (function).
ledger-text-directive/def (function).
ledger-text-directive/end (function).
ledger-text-directive/include (function).
read-plain-entry (function).
read-price (function).
read-textual-journal (function).
read-transaction (function).
cl-ledger/parsers/textual/autoentry.lisptextual.lisp (file).
textual (module).
apply-automated-entries (function).
auto-entry-predicate (reader method).
(setf auto-entry-predicate) (writer method).
auto-entry-predicate-expr (reader method).
(setf auto-entry-predicate-expr) (writer method).
automated-entry (class).
read-automated-entry (function).
cl-ledger/parsers/textual/perentry.lisptextual.lisp (file).
autoentry.lisp (file).
textual (module).
entry-period (reader method).
(setf entry-period) (writer method).
periodic-entry (class).
read-periodic-entry (function).
cl-ledger/driver.lispparsers (module).
cl-ledger (system).
process-command-line (function).
command-line-args (function).
driver-help (function).
main (function).
regexp-opt (function).
Packages are listed by definition order.
ledger-textualcambl.
cl-ledger.
cl-ppcre.
common-lisp.
local-time.
periods.
*directive-handlers* (special variable).
*comment-line-scanner* (special variable).
*comment-regexp* (special variable).
*date-regexp* (special variable).
*entry-heading-scanner* (special variable).
*price-scanner* (special variable).
*spacing-regexp* (special variable).
*transaction-scanner* (special variable).
apply-automated-entries (function).
auto-entry-predicate (generic reader).
(setf auto-entry-predicate) (generic writer).
auto-entry-predicate-expr (generic reader).
(setf auto-entry-predicate-expr) (generic writer).
automated-entry (class).
entry-period (generic reader).
(setf entry-period) (generic writer).
ledger-text-directive/account (function).
ledger-text-directive/alias (function).
ledger-text-directive/def (function).
ledger-text-directive/end (function).
ledger-text-directive/include (function).
periodic-entry (class).
read-automated-entry (function).
read-periodic-entry (function).
read-plain-entry (function).
read-price (function).
read-textual-journal (function).
read-transaction (function).
cl-ledgerledger
cambl.
common-lisp.
local-time.
periods.
periods-series.
series.
*allow-embedded-lisp* (special variable).
*last-binder* (special variable).
*post-normalization-functions* (special variable).
*pre-normalization-functions* (special variable).
*predicate-keywords* (special variable).
*registered-parsers* (special variable).
*use-effective-dates* (special variable).
abbreviate-string (function).
account (class).
account-children (generic reader).
(setf account-children) (generic writer).
account-data (generic reader).
(setf account-data) (generic writer).
account-fullname (generic reader).
(setf account-fullname) (generic writer).
account-name (generic reader).
(setf account-name) (generic writer).
account-names-report (function).
account-parent (generic reader).
(setf account-parent) (generic writer).
add-journal (generic function).
add-to-contents (function).
add-transaction (generic function).
apply-filter (function).
balance-report (function).
binder (function).
binder (class).
binder-commodity-pool (generic reader).
(setf binder-commodity-pool) (generic writer).
binder-data (generic reader).
(setf binder-data) (generic writer).
binder-journals (generic reader).
(setf binder-journals) (generic writer).
binder-root-account (generic reader).
(setf binder-root-account) (generic writer).
binder-statistics (function).
calculate-totals (function).
choose-if-value-expr (function).
copy-entry (function).
copy-item-position (function).
csv-report (function).
derive-entry (function).
do-entries (macro).
do-transactions (macro).
entries-iterator (generic function).
entries-list (function).
entry (class).
entry-actual-date (generic reader).
(setf entry-actual-date) (generic writer).
entry-code (generic reader).
(setf entry-code) (generic writer).
entry-data (generic reader).
(setf entry-data) (generic writer).
entry-date (function).
entry-effective-date (generic reader).
(setf entry-effective-date) (generic writer).
entry-journal (generic reader).
(setf entry-journal) (generic writer).
entry-note (generic reader).
(setf entry-note) (generic writer).
entry-payee (generic reader).
(setf entry-payee) (generic writer).
entry-position (generic reader).
(setf entry-position) (generic writer).
entry-status (generic reader).
(setf entry-status) (generic writer).
entry-transactions (generic reader).
(setf entry-transactions) (generic writer).
equity-report (function).
find-account (generic function).
find-account-tree (function).
find-child-account (function).
find-current-entity (function).
find-sibling-accounts (function).
find-unique-accounts (function).
find-unique-payees (function).
group-transactions-by-entry (function).
item-position (structure).
item-position-begin-line (reader).
(setf item-position-begin-line) (writer).
item-position-end-line (reader).
(setf item-position-end-line) (writer).
item-position-source (reader).
(setf item-position-source) (writer).
item-status (type).
journal (class).
journal-binder (generic reader).
(setf journal-binder) (generic writer).
journal-contents (generic reader).
(setf journal-contents) (generic writer).
journal-data (generic reader).
(setf journal-data) (generic writer).
journal-date-format (generic reader).
(setf journal-date-format) (generic writer).
journal-default-account (generic reader).
(setf journal-default-account) (generic writer).
journal-default-year (generic reader).
(setf journal-default-year) (generic writer).
journal-source (generic reader).
(setf journal-source) (generic writer).
make-item-position (function).
make-transaction (function).
make-value-expr (function).
map-entries (macro).
map-transactions (macro).
normalize-entry (function).
parse-journal-date (function).
parse-predicate-keywords (function).
parse-value-expr (function).
payees-report (function).
print-entry (function).
print-report (function).
process-command-line (function).
read-journal (function).
read-value-expr (function).
register-report (function).
scan-entries (function).
scan-transactions (function).
sexp-report (function).
transaction (structure).
transactions-iterator (generic function).
transactions-list (function).
value-expr-function (reader).
(setf value-expr-function) (writer).
value-expr-p (function).
value-expr-string (reader).
(setf value-expr-string) (writer).
(setf xact-account) (setf expander).
xact-account (function).
xact-actual-date (function).
(setf xact-amount) (setf expander).
xact-amount (function).
(setf xact-amount*) (setf expander).
xact-amount* (function).
xact-cleared-p (function).
(setf xact-cost) (setf expander).
xact-cost (function).
(setf xact-data) (setf expander).
xact-data (function).
xact-date (function).
(setf xact-effective-date) (setf expander).
xact-effective-date (function).
(setf xact-entry) (setf expander).
xact-entry (function).
(setf xact-must-balance-p) (setf expander).
xact-must-balance-p (function).
(setf xact-note) (setf expander).
xact-note (function).
xact-pending-p (function).
(setf xact-position) (setf expander).
xact-position (function).
(setf xact-status) (setf expander).
xact-status (function).
xact-uncleared-p (function).
(setf xact-value) (setf expander).
xact-value (function).
(setf xact-virtualp) (setf expander).
xact-virtualp (function).
*value-expr-commodity-pool* (special variable).
*value-expr-last-xact* (special variable).
*value-expr-observe-properties-p* (special variable).
*value-expr-readtable* (special variable).
*value-expr-reduce-to-smallest-units-p* (special variable).
*value-expr-series-offset* (special variable).
account-matcher (function).
account-set-value (function).
(setf account-value) (setf expander).
account-value (function).
accounts-report (function).
add-journal-from-path (function).
add-to-plist (macro).
apply-key-transforms (function).
apply-this-or-last (function).
as-boolean (function).
balance-print-reporter (function).
balance-reporter (function).
basic-reporter (function).
binder-time-range (function).
binderp (function).
bridge-running-totals (function).
calculate-account-totals (function).
chain-functions (function).
collapse-entries (function).
command-line-args (function).
compare-path-lists (function).
copy-transaction (function).
copy-value-expr (function).
csv-reporter (function).
displayed-amount-setter (function).
do-iterator (macro).
do-recurse (macro).
driver-help (function).
entry-normalizedp (generic reader).
(setf entry-normalizedp) (generic writer).
eq-matcher (function).
find-all-transactions (function).
fixed-time-matcher (function).
get-computed-amount (function).
get-computed-total (function).
get-xact-account (reader).
(setf get-xact-account) (writer).
get-xact-actual-date (reader).
(setf get-xact-actual-date) (writer).
get-xact-amount (reader).
(setf get-xact-amount) (writer).
get-xact-calculatedp (reader).
(setf get-xact-calculatedp) (writer).
get-xact-cost (reader).
(setf get-xact-cost) (writer).
get-xact-data (reader).
(setf get-xact-data) (writer).
get-xact-effective-date (reader).
(setf get-xact-effective-date) (writer).
get-xact-entry (reader).
(setf get-xact-entry) (writer).
get-xact-generatedp (reader).
(setf get-xact-generatedp) (writer).
get-xact-must-balance-p (reader).
(setf get-xact-must-balance-p) (writer).
get-xact-note (reader).
(setf get-xact-note) (writer).
get-xact-position (reader).
(setf get-xact-position) (writer).
get-xact-status (reader).
(setf get-xact-status) (writer).
get-xact-virtualp (reader).
(setf get-xact-virtualp) (writer).
group-by-account (function).
group-by-period (function).
if-let (macro).
ignore-args (function).
ignore-character (function).
ignore-rest (function).
ignore-xact (function).
invert-transactions (function).
item-position-p (function).
journal-last-content-cell (generic reader).
(setf journal-last-content-cell) (generic writer).
journal-read-date (generic reader).
(setf journal-read-date) (generic writer).
list-iterator (function).
main (function).
make-comparator (macro).
map-iterator (function).
maybe-subseq (function).
negatef (macro).
not-matcher (function).
note-matcher (function).
payee-matcher (function).
periodic-transform (function).
print-account (function).
print-new-entry (function).
print-reporter (function).
print-transaction (function).
print-transactions (function).
read-add-expr (function).
read-and-expr (function).
read-comma-expr (function).
read-logic-expr (function).
read-mul-expr (function).
read-or-expr (function).
read-unary-expr (function).
read-value-term (function).
regex-matcher (function).
regexp-opt (function).
register-reporter (function).
related-transactions (function).
report-accounts (function).
reset-accounts (function).
set-xact-account (function).
set-xact-actual-date (function).
set-xact-amount (function).
set-xact-amount* (function).
set-xact-calculatedp (function).
set-xact-cost (function).
set-xact-data (function).
set-xact-effective-date (function).
set-xact-entry (function).
set-xact-generatedp (function).
set-xact-must-balance-p (function).
set-xact-note (function).
set-xact-position (function).
set-xact-status (function).
set-xact-virtualp (function).
sort-entries (function).
sort-transactions (function).
split-string-at-char (function).
status-matcher (function).
time-range-matcher (function).
transaction-p (function).
transaction-printer (function).
transactions-report (function).
transactions-to-sexp (function).
value-expr (structure).
value-expr-call (function).
value-expr-matcher (function).
while (macro).
with-temporary-journal (macro).
xact-amount-expr (function).
(setf xact-calculatedp) (setf expander).
xact-calculatedp (function).
xact-cost-total (function).
xact-display-amount (function).
xact-display-total (function).
(setf xact-generatedp) (setf expander).
xact-generatedp (function).
xact-total (function).
xacts-to-sexp (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
*predicate-keywords* associates keywords that may be passed to
‘apply-filter’ or ‘parse-predicate-keywords’ with matcher functions that are
called to produce the closures used to ascertain the match.
The format of each member of this list is (KEYWORD TYPE FUNCTION).
For example, in the case of allowing :ACCOUNT to specify an account to match
against in a value expression predicate, the require type is either a string
specifying a regular expression, or an actual account object to compare
against. The function used to create the matcher is ‘account-matcher’,
which takes the string/account argument passed in after the :ACCOUNT
keyword, and returns a closure which can verify whether a transaction is
indeed in that account.
This means that every matcher function takes a value argument to base the match on, and returns a closure *that takes a transaction* for which it will ascertain that match.
xact-account (function).
set-xact-account (function).
xact-amount (function).
set-xact-amount (function).
xact-amount* (function).
set-xact-amount* (function).
xact-cost (function).
set-xact-cost (function).
xact-data (function).
set-xact-data (function).
xact-effective-date (function).
set-xact-effective-date (function).
xact-entry (function).
set-xact-entry (function).
xact-must-balance-p (function).
set-xact-must-balance-p (function).
xact-note (function).
set-xact-note (function).
xact-position (function).
set-xact-position (function).
xact-status (function).
set-xact-status (function).
xact-virtualp (function).
set-xact-virtualp (function).
The DERIVE-ENTRY report uses Ledger to intelligently create a new entry for
you. The possible keywords arguments are:
:DATE <DATE-STRING>
:PAYEE <REGEXP>
:ACCOUNT <REGEXP>
:BALANCE-ACCOUNT <REGEXP>
:AMOUNT <VALUE-STRING>
:APPEND <BOOLEAN>
Except for :PAYEE, all of these keyword arguments are optional. Here is what
they mean:
:PAYEE REGEXP
Find the most recent entry whose payee matches REGEXP, and base the new
entry derivation on its details. If no matching entry can be found, the
payee of the newly created entry will exactly match REGEXP.
:DATE DATE-STRING
The date of the new entry will be DATE-STRING, otherwise it is today.
:ACCOUNT REGEXP
Set the first account line in the new entry to be the most recently used
account which matches REGEXP. If no such account can be found, an account
named REGEXP is used. If no account is specified, the account
"Expenses:Unknown" is used.
:BALANCE-ACCOUNT REGEXP
Like :ACCOUNT, except this refers to the account used for the second
transaction in the newly derived entry. If not specified, a calculated
"balance account" is looked for in the matching entry; if this does not
apply, the journal’s default account is used; if this does not apply, the
account "Assets:Unknown" is used.
:AMOUNT VALUE-STRING
The amount of the first transaction. If it has no commodity, the
correlated commodity from the discovered entry is used.
:APPEND BOOLEAN
If non-NIL, the new entry is written to the same journal where the
matching entry was found (for a binder that references many journals, this
is whichever file the discovered entry was in).
Here are a few examples, using sample.dat as a reference:
(ledger:derive-entry "doc/sample.dat" :payee "book")
=>
2007/12/04 Book Store
Expenses:Books $20.00
Liabilities:MasterCard
(ledger:derive-entry :payee "book" :amount "$125")
=>
2007/12/04 Book Store
Expenses:Books $125.00
Liabilities:MasterCard
(ledger:derive-entry :payee "Hello World")
=>
2007/12/04 Hello World
Expenses:Unknown
Assets:Unknown
(ledger:derive-entry :date "2004/01/01" :payee "Hello World")
=>
2004/01/01 Hello World
Expenses:Unknown
Assets:Unknown
(ledger:derive-entry :payee "book" :account "equ")
=>
2007/12/04 Book Store
Equity:Opening Balances $20.00
Liabilities:MasterCard
(ledger:derive-entry :payee "book" :account "Who Knows")
=>
2007/12/04 Book Store
Who Knows $20.00
Liabilities:MasterCard
(ledger:derive-entry :payee "book" :balance-account "bank")
=>
2007/12/04 Book Store
Expenses:Books $20.00
Assets:Bank:Checking
(ledger:derive-entry :payee "book" :account "liab"
:balance-account "bank")
=>
2007/12/04 Book Store
Liabilities:MasterCard $-20.00
Assets:Bank:Checking
(ledger:derive-entry :payee "book" :account "bank" :amount 50)
=>
2007/12/04 Book Store
Assets:Bank:Checking $50.00
Liabilities:MasterCard
(ledger:derive-entry :payee "book" :account "bank" :amount "$125")
=>
2007/12/04 Book Store
Assets:Bank:Checking $125.00
Liabilities:MasterCard
"Clump" the incoming stream of transactions into sublists, where adjacent transactions with the same parent entry become part of the same sublist.
Consider the following input stream, with the first letter identifying the
entry and the second identifying the member transaction:
(A-X A-Y A-Z B-X B-Y C-X)
Given this input, the resulting list from ‘group-transactions-by-entry’ will
be:
((A-X A-Y A-Z) (B-X B-Y) (C-X))
Read in a textual Ledger journal from the given PATH. The result is of type JOURNAL.
This is a function for easily print register reports.
A typical usage might be:
(ledger:register-report "/path/to/ledger.dat"
:begin "2007/08/26" :account "food")
entry) (transaction transaction)) ¶transaction) &optional entry-transform) ¶structure-object.
(or periods:fixed-time null)
(or periods:fixed-time null)
cl-ledger:item-status
:uncleared
cambl.
(or cambl:value cl-ledger::value-expr null)
(or cambl:value cl-ledger::value-expr null)
(or string null)
boolean
boolean
boolean
boolean
t
common-lisp.
:parent
(or hash-table null)
:children
string
:name
string
:fullname
:data
cambl.
cambl:commodity-pool
:commodity-pool
cl-ledger:account
(make-instance (quote cl-ledger:account) :name "")
:root-account
:journals
:data
add-transaction.
entries-iterator.
(setf entry-actual-date).
entry-actual-date.
(setf entry-code).
entry-code.
(setf entry-data).
entry-data.
(setf entry-effective-date).
entry-effective-date.
(setf entry-journal).
entry-journal.
(setf entry-normalizedp).
entry-normalizedp.
(setf entry-note).
entry-note.
(setf entry-payee).
entry-payee.
(setf entry-position).
entry-position.
(setf entry-status).
entry-status.
(setf entry-transactions).
entry-transactions.
transactions-iterator.
:journal
(or periods:fixed-time null)
:actual-date
(or periods:fixed-time null)
:effective-date
cl-ledger:item-status
:uncleared
:status
(or string null)
:code
(or string null)
:payee
(or string null)
:note
:transactions
common-lisp.
:position
:normalizedp
:data
add-journal.
add-journal.
entries-iterator.
find-account.
(setf journal-binder).
journal-binder.
(setf journal-contents).
journal-contents.
(setf journal-data).
journal-data.
(setf journal-date-format).
journal-date-format.
(setf journal-default-account).
journal-default-account.
(setf journal-default-year).
journal-default-year.
(setf journal-last-content-cell).
journal-last-content-cell.
(setf journal-read-date).
journal-read-date.
(setf journal-source).
journal-source.
transactions-iterator.
:binder
(or string null)
(or integer null)
(or cl-ledger:account null)
(or pathname null)
:source-path
(or integer null)
:read-date
:data
A simple macro for writing inline recursive code.
(do-recurse this ((x 10))
(if (= x 0)
0
(+ x (this (1- x))))) => 55
Creates a wrapper around BODY which binds VAR to a temporary journal.
xact-calculatedp (function).
set-xact-calculatedp (function).
xact-generatedp (function).
set-xact-generatedp (function).
Call a group of functions by chaining, passing all keyword args.
This function allows you to call a set of functions like this:
(chain-functions arg #’foo :foo 10 :foo2 20
#’bar :bar 30)
This is equivalent to:
(bar (foo arg :foo 10 :foo2 20) :bar 30)
cost.
data.
note.
Read in the header line for the entry, which has the syntax:
(DATE(=DATE)?)( (*|!))?( (((.+?))))? (.+)(:spacer:;(.+))?
:spacer: means: two spaces, a tab, or a space and a tab, followed by any
amount of whitespace.
The groups identified in this regular expression (found in the scanner
*entry-heading-scanner*) have these meanings:
1 - The actual date of the entry.
2 - The (optional) effective date of the entry.
4 - The (optional) status of the entry: *=cleared, !=pending.
6 - The (optional) "code" for the entry; has no meaning to Ledger.
7 - The payee or description of the entry.
9 - A comment giving further details about the entry.
Returns a list of substrings of string
divided by ONE char each.
Note: Two consecutive chars will be seen as
if there were an empty string between them.
automated-entry)) ¶automatically generated reader method
automated-entry)) ¶automatically generated writer method
automated-entry)) ¶automatically generated reader method
automated-entry)) ¶automatically generated writer method
periodic-entry)) ¶automatically generated reader method
periodic-entry)) ¶automatically generated writer method
:period
| Jump to: | (
A B C D E F G I J L M N P R S T V W X |
|---|
| Jump to: | (
A B C D E F G I J L M N P R S T V W X |
|---|
| Jump to: | *
A B C D E F G J L M N P R S T V |
|---|
| Jump to: | *
A B C D E F G J L M N P R S T V |
|---|
| Jump to: | A B C D E F G I J L M N P R S T V |
|---|
| Jump to: | A B C D E F G I J L M N P R S T V |
|---|