> For the complete documentation index, see [llms.txt](https://apidocs.cloudinvoice.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.cloudinvoice.net/documentacao-api/relatorios/pdf/create.md).

# Create

Gera um relatório com os parâmetros indicados.

## Gerar Relatório

{% hint style="danger" %}
Gerar relatórios em PDF pode, em alguns casos, ser uma tarefa demorada consoante o volume de dados e/ou intervalo de datas a processar. Por essa razão, o processo é feito assíncronamente pelos servidores CloudInvoice.

A resposta a este endpoint será dada imediatamente, mas isso não significa que o processo tenha sido concluído.

Para verificar o estado do processo, poderá usar o endpoint [/check](/documentacao-api/relatorios/pdf/check.md).
{% endhint %}

<mark style="color:green;">`POST`</mark> `https://api.cloudinvoice.net/reports/pdf/:code/new/`

#### Path Parameters

| Name                                   | Type   | Description                                                                                                                                   |
| -------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| code<mark style="color:red;">\*</mark> | string | <p>Código do Relatório<br><br>Poderá consultar a lista de Relatórios disponíveis <a href="/documentacao-api/relatorios/list.md">aqui</a>.</p> |

#### Request Body

{% hint style="warning" %}
Os valores de input são variáveis, consoante o código do relatório pedido.\
Fazer um pedido ao endpoint pretendido em **`GET`** fornece instruções dos campos e valores que poderá utilizar em cada caso.
{% endhint %}

{% tabs %}
{% tab title="Exemplo de Pedido" %}

```shell
curl -X POST https://api.cloudinvoice.net/reports/sales_vat_map/new/
    -d '{
        "document_date_range": "__last_month__"
    }'
```

{% endtab %}

{% tab title="\[GET] Ex. de Resposta" %}

```json
{
    "id": 200101,
    "code": "sales_vat_map",
    "title": "Mapa de IVA das Vendas",
    "report_title": "Mapa de IVA das Vendas",
    "fields": {
        "location_id": {
            "label": "Localização",
            "help_text": "",
            "required": false,
            "disabled": false,
            "initial": 0,
            "choices": [
                {
                    "value": 1,
                    "text": "Localização 1"
                }
            ]
        },
        "document_date_range": {
            "label": "Intervalo de Datas dos Documentos",
            "help_text": "",
            "required": true,
            "disabled": false,
            "initial": "__today__",
            "choices": [
                {
                    "value": "__current_month__",
                    "text": "Mês Corrente"
                },
                {
                    "value": "__last_month__",
                    "text": "Mês Anterior"
                },
                ...
            ]
        }
    }
}
```

{% endtab %}

{% tab title="\[POST] Ex. de Resposta" %}

```json
{
    "url": "https://api.cloudinvoice.net/reports/pdf/874376a2-8ecf-41b2-ae49-e50d68c7e209/check/",
    "task_id": "874376a2-8ecf-41b2-ae49-e50d68c7e209"
}
```

{% endtab %}
{% endtabs %}

Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](/introducao/exemplos-de-pedidos.md)