Sintaxi del llenguatge

Això proporciona una referència concisa però completa per a la sintaxi del llenguatge Beancount, combinant estructura pràctica, regles i exemples. Per a més detalls, consulteu el Full de referència.

Visió general​

Beancount és un sistema de comptabilitat de doble entrada en text pla. El seu llenguatge s'estructura al voltant de tres elements bàsics principals:

• Commodities (monedes, accions, punts, etc.)
• Comptes (llibres de comptabilitat jeràrquics i categoritzats)
• Directives (entrades amb data que registren esdeveniments o configuració)

Commodities​

Les commodities sempre s'escriuen en majúscules, p. ex., USD, EUR, AAPL, BTC, MILES, HOURS.

Comptes​

Els comptes són noms jeràrquics capitalitzats separats per dos punts. Han de començar amb un dels cinc tipus de comptes arrel:

• Els components han d'estar capitalitzats, separats per dos punts (:), sense espais.
• Es permeten números i guions en els components.
• Els noms dels comptes arrel es poden personalitzar mitjançant opcions (vegeu a continuació).

Directives​

Les directives són les declaracions bàsiques en un fitxer Beancount. La majoria comencen amb una data, seguida d'un tipus de directiva i arguments. Es processen per ordre cronològic (per data), no per ordre de fitxer.

Format general:

YYYY-MM-DD <directiva> <arguments...>

Directives comunes i exemples​

Obertura i tancament de comptes​

2023-01-01 open Assets:Checking USD,EUR  ; Opcionalment, especifiqueu les divises permeses
2023-12-31 close Assets:Checking

Declaració de commodities​

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

Declaracions de preus​

2022-04-30 price AAPL 150.00 USD

Notes i Documents​

2022-03-20 note Assets:Checking "Preguntat sobre el reemborsament"
2022-03-20 document Assets:Checking "statements/2022-03.pdf"

Transaccions​

2024-01-05 * "Coffee Shop" "Cafè del matí"
  Expenses:Food         4.50 USD
  Assets:Cash         -4.50 USD
 
2024-01-06 ! "Phone Bill" "Pagament mensual" #utilities ^phone
  id: "INV12345"              ; Metadades
  Expenses:Utilities  60.00 USD
  Assets:Checking

Funcions de publicació​

; Amb base de cost
  Assets:Stocks    1 AAPL {150.00 USD}
; Amb anotació de preu
  Assets:Cash   -100 USD @ 1.25 CAD
; Amb preu total
  Assets:Cash   -100 USD @@ 125.00 CAD
; Balanç implícit
  Assets:Cash   -100 USD
  Assets:Bank

Asercions de saldo i emplenament​

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

Esdeveniments​

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

Opcions​

Estableix la configuració de tot el fitxer:

option "title" "El meu llibre major"
option "operating_currency" "USD"
option "documents" "docs/"
option "name_assets" "Vermoegen"

Consulteu la Referència d'opcions per a més informació.

Plugins i organització de fitxers​

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

Regles importants​

• Totes les transaccions s'han d'equilibrar (la suma de totes les publicacions és zero; s'utilitza la base de cost si està present).
• Els comptes s'han d'obrir abans d'utilitzar-los; els comptes tancats no poden acceptar publicacions.
• Les asercions de saldo només comproven la divisa especificada i es poden utilitzar en comptes pare.
• Les anotacions de preu (@) són informatives i no afecten l'equilibri.

Patrons comuns​

Obertura de comptes amb saldo inicial​

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

Transacció d'inversió​

2024-01-01 * "Comprar accions"
  Assets:Broker:Stock   10 AAPL {150.00 USD}
  Assets:Broker:Cash -1500.00 USD

Transacció multidivisa​

2024-01-01 * "Canvi de divisa"
  Assets:USD   -100.00 USD @ 1.25 CAD
  Assets:CAD    125.00 CAD

Comentaris​

poptag  #trip-to-peru
; els comentaris en línia comencen amb un punt i coma
* qualsevol línia que no comenci amb una directiva vàlida també s'ignora en silenci