Meu Dinheiro · API
Relatórios

Meta × realizado por centro de custo

GET
/relatorios/metas/centros

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.

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
regime?string

caixa soma pela data de pagamento; competencia, pela data de competência.

Padrão"caixa"
Valores"caixa""competencia"
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.

tipo?string

despesa, receita e transferencia, separados por vírgula.

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ó.

pendentes_no_presente?boolean

No 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?string

Quebra o resultado por dia, mes ou ano. Sem o parâmetro, o período inteiro.

Valores"dia""mes""ano"
contas?string

Ids de contas, separados por vírgula.

categorias?string

Ids de categorias, separados por vírgula. A categoria inclui as subcategorias dela.

centros?string

Ids de centros de custo, separados por vírgula.

contatos?string

Ids de contatos, separados por vírgula.

projetos?string

Ids de projetos, separados por vírgula.

tags?string

Ids de tags, separados por vírgula.

formas_pagamento?string

Ids de formas de pagamento, separados por vírgula.

Corpo da resposta

As metas.

application/json
  1. response
moeda*string
data*array<>
totais*array<>

Um total por tipo.

curl -X GET "https://example.com/relatorios/metas/centros?inicio=2019-08-24&fim=2019-08-24"
{  "moeda": "BRL",  "data": [    {      "centro": {        "id": 0,        "nome": "string"      },      "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    }  ]}

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.

Demonstração do Resultado do Exercício (DRE) GET

As linhas do DRE, com o valor de cada período, a análise vertical (sobre a Receita Líquida) e a horizontal (sobre o período anterior), a média e o total. A categoria vai para a linha a que está vinculada na tela do DRE; sem vínculo, para a linha padrão do tipo dela. Linhas de `tipo: categorias` trazem as categorias em `itens`. Exige a permissão de ver o DRE.