Meu Dinheiro · API
Relatórios

Receitas × despesas

GET
/relatorios/resultado

Receitas, despesas e o resultado do período, com as transferências à parte. É o Resultado do mês da visão geral; com intervalo, a evolução dele.

Exige a permissão de ver Resultados do mês, Comparação entre períodos ou Lançamentos 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
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

O resultado.

application/json
  1. response
moeda*string
total*
periodos?array<>

Só com intervalo, em ordem.

curl -X GET "https://example.com/relatorios/resultado?inicio=2019-08-24&fim=2019-08-24"
{  "moeda": "BRL",  "total": {    "receitas": {      "projetado": 0,      "confirmado": 0    },    "despesas": {      "projetado": 0,      "confirmado": 0    },    "resultado": {      "projetado": 0,      "confirmado": 0    },    "transferencias_entrada": {      "projetado": 0,      "confirmado": 0    },    "transferencias_saida": {      "projetado": 0,      "confirmado": 0    }  },  "periodos": [    {      "periodo": "string",      "receitas": {        "projetado": 0,        "confirmado": 0      },      "despesas": {        "projetado": 0,        "confirmado": 0      },      "resultado": {        "projetado": 0,        "confirmado": 0      },      "transferencias_entrada": {        "projetado": 0,        "confirmado": 0      },      "transferencias_saida": {        "projetado": 0,        "confirmado": 0      }    }  ]}

Totais por conta GET

Movimento do período por conta e tipo, na apuração de resultado (sem saldo inicial). Para o saldo, use `/relatorios/saldos`. Sem `tipo`, receita e despesa. Exige a permissão de ver Lançamentos de caixa, Extrato de contas, Saldos de caixa ou Resultados de caixa.

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.