> 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/documentos/list.md).

# List

Fornece uma lista dos documentos existentes.

## Listar Documentos

{% hint style="warning" %}
Esta listagem geral **NÃO** inclui os documentos internos. Estes deverão ser obtidos apenas pela lista específica para o efeito, descrita [aqui](/documentacao-api/documentos/list/documentos-internos.md).
{% endhint %}

<mark style="color:blue;">`GET`</mark> `https://api.cloudinvoice.net/documents/`

#### Query Parameters

| Name             | Type    | Description                                                                                                                                                                                                                                                                                            |
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| limit            | integer | Define o número de registos por pesquisa.                                                                                                                                                                                                                                                              |
| offset           | integer | <p>Indica a posição inicial da pesquisa.</p><p>Retorna a lista de registos compreendida entre <code>offset</code> e <code>offset+limit</code>.</p>                                                                                                                                                     |
| ordering         | string  | <p>Define o campo e a direção a usar na pesquisa de registos. </p><p></p><p>Campos ordenáveis:</p><ul><li><code>id</code>, <code>doc\_key</code>, <code>document\_date</code>, <code>document\_time</code></li></ul><p>Use '-' antes do nome para ordem decresente.</p>                                |
| search           | string  | <p>Define o termo de pesquisa a utilizar na lista de registos. </p><p></p><p>Campos Pesquisados:</p><ul><li><code>doc\_key</code>, <code>document\_name</code>, <code>our\_reference</code>, <code>party\_fiscal\_number</code>, <code>party\_name</code>, <code>salesman\_name</code>, etc.</li></ul> |
| document\_nature | integer | <p>Natureza do Documento</p><p></p><p>Consulte a tabela <a href="/documentacao-api/apendice.md#naturezas-de-documentos-campo-document_nature">Apêndice</a> para mais informação</p>                                                                                                                    |
| document\_status | integer | <p>Estado do Documento</p><p></p><p>Consulte a tabela <a href="/documentacao-api/apendice.md#estados-dos-documentos-campo-document_status">Apêndice</a> para mais informação</p>                                                                                                                       |

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

```shell
curl https://api.cloudinvoice.net/documents/
    -H "Content-Type: application/json"
```

{% endtab %}

{% tab title="Exemplo de Resposta" %}

```json
{
    "limit": 10,
    "offset": 0,
    "count": 3279,
    "next": "https://api.cloudinvoice.net/documents/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "doc_key": "FSI A01/1",
            "document_date": "2023-01-10",
            "document_time": "11:30:48.700759",
            "document_number": 1,
            "our_reference": "",
            "is_valued": true,
            "total_amount": 54.9,
            "total_due_amount": 0.0,
            "due_date": "2023-01-10",
            "document_id": 2,
            "document": {
                "code": "FSI", 
                "document_name": "Factura Simplificada"
            },
            "document_serie_id": 1,
            "document_serie": {
                "code": "A01", 
                "description": "Série A01"
            },
            "document_status_id": 1202,
            "document_status": {
                "code": "F", 
                "description": "Finalizado"
            },
            "warehouse_id": 1,
            "warehouse": {
                "code": 1, 
                "description": "Armazém 1"
            },
            "document_nature_id": 302,
            "document_nature": {
                "code": "FS", 
                "description": "Factura Simplificada"
            },
            "party_id": 1,
            "party": {
                "class": 1601, 
                "code": 1, 
                "name": "Consumidor Final", 
                "fiscal_number": "999999990"
            }
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

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

{% hint style="info" %}
**Notas:** Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.
{% endhint %}