Meu Dinheiro · API
Relatórios

Fluxo de caixa

GET
/relatorios/fluxo-caixa

Saldo inicial, entradas, saídas, resultado e saldo acumulado por período, no total e por conta, como na tela Fluxo de caixa. Entram as contas de caixa (disponíveis, ativas, na moeda pedida; sem cartão nem carteira de investimentos), e a fatura do cartão aparece projetada na conta que a paga. Os valores são os projetados: status decide o que entra.

Os pendentes vencidos seguem a configuração do workspace (o pendentes_no_presente não se aplica aqui, como na tela).

Exige a permissão de ver Fluxo de caixa.

Autenticação

accessToken
headerAuthorizationBearer <token>

Access token (mda_…) obtido em POST /auth/token. Vale 1 hora.

Parâmetros de consulta

inicio*string

Primeiro dia do período.

Formatodate
fim*string

Último dia do período. Limitado ao horizonte de lançamentos do workspace.

Formatodate
intervalo?string

Tamanho de cada período.

Padrão"mes"
Valores"dia""mes""ano"
status?string

Quais lançamentos entram, separados por vírgula. pendente: vencido e não pago; agendado: a vencer; confirmado: pago ou recebido; conciliado: conferido com o extrato. Sem o parâmetro, todos.

moeda?string

Código ISO 4217. Só entram as contas nessa moeda, e não há conversão. Sem o parâmetro, a moeda padrão do workspace, ou a da conta quando contas filtra uma só.

contas?string

Ids de contas, separados por vírgula.

transferencias_entre_contas_caixa?boolean

Inclui as transferências entre duas contas de caixa (que não mudam o saldo total).

Padrãotrue
contas_pagar_receber?boolean

Soma também os pendentes das contas de Contas a pagar e a receber. Só vale sem o filtro contas.

Padrãofalse

Corpo da resposta

O fluxo de caixa.

application/json
  1. response
moeda*string
saldo_inicial*number

Saldo no dia anterior ao inicio.

saldo_final*number
periodos*array<>

Todos os períodos da janela, inclusive os sem movimento.

contas*array<>
curl -X GET "https://example.com/relatorios/fluxo-caixa?inicio=2019-08-24&fim=2019-08-24"
{  "moeda": "BRL",  "saldo_inicial": 0,  "saldo_final": 0,  "periodos": [    {      "periodo": "string",      "entradas": 0,      "saidas": 0,      "resultado": 0,      "saldo": 0    }  ],  "contas": [    {      "conta": {        "id": 0,        "nome": "string"      },      "saldo_inicial": 0,      "saldo_final": 0,      "periodos": [        {          "periodo": "string",          "entradas": 0,          "saidas": 0,          "resultado": 0,          "saldo": 0        }      ]    }  ]}

Saldo de cada conta numa data GET

O saldo de cada conta ao fim de `data`, como no card Saldos de caixa: saldo inicial e todos os lançamentos até a data, com a fatura do cartão projetada na conta que a paga. `projetado` inclui o que vence até a data e ainda não foi pago; `confirmado`, só o realizado. Exige a permissão de ver Saldos de caixa, Extrato de contas, Lançamentos de caixa ou Fluxo de caixa.

Meta × realizado por categoria GET

O Orçamento: a meta de cada categoria no período, o realizado e quanto falta ou excedeu. A categoria de cima soma as filhas; o que foi lançado direto nela, sem subcategoria, vem numa linha própria com `lancado_na_categoria_pai: true`. As metas de investimento não entram. O período conta em meses inteiros (`inicio` vai ao primeiro dia do mês e `fim`, ao último). Com `intervalo=mes`, uma linha por mês; outro intervalo é 400. Exige a permissão de ver Metas de orçamento ou Metas de despesa/receita da visão geral.