CloudInvoice API - Docs
Voltar ao InícioPreços e PlanosContacte-nos
  • Introdução
    • Começar a Utilizar
    • Autenticação
    • Exemplos de Pedidos
    • Erros e Respostas
    • Precisa de Ajuda?
    • Change Log
  • Conta / Autenticação
    • Login
    • Login - Sandbox
    • Planos Demo
    • Info do User
    • Empresas
  • Documentação API
    • Documentos
      • List
        • Vendas - List
        • Guias - List
        • Stocks - List
        • Outros Documentos - List
      • Create
      • Get
      • Finalize
      • Annul
      • Print
      • Email
      • Delete
      • Emit - Nota de Crédito
      • Linhas - List
      • Pagamentos - List
      • Apêndice
    • Tipos de Documentos
      • List
      • Get
    • Séries de Documentos
      • List
      • Get
    • Clientes
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Fornecedores
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Produtos
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
      • Stock Geral - List
      • Stock Geral - Get
      • Stocks por Armazém - List
      • Stocks por Armazém - Get
      • Preços de Venda - List
      • Preços de Venda - Get
      • Preços de Venda - Update
      • Códigos Alternativos - List
      • Código Alternativo - Get
      • Código Alternativo - Create
      • Código Alternativo - Update
      • Código Alternativo - Delete
    • Famílias
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Sub-Famílias
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Taxas
      • List
      • Get
    • Motivos de Isenção
      • List
      • Get
    • Linhas de Preços
      • List
      • Get
    • Unidades de Medida
      • List
      • Get
    • Métodos de Pagamento
      • List
      • Get
    • Condições de Pagamento
      • List
      • Get
    • Países
      • List
      • Get
    • Distritos
      • List
      • Create
      • Get
      • Seek
      • Exists
      • Update
      • Delete
    • Concelhos
      • List
      • Create
      • Get
      • Update
      • Delete
    • Relatórios
      • List
      • Create
    • Apêndice
  • Outros Links
    • Ir para /V3 [Deprecated]
Powered by GitBook
On this page
  • Lista de Séries de Documentos
  • Fornece uma Lista de todas as Séries de Documentos existentes.
  1. Documentação API
  2. Séries de Documentos

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.

{
    // Response
}

curl https://api.cloudinvoice.net/series/
    -H "Content-Type: application/json"
{
    "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"
            }
        },
        ...
    ]
}
PreviousSéries de DocumentosNextGet

Last updated 1 year ago

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

Exemplos de Pedidos.