Funções de Fluxo de Caixa

Adicione o metadado cash-flow-role à diretiva open de uma conta para declarar como o relatório de fluxo de caixa classifica essa conta. Uma chave, quatro valores. Contas sem o metadado mantêm as heurísticas padrão.

2000-01-01 open Assets:US:Brokerage
  cash-flow-role: "investing"
 
2000-01-01 open Assets:US:Marcus:Savings
  cash-flow-role: "cash"

Chave e valores​

A correspondência diferencia maiúsculas de minúsculas e é exata. O valor deve ser uma string entre aspas. Outras chaves de metadados na mesma diretiva são ignoradas pelo relatório, e esta chave é ignorada por todas as outras ferramentas.

O que cada valor faz​

Uma função declarada responde a duas perguntas ao mesmo tempo: se a conta faz parte do montante de caixa e, caso contrário, a qual seção de atividade ela pertence.

• "cash" — a conta entra no conjunto de caixa e equivalentes. Contas de caixa nunca aparecem como itens de linha de atividade. A linha final da demonstração, variação líquida de caixa e equivalentes, é igual à soma de suas variações no período. Transferências entre duas contas de caixa se anulam. Use para contas que a heurística de nome não identifica, como um fundo do mercado monetário ou uma carteira de stablecoin.
• "operating", "investing", "financing" — a conta não é caixa, e sua variação no período aparece como uma linha sob essa seção de atividade. Declarar uma dessas em uma conta que a heurística de nome trataria como caixa, como Assets:US:Bank:CD, tanto a remove do conjunto de caixa quanto a arquiva na seção declarada.

Declarações são confiáveis acima das convenções contábeis. Uma conta de Equity declarada como "operating" é respeitada literalmente.

Precedência​

A de maior prioridade vence:

1. Metadado cash-flow-role na diretiva open da conta.
2. As heurísticas padrão embutidas abaixo.

Classificações padrão​

Uma conta sem função declarada é classificada pela sua raiz, com uma verificação de nome decidindo a associação ao caixa:

Contas de ativos cujos nomes contenham Cash, Checking, Savings ou Bank são tratadas como caixa e equivalentes por padrão. Uma função declarada sobrepõe a verificação de nome em ambas as direções.

Valores inválidos​

Um valor não reconhecido é tratado como ausente. Um erro de digitação como "invsting", um valor que não seja string ou letras maiúsculas/minúsculas incorretas recai na heurística padrão, e o relatório sinaliza a conta no painel de status com uma nota de valor desconhecido. Nada deixa de ser renderizado e nada é aceito silenciosamente.

Alterando uma classificação​

As classificações não são efetivas por data. Uma demonstração para qualquer período usa as declarações como estão hoje. Para alterar uma, edite a diretiva open; o controle de versão do livro-razão registra o que mudou e quando.

Onde as declarações se aplicam​

Um resolvedor compartilhado produz a função final para cada conta, e todos os consumidores leem dela:

• O relatório de fluxo de caixa: seções de atividade, o conjunto de caixa e equivalentes e a reconciliação da linha final.
• Exportações CSV, Markdown e impressão: os mesmos números. A divulgação de classificação inferida aparece apenas para linhas ainda resolvidas pela heurística.
• O diagrama de fluxo de caixa da visão geral: "cash" exclui a conta dos nós de fluxo, e funções de atividade declaradas são respeitadas para contas não-Income. Income permanece no lado da fonte e Equity permanece excluída do diagrama; declarações nunca remapeiam essas duas.
• O painel de status da conta: uma conta declarada não aparece mais como um ativo não classificado.

Portabilidade​

Metadados em diretivas open são sintaxe central do Beancount. bean-check, Fava e todas as ferramentas v2/v3 os analisam e ignoram a chave desconhecida, portanto o livro-razão permanece totalmente utilizável fora do Beancount.io. Veja Sintaxe do Beancount para o formato geral de metadados.