> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.wbudget.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.wbudget.app/_mcp/server.

# Relatorio de faturamento

GET https://wbudget.app/api/v1/api/v1/reports/revenue

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.

Reference: https://developers.wbudget.app/w-budget/relatorios/relatorio-de-faturamento

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `start` (string, optional) — string. Obrigatório. Início do período, no formato YYYY-MM-DD.
- `end` (string, optional) — string. Obrigatório. Fim do período, no formato YYYY-MM-DD.

## Response

### 200

OK

- `data` (list of object, required)
  - `id` (integer, required)
  - `state` (string, required)
  - `status` (integer, required)
  - `status_name` (string, required)
  - `value` (integer, required)
  - `date` (string, required)
  - `profit` (any, optional)
  - `state_loss` (any, optional)
  - `loss_name` (any, optional)

## Errors

### 422 Unprocessable Entity Error

Unprocessable Entity

- `error` (object, required)
  - `message` (string, required)
  - `code` (string, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": 1001,
      "state": "earned",
      "status": 20,
      "status_name": "Ganha",
      "value": 1500,
      "date": "2026-09"
    }
  ]
}
```

**SDK Code**

```python Relatorios_Relatorio de faturamento_example
import requests

url = "https://wbudget.app/api/v1/api/v1/reports/revenue"

querystring = {"end":"2026-09-30","start":"2026-09-01"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Relatorios_Relatorio de faturamento_example
const url = 'https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Relatorios_Relatorio de faturamento_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Relatorios_Relatorio de faturamento_example
require 'uri'
require 'net/http'

url = URI("https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Relatorios_Relatorio de faturamento_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Relatorios_Relatorio de faturamento_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Relatorios_Relatorio de faturamento_example
using RestSharp;

var client = new RestClient("https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Relatorios_Relatorio de faturamento_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://wbudget.app/api/v1/api/v1/reports/revenue?end=2026-09-30&start=2026-09-01")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```