List

Lista de Séries de Documentos

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

GET 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	Define o campo e a direcção a usar na pesquisa de países. Campos ordenáveis: id, code, search_order, country_name. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.
search	string	Define o termo de pesquisa a utilizar na lista de países. Campos Pesquisados: Código, Nome do País, Ordem de Pesquisa
code	string	Código do Distrito Para pesquisa parcial pode usar o formato: "code__search"
description	string	Descrição Para pesquisa parcial pode usar o formato: "description__search"
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	Série de Auto-Facturação Esta opção estará disponível apenas se o módulo de Auto-Facturação estiver activo.
is_electronic_serie	boolean	Série de Facturação Electrónica Esta opção estará disponível apenas se o módulo de Facturação Electrónica estiver activo.
is_edi_serie	boolean	Série EDI Esta opção estará disponível apenas se o módulo EDI (Electronic Data Interchange) estiver activo.
is_eu_sales_serie	boolean	Série para Vendas Intracomunitárias Esta opção estará disponível apenas se o módulo de Regime de Vendas à Distância estiver activo.
is_oss_serie	boolean	Série para OSS (One Stop Shop) Esta opção estará disponível apenas se o módulo de Regime de Vendas à Distância estiver activo.
is_offline_serie	boolean	Série Offline Esta opção estará disponível apenas se o módulo POS Offline estiver activo.

200: OK Lista de séries de documentos

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

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

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 4,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "A01",
            "description": "Série A01",
            "is_default_serie": false,
            "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": 3,
            "code": "A02",
            "description": "Série A02",
            "is_default_serie": false,
            "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"
            }
        },
        ...
    ]
}

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.