Relatorio de faturamento | WBudget

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

Campo	Tipo	Obrigatório	Descrição
`start`	string	Sim	Início do período, no formato YYYY-MM-DD.
`end`	string	Sim	Fim do período, no formato YYYY-MM-DD.
`status`	string	Não	IDs de etapas separados por vírgula; padrão all.
`state`	string	Não	Estados pending,earned,lost separados por vírgula; padrão all.
`responsible`	string	Não	IDs de responsáveis separados por vírgula; padrão all.
`compare_start`	string	Não	Início do período de comparação, YYYY-MM-DD.
`compare_end`	string	Não	Fim 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):

Campo	Tipo	Descrição
`id`	integer	ID da oportunidade.
`state`	string	Estado comercial.
`status`	integer	ID da etapa.
`status_name`	string	Nome da etapa.
`value`	number	Valor para o relatório.
`profit`	number	Lucro, quando permitido.
`date`	string	Mês no formato YYYY-MM.
`state_loss`	integer	ID do motivo de perda.
`loss_name`	string	Motivo 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

HTTP	Código	Situação
422	`REPORT_PERIOD_REQUIRED`	Período obrigatório.

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

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 | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `start` | string | Sim | Início do período, no formato YYYY-MM-DD. | | `end` | string | Sim | Fim do período, no formato YYYY-MM-DD. | | `status` | string | Não | IDs de etapas separados por vírgula; padrão all. | | `state` | string | Não | Estados pending,earned,lost separados por vírgula; padrão all. | | `responsible` | string | Não | IDs de responsáveis separados por vírgula; padrão all. | | `compare_start` | string | Não | Início do período de comparação, YYYY-MM-DD. | | `compare_end` | string | Não | Fim 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): | Campo | Tipo | Descrição | |---|---|---| | `id` | integer | ID da oportunidade. | | `state` | string | Estado comercial. | | `status` | integer | ID da etapa. | | `status_name` | string | Nome da etapa. | | `value` | number | Valor para o relatório. | | `profit` | number | Lucro, quando permitido. | | `date` | string | Mês no formato YYYY-MM. | | `state_loss` | integer | ID do motivo de perda. | | `loss_name` | string | Motivo de perda. | ```json { "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 | HTTP | Código | Situação | |---|---|---| | 422 | `REPORT_PERIOD_REQUIRED` | Perí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.

Response

datalist of objects

Errors

422

Unprocessable Entity Error