Skip to navigation

Overview

Relatórios agregados a partir das oportunidades, para montar indicadores e gráficos fora do WBudget.

Rotas

MétodoRotaPara quê
GET/reports/revenueRelatório de faturamento: valores por oportunidade no período.

Como funciona

  • start e end (YYYY-MM-DD) são obrigatórios.
  • A resposta traz uma linha por oportunidade, com value, profit, state, etapa (status, status_name), mês de referência em date (YYYY-MM) e, nas perdidas, o motivo (state_loss, loss_name).
  • Filtre por etapa (status), estado comercial (state) e responsável (responsible), com IDs separados por vírgula.
  • Para comparar com outro período, informe compare_start e compare_end.

Cuidados

  • Períodos misturados. Com comparação, as linhas dos dois períodos vêm na mesma lista, sem campo que diga de qual período são. Separe pelo date.
  • profit pode ser nulo, conforme as permissões do usuário.
  • Preferências do usuário. A referência de datas e de valores segue as preferências de relatório do usuário do token; a chamada não recebe parâmetros para trocá-las.