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

# List

Fornece uma lista das séries de documentos existentes.

## Listar Séries de Documentos

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

#### 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              | <p>string<br><sub><mark style="color:$info;">Default: "code"</mark></sub></p> | <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>code</code>, <code>description</code>, <code>location</code></li></ul><p>Use '-' antes do nome para ordem decrescente.</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>description</code>, <code>location</code></li></ul>                                                                                      |
| code                  | string                                                                        | <p>Código da Série</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>\_\_search</code>: para pesquisa parcial</li></ul>                                                                                                                                   |
| description           | string                                                                        | <p>Descrição</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>\_\_search</code>: para pesquisa parcial</li></ul>                                                                                                                                         |
| 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)