Meta × realizado por categoria
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.
accessTokenAuthorizationBearer <token>Access token (mda_…) obtido em POST /auth/token. Vale 1 hora.
inicio*stringPrimeiro dia do período.
datefim*stringÚltimo dia do período. Limitado ao horizonte de lançamentos do workspace.
dateregime?stringcaixa soma pela data de pagamento; competencia, pela data de competência.
"caixa""caixa""competencia"status?stringQuais 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.
tipo?stringdespesa, receita e transferencia, separados por vírgula.
moeda?stringCó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ó.
pendentes_no_presente?booleanNo regime de caixa, o pendente vencido conta como de hoje (e entra no período que contém hoje). Sem o parâmetro, a configuração do workspace.
intervalo?stringQuebra o resultado por dia, mes ou ano. Sem o parâmetro, o período inteiro.
"dia""mes""ano"contas?stringIds de contas, separados por vírgula.
categorias?stringIds de categorias, separados por vírgula. A categoria inclui as subcategorias dela.
centros?stringIds de centros de custo, separados por vírgula.
contatos?stringIds de contatos, separados por vírgula.
projetos?stringIds de projetos, separados por vírgula.
formas_pagamento?stringIds de formas de pagamento, separados por vírgula.
As metas.
application/json- response
moeda*stringdata*array<>totais*array<>Um total por tipo.
curl -X GET "https://example.com/relatorios/metas/categorias?inicio=2019-08-24&fim=2019-08-24"{ "moeda": "BRL", "data": [ { "categoria": { "id": 0, "nome": "string" }, "categoria_pai": { "id": 0, "nome": "string" }, "lancado_na_categoria_pai": true, "tipo": "receita", "periodo": "string", "meta": 0, "projetado": 0, "confirmado": 0, "a_realizar_projetado": 0, "a_realizar_confirmado": 0, "excedente_projetado": 0, "excedente_confirmado": 0 } ], "totais": [ { "tipo": "receita", "periodo": "string", "meta": 0, "projetado": 0, "confirmado": 0, "a_realizar_projetado": 0, "a_realizar_confirmado": 0, "excedente_projetado": 0, "excedente_confirmado": 0 } ]}Fluxo de caixa GET
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.
Meta × realizado por centro de custo GET
As Metas por centro: a meta de despesa e de receita de cada centro de custo no período, o realizado e quanto falta ou excedeu. 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 por centros.