# Estatísticas

### O que o método permite fazer

* Devolve estatísticas sobre os estados das faturas para o período especificado.

### Ponto de extremidade

<mark style="color:verde;">`POST`</mark> `https://api.cryptocloud.plus/v2/invoice/merchant/statistics`

### Cabeçalhos

| Nome                                               | Tipo   | Exemplo                             | Descrição               |
| -------------------------------------------------- | ------ | ----------------------------------- | ----------------------- |
| Autorização<mark style="color:vermelho;">\*</mark> | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Chave da API do projeto |

### Corpo da solicitação

Parâmetros-chave

| Nome                                         | Tipo   | Exemplo    | Descrição                                                                                              |
| -------------------------------------------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------ |
| start<mark style="color:vermelho;">\*</mark> | string | 01.01.2026 | Data no formato `«dd.mm.yyyyy»`                                                                        |
| end<mark style="color:vermelho;">\*</mark>   | string | 31.01.2026 | <p>Data no formato <code>«dd.mm.yyyyy»</code><br><br>Deve ser maior ou igual a <code>start</code>.</p> |

### Exemplos de solicitação

Estes exemplos mostram como enviar um pedido para obter estatísticas sobre os estados das faturas para o período especificado.

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X POST https://api.cryptocloud.plus/v2/invoice/merchant/statistics \
     -H "Authorization: Token <API KEY>" \
     -H "Content-Type: application/json" \
     -d '{"start":"01.01.2023","end":"31.01.2023"}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.cryptocloud.plus/v2/invoice/merchant/statistics"
headers = {
    "Authorization": "Token <API KEY>"
}
data = {
    "start": "01.01.2023",
    "end": "31.01.2023"
}

response = requests.post(url, headers=headers, json=data)

if response.status_code == 200:
    print("Sucesso:", response.json())
else:
    print("Falha:", response.status_code, response.text)
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
fetch('https://api.cryptocloud.plus/v2/invoice/merchant/statistics', {
    method: 'POST',
    headers: {
        'Authorization': 'Token <API KEY>',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        start: '01.01.2023',
        end: '31.01.2023'
    })
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Falha: ' + response.status + ' ' + response.statusText);
    }
})
.then(data => console.log('Sucesso:', data))
.catch(error => console.error('Erro:', error));
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.cryptocloud.plus/v2/invoice/merchant/statistics");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array(
    "start" => "01.01.2023",
    "end" => "31.01.2023"
)));

$headers = array(
    "Authorization: Token <API KEY>",
    "Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Erro:' . curl_error($ch);
} else {
    $statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($statusCode == 200) {
        echo "Sucesso: " . $response;
    } else {
        echo "Falha: " . $statusCode . " " . $response;
    }
}

curl_close($ch);
?>
```

{% endtab %}
{% endtabs %}

### Exemplos de resposta

Uma solicitação bem-sucedida retorna uma resposta com o estado `sucesso` e um `resultado` objeto.

{% tabs %}
{% tab title="200: OK – Estatísticas" %}

```json
{
    "estado": "sucesso",
    "result": {
        "count": {
            "all": 907,
            "created": 4,
            "paid": 90,
            "overpaid": 8,
            "partial": 6,
            "canceled": 799
        },
        "amount": {
            "all": 214356.22712,
            "created": 4.0,
            "paid": 629.729137,
            "overpaid": 36.82,
            "partial": 11.4,
            "canceled": 213674.277983
        }
    }
}
```

{% endtab %}
{% endtabs %}

### Parâmetros da resposta

O `resultado` objeto contém:

| Nome      | Tipo       | Exemplo                                                                                                                                                                                                                                                                   | Descrição                                        |
| --------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| contagem  | dict       | <p>        "count": {</p><p>            "all": 907,</p><p>            "created": 4,</p><p>            "paid": 90,</p><p>            "overpaid": 8,</p><p>            "partial": 6,</p><p>            "canceled": 799</p><p>        }</p>                                  | Objeto contendo valores para o número de faturas |
| amount    | dict       | <p>    "amount": {</p><p>            "all": 214356.22712,</p><p>            "created": 4.0,</p><p>            "paid": 629.729137,</p><p>            "overpaid": 36.82,</p><p>            "partial": 11.4,</p><p>            "canceled": 213674.277983</p><p>        }</p> | Objeto contendo valores para os montantes em USD |
| total     | int, float | 907 / 214356.22712                                                                                                                                                                                                                                                        | Todas as faturas                                 |
| criado    | int, float | 4 / 4.0                                                                                                                                                                                                                                                                   | Faturas com o status “Criado”                    |
| paid      | int, float | 90 / 629.729137                                                                                                                                                                                                                                                           | Faturas com o status “Pago”                      |
| overpaid  | int, float | 8 / 36.82                                                                                                                                                                                                                                                                 | Faturas com o status “Pago em excesso”           |
| partial   | int, float | 6 / 11.4                                                                                                                                                                                                                                                                  | Faturas com o status “Parcialmente pago”         |
| cancelado | int, float | 799 / 213674.277983                                                                                                                                                                                                                                                       | Faturas com o status “Cancelado”                 |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cryptocloud.plus/pt/referencia-da-api-v2/statistics.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.