Skip to navigation

Relatorio de faturamento

Consulta os valores comerciais das oportunidades no período.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Retorna linhas por oportunidade para composição de indicadores e gráficos. profit pode ser nulo conforme as permissões. Informe ambos os limites caso use comparação. O campo date representa o mês de referência no formato YYYY-MM. As linhas dos períodos principal e de comparação são retornadas na mesma lista, sem um indicador separado de período. A referência das datas e dos valores respeita as preferências do usuário; a API não recebe parâmetros para trocar essas preferências nesta chamada.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
startstringSimInício do período, no formato YYYY-MM-DD.
endstringSimFim do período, no formato YYYY-MM-DD.
statusstringNãoIDs de etapas separados por vírgula; padrão all.
statestringNãoEstados pending,earned,lost separados por vírgula; padrão all.
responsiblestringNãoIDs de responsáveis separados por vírgula; padrão all.
compare_startstringNãoInício do período de comparação, YYYY-MM-DD.
compare_endstringNãoFim do período de comparação, YYYY-MM-DD.

Resposta

HTTP 200. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.

Campos principais de data (cada elemento da lista):

CampoTipoDescrição
idintegerID da oportunidade.
statestringEstado comercial.
statusintegerID da etapa.
status_namestringNome da etapa.
valuenumberValor para o relatório.
profitnumberLucro, quando permitido.
datestringMês no formato YYYY-MM.
state_lossintegerID do motivo de perda.
loss_namestringMotivo de perda.
{
"data": [
{
"id": 1001,
"state": "earned",
"status": 20,
"status_name": "Ganha",
"value": 1500,
"profit": null,
"date": "2026-09",
"state_loss": null,
"loss_name": null
}
]
}

Erros específicos

HTTPCódigoSituação
422REPORT_PERIOD_REQUIREDPeríodo obrigatório.

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

startstringOptional

string. Obrigatório. Início do período, no formato YYYY-MM-DD.

endstringOptional

string. Obrigatório. Fim do período, no formato YYYY-MM-DD.

statusstringOptional

string. IDs de etapas separados por vírgula; padrão all.

statestringOptional

string. Estados pending,earned,lost separados por vírgula; padrão all.

responsiblestringOptional

string. IDs de responsáveis separados por vírgula; padrão all.

compare_startstringOptional

string. Início do período de comparação, YYYY-MM-DD.

compare_endstringOptional

string. Fim do período de comparação, YYYY-MM-DD.

Response

200 — Sucesso — exemplo ilustrativo

datalist of objectsOptional

Errors

422
Unprocessable Entity Error