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

# List

## Lista de Tipos de Documentos

## Fornece uma lista de todos os Tipos de Documentos existentes.

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

#### Query Parameters

| Name                  | Type    | Description                                                                                                                                                                                                           |
| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit                 | integer | Define o número de países por pesquisa.                                                                                                                                                                               |
| offset                | integer | Indica a posição inicial da pesquisa. Retorna a lista de países  compreendida entre offset:offset+limit.                                                                                                              |
| ordering              | string  | <p>Define o campo e a direcção a usar na pesquisa de países. </p><p></p><p>Campos ordenáveis: id, code, search\_order, country\_name. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.</p> |
| search                | string  | <p>Define o termo de pesquisa a utilizar na lista de países. </p><p></p><p>Campos Pesquisados: Código, Nome do País, Ordem de Pesquisa</p>                                                                            |
| code                  | string  | <p>Código do Distrito</p><p></p><p>Para pesquisa parcial pode usar o formato: "code\_\_search"</p>                                                                                                                    |
| document\_name        | string  | <p>Nome do Documento</p><p></p><p>Para pesquisa parcial pode usar o formato: "document\_name\_\_search"</p>                                                                                                           |
| is\_hash\_signed      | boolean | Documento Assinado                                                                                                                                                                                                    |
| is\_valued            | boolean | Documento Valorizado                                                                                                                                                                                                  |
| is\_self\_billing     | boolean | Documento de Auto-Facturação                                                                                                                                                                                          |
| is\_plafond\_document | boolean | Documento de Plafond                                                                                                                                                                                                  |
| is\_global\_transport | boolean | Documento de Transporte Global                                                                                                                                                                                        |
| is\_credit\_document  | boolean | Documento de Crédito                                                                                                                                                                                                  |
| is\_return\_document  | boolean | Documento de Devolução                                                                                                                                                                                                |
| is\_eu\_sales         | boolean | <p>Documento de Venda à Distância</p><p></p><p>Esta opção estará disponível apenas se o módulo de Regime de Vendas à Distância estiver activo.</p>                                                                    |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 85,
    "next": "https://api.cloudinvoice.net/documents/configs/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 56,
            "code": "ACX",
            "document_name": "Abertura de Caixa",
            "document_type_id": 295,
            "document_type": {
                "code": "CX",
                "description": "Caixa"
            },
            "party_class_id": 1600,
            "party_class": {
                "code": "N",
                "description": "(Nenhuma)"
            },
            "document_nature_id": 701,
            "document_nature": {
                "code": "ACX",
                "description": "Abertura de Caixa"
            },
            "document_layout_type_id": 915,
            "document_layout_type": {
                "code": "CX",
                "description": "Caixa"
            },
            "saft_doc_category_id": 281,
            "saft_doc_category": {
                "code": "N",
                "description": "Documento Interno/Não-SAFT-PT"
            }
        },
        {
            "id": 42,
            "code": "AST",
            "document_name": "Acerto de Stock",
            "document_type_id": 293,
            "document_type": {
                "code": "S",
                "description": "Stock"
            },
            "party_class_id": 1600,
            "party_class": {
                "code": "N",
                "description": "(Nenhuma)"
            },
            "document_nature_id": 506,
            "document_nature": {
                "code": "AST",
                "description": "Acerto de Stock"
            },
            "document_layout_type_id": 913,
            "document_layout_type": {
                "code": "S",
                "description": "Produtos"
            },
            "saft_doc_category_id": 281,
            "saft_doc_category": {
                "code": "N",
                "description": "Documento Interno/Não-SAFT-PT"
            }
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

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