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 Distritos
  • Fornece uma Lista de todos os Distritos existentes.
  1. Documentação API
  2. Distritos

List

PreviousDistritosNextCreate

Last updated 4 months ago

Lista de Distritos

Fornece uma Lista de todos os Distritos existentes.

GET https://api.cloudinvoice.net/districts/

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"

country

integer

ID do País

{
    // Response
}

curl https://api.cloudinvoice.net/districts/
    -H "Content-Type: application/json"
{
    "limit": 10,
    "offset": 0,
    "count": 29,
    "next": "https://api.cloudinvoice.net/districts/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "01",
            "description": "Aveiro",
            "territory_id": 101,
            "country_id": 1,
            "country": {
                "code": "PT",
                "country_name": "Portugal"
            },
            "territory": {
                "code": "CO",
                "description": "Continente"
            }
        },
        {
            "id": 2,
            "code": "02",
            "description": "Beja",
            "territory_id": 101,
            "country_id": 1,
            "country": {
                "code": "PT",
                "country_name": "Portugal"
            },
            "territory": {
                "code": "CO",
                "description": "Continente"
            }
        },
        ...
    ]
}

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

Exemplos de Pedidos.