Syntax jazyka Beancount

Toto poskytuje stručnú, ale komplexnú referenciu pre syntax jazyka Beancount, ktorá kombinuje praktickú štruktúru, pravidlá a príklady. Pre viac detailov, pozrite si Cheat Sheet.

Prehľad

Beancount je účtovný systém podvojného účtovníctva v prostom texte. Jeho jazyk je štruktúrovaný okolo troch hlavných stavebných blokov:

• Komodity (meny, akcie, body, atď.)
• Účty (hierarchické, kategorizované knihy)
• Direktívy (záznamy datované, zaznamenávajúce udalosti alebo konfiguráciu)

Komodity

Komodity sa vždy píšu veľkými písmenami, napr. USD, EUR, AAPL, BTC, MILES, HOURS.

Účty

Účty sú mená hierarchicky oddelené dvojbodkami, začínajúce veľkým písmenom. Musia začínať jedným z piatich koreňových typov účtov:

Názov	Typ	Typický obsah	Príklad
Assets	+	Hotovosť, Banka, Investície	Assets:Checking
Liabilities	-	Kreditné karty, Pôžičky	Liabilities:CreditCard
Income	-	Plat, Úroky	Income:EmployerA
Expenses	+	Nákupy, Účty	Expenses:Food:Dining
Equity	-	Otváracie/Zatváracie zostatky	Equity:Opening-Balances

• Komponenty musia začínať veľkým písmenom, oddelené dvojbodkami (:), bez medzier.
• Čísla a pomlčky sú povolené v komponentoch.
• Názvy koreňových účtov je možné prispôsobiť pomocou možností (pozri nižšie).

Direktívy

Direktívy sú základné príkazy v súbore Beancount. Väčšina začína dátumom, nasledovaná typom direktívy a argumentmi. Spracovávajú sa v chronologickom poradí (podľa dátumu), nie podľa poradia v súbore.

Všeobecný formát:

YYYY-MM-DD <direktíva> <argumenty...>

Bežné direktívy a príklady

Otváranie a zatváranie účtov

2023-01-01 open Assets:Checking USD,EUR  ; Voliteľne špecifikujte povolené meny
2023-12-31 close Assets:Checking

Deklarovanie komodít

2020-07-22 commodity AAPL
  name: "Apple Inc."

Cenové deklarácie

2022-04-30 price AAPL 150.00 USD

Poznámky a dokumenty

2022-03-20 note Assets:Checking "Spýtal som sa na vrátenie peňazí"
2022-03-20 document Assets:Checking "statements/2022-03.pdf"

Transakcie

2024-01-05 * "Coffee Shop" "Ranná káva"
  Expenses:Food         4.50 USD
  Assets:Cash         -4.50 USD

2024-01-06 ! "Phone Bill" "Mesačná platba" #utilities ^phone
  id: "INV12345"              ; Metadáta
  Expenses:Utilities  60.00 USD
  Assets:Checking

Funkcie zápisu

; S nákladovou bázou
  Assets:Stocks    1 AAPL {150.00 USD}
; S cenovou anotáciou
  Assets:Cash   -100 USD @ 1.25 CAD
; S celkovou cenou
  Assets:Cash   -100 USD @@ 125.00 CAD
; Implicitný zostatok
  Assets:Cash   -100 USD
  Assets:Bank

Kontrola zostatku a padding

2024-06-01 balance Assets:Checking 1000.00 USD
2024-06-01 pad Assets:Checking Equity:Opening-Balances

Udalosti

2024-06-01 event "location" "San Francisco, CA"

Možnosti

Nastavte konfiguráciu pre celý súbor:

option "title" "Moja kniha"
option "operating_currency" "USD"
option "documents" "docs/"
option "name_assets" "Vermoegen"

Pozrite si Referenciu možností pre viac informácií.

Pluginy a organizácia súborov

plugin "beancount.plugins.module_name"
plugin "beancount.plugins.module_name" "config-string"
include "other/file.beancount"
pushtag #project
; ...
poptag #project

Dôležité pravidlá

• Všetky transakcie musia byť vyrovnané (súčet všetkých zápisov je nula; ak je prítomná, použije sa nákladová báza).
• Účty musia byť otvorené pred použitím; zatvorené účty nemôžu prijímať zápisy.
• Kontroly zostatku kontrolujú iba zadanú menu a môžu sa použiť na nadradených účtoch.
• Cenové anotácie (@) sú informatívne a nemajú vplyv na vyrovnávanie.

Bežné vzory

Otváranie účtov s počiatočným zostatkom

2024-01-01 open Assets:Checking USD
2024-01-01 pad Assets:Checking Equity:Opening-Balances
2024-01-01 balance Assets:Checking 1000.00 USD

Investičná transakcia

2024-01-01 * "Kúpa akcií"
  Assets:Broker:Stock   10 AAPL {150.00 USD}
  Assets:Broker:Cash -1500.00 USD

Transakcia vo viacerých menách

2024-01-01 * "Výmena meny"
  Assets:USD   -100.00 USD @ 1.25 CAD
  Assets:CAD    125.00 CAD

Komentáre

poptag  #trip-to-peru
; riadkové komentáre začínajú bodkočiarkou
* akýkoľvek riadok, ktorý nezačína platnou direktívou, je tiež ticho ignorovaný