Meu Dinheiro · API
Relatórios

Totais por projeto

GET
/relatorios/totais/projetos

Soma por projeto e tipo. Sem tipo, receita e despesa.

Exige a permissão de ver Totais por projeto, Resultados por projeto ou Lançamentos por projeto.

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

Os totais.

application/json
  1. response
moeda*string
data*array<>
totais*
curl -X GET "https://example.com/relatorios/totais/projetos?inicio=2019-08-24&fim=2019-08-24"
{  "moeda": "BRL",  "data": [    {      "projeto": {        "id": 0,        "nome": "string"      },      "tipo": "receita",      "periodo": "string",      "projetado": 0,      "confirmado": 0    }  ],  "totais": {    "receitas": {      "projetado": 0,      "confirmado": 0    },    "despesas": {      "projetado": 0,      "confirmado": 0    },    "transferencias": {      "projetado": 0,      "confirmado": 0    }  }}

Totais por contato GET

Soma por contato (cliente ou fornecedor) e tipo. Sem `tipo`, receita e despesa. Exige a permissão de ver Totais por contato, Evolução por contato, Resultados por contato ou Lançamentos por contato.

Totais por tag GET

Soma por tag e tipo. Lançamento sem tag não entra; com duas tags, entra nas duas. Sem `tipo`, receita e despesa. Exige a permissão de ver Totais por categoria.