# List

## Lista de Séries de Documentos

## Fornece uma Lista de todas as Séries de Documentos existentes.

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

#### 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>                                                                                                                              |
| description           | string  | <p>Descrição</p><p></p><p>Para pesquisa parcial pode usar o formato: "description\_\_search"</p>                                                                                                                                |
| location              | integer | Localização                                                                                                                                                                                                                     |
| is\_closed            | boolean | Série Fechada                                                                                                                                                                                                                   |
| is\_cash\_vat\_scheme | boolean | Série do Regime de IVA de Caixa                                                                                                                                                                                                 |
| is\_self\_billing     | boolean | <p>Série de Auto-Facturação</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Esta opção estará disponível apenas se o módulo de Auto-Facturação estiver activo.</p>                         |
| is\_electronic\_serie | boolean | <p>Série de Facturação Electrónica</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Esta opção estará disponível apenas se o módulo de Facturação Electrónica estiver activo.</p>           |
| is\_edi\_serie        | boolean | <p>Série EDI</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Esta opção estará disponível apenas se o módulo EDI (Electronic Data Interchange) estiver activo.</p>                         |
| is\_eu\_sales\_serie  | boolean | <p>Série para Vendas Intracomunitárias</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Esta opção estará disponível apenas se o módulo de Regime de Vendas à Distância estiver activo.</p> |
| is\_oss\_serie        | boolean | <p>Série para OSS (One Stop Shop)</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Esta opção estará disponível apenas se o módulo de Regime de Vendas à Distância estiver activo.</p>      |
| is\_offline\_serie    | boolean | <p>Série Offline</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Esta opção estará disponível apenas se o módulo POS Offline estiver activo.</p>                                           |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 4,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 3,
            "code": "A01",
            "description": "Série A01",
            "initial_date": null,
            "expiration_date": "2999-12-31T23:59:00Z",
            "is_closed": true,
            "document_serie_type_id": 901,
            "document_serie_type": {
                "code": "P",
                "description": "Documentos Produzidos na Aplicação"
            },
            "location_id": 1,
            "location": {
                "code": 1,
                "description": "Localização 1"
            }
        },
        {
            "id": 4,
            "code": "A02",
            "description": "Série A02",
            "initial_date": "2023-01-03T11:58:00Z",
            "expiration_date": null,
            "is_closed": false,
            "document_serie_type_id": 901,
            "document_serie_type": {
                "code": "P",
                "description": "Documentos Produzidos na Aplicação"
            },
            "location_id": 1,
            "location": {
                "code": 1,
                "description": "Localização 1"
            }
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

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


---

# 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://apidocs.cloudinvoice.net/documentacao-api/series-de-documentos/list.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.