List

Lista de Clientes

Fornece uma Lista de todos os clientes existentes.

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

Query Parameters

NameTypeDescription

limit

integer

Define o número de clientes por pesquisa.

offset

integer

Indica a posição inicial da pesquisa. Retorna a lista de clientes compreendida entre offset:offset+limit.

ordering

string

Define o campo e a direcção a usar na pesquisa.

search

string

Define o termo de pesquisa a utilizar na lista.

code

integer

Código do cliente para pesquisa.

customer_name

string

Nome do Cliente

Para pesquisa parcial pode usar o formato: "customer_name__search"

commercial_name

string

Nome do Cliente

Para pesquisa parcial pode usar o formato: "commercial_name__search"

fiscal_number

String

Contribuinte

Para pesquisa parcial pode usar o formato: "fiscal_number__search"

external_code

string

Código alternativo do cliente para pesquisa.

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

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