For the complete documentation index, see llms.txt. This page is also available as Markdown.

List

Fornece uma lista de todos os clientes existentes.

Listar Clientes

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

Query Parameters

Name
Type
Description

limit

integer

Define o número de registos por pesquisa.

offset

integer

Indica a posição inicial da pesquisa.

Retorna a lista de registos compreendida entre offset e offset+limit.

ordering

string Default: "code"

Define o campo e a direção a usar na pesquisa de registos.

Campos ordenáveis:

  • id, code, external_code, fiscal_number, customer_name

Use '-' antes do nome para ordem decrescente.

search

string

Define o termo de pesquisa a utilizar na lista de registos.

Campos Pesquisados:

  • code, external_code, customer_name, commercial_name, fiscal_number, etc.

code

integer

Código do Cliente

customer_name

string

Nome do Cliente

Sufixos disponíveis:

  • __search: para pesquisa parcial

commercial_name

string

Nome do Cliente

Sufixos disponíveis:

  • __search: para pesquisa parcial

fiscal_number

String

Nº de Contribuinte

Sufixos disponíveis:

  • __search: para pesquisa parcial

external_code

string

Código Alternativo do Cliente

curl https://api.cloudinvoice.net/customers/
    -H "Content-Type: application/json"
{
    "limit": 10,
    "offset": 0,
    "count": 120,
    "next": "https://api.cloudinvoice.net/customers/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "code": 1,
            "external_code": "",
            "customer_name": "Consumidor Final",
            "commercial_name": "",
            "fiscal_number": "999999990",
            "street1": "",
            "street2": "",
            "zip_code": "",
            "zip_locale": "",
            "phone1": "",
            "mobile1": "",
            "email1": "",
            "total_debits": 168997.96,
            "total_credits": 135722.87,
            "current_balance": 33275.09,
            "fiscal_country_id": 1,
            "fiscal_country":{"code": "PT", "country_name": "Portugal"},
            "fiscal_status_type_id": 1592,
            "country_id": 1,
            "country":{"code": "PT", "country_name": "Portugal"},
            "fiscal_status_type":{"code": "1", "description": "Consumidor final"}
        },
        ...
    ]
}

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

Notas: Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.

Last updated