Meu Dinheiro · API
Relatórios

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

GET
/relatorios/dre

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.

Autenticação

accessToken
headerAuthorizationBearer <token>

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

Parâmetros de consulta

fim?string

Um dia do último mês do demonstrativo. Sem o parâmetro, o mês atual.

Formatodate
intervalo?string

Tamanho de cada período (coluna).

Padrão"mes"
Valores"mes""trimestre""semestre""ano"
periodos?integer

Quantos períodos, contando para trás a partir do fim. A janela vai até 5 anos.

Faixa1 <= value <= 60
Padrão12
regime*string

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

Valores"caixa""competencia"
linhas_zeradas?boolean

Inclui as linhas sem valor em nenhum período.

Padrãotrue
contas_pagar_receber?boolean

Soma os pendentes das contas de Contas a pagar e a receber no mês atual (só no regime de caixa).

Padrãotrue
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ó.

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.

contas?string

Ids de contas, separados por vírgula.

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

O DRE.

application/json
  1. response
moeda*string
periodos*array<>
linhas*array<>
curl -X GET "https://example.com/relatorios/dre?regime=caixa"
{  "moeda": "BRL",  "periodos": [    {      "inicio": "2019-08-24",      "fim": "2019-08-24"    }  ],  "linhas": [    {      "id": 0,      "descricao": "string",      "tipo": "categorias",      "formato": "moeda",      "itens": [        {          "id": 0,          "descricao": "string",          "valores": [            0          ],          "analise_vertical": [            0          ],          "analise_horizontal": [            0          ],          "media": 0,          "total": 0        }      ],      "valores": [        0      ],      "analise_vertical": [        0      ],      "analise_horizontal": [        0      ],      "media": 0,      "total": 0    }  ]}

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.

Demonstração do Fluxo de Caixa (DFC) GET

As linhas do DFC por atividade (operacional, investimento e financiamento), do saldo inicial ao saldo final de caixa, com o valor de cada período, as análises, a média e o total. Sempre no regime de caixa, sobre as contas de caixa. Exige a permissão de ver o DFC.