Introdução
Autenticação
Resposta e erros
SDKs e plugins
Países
Isenções IVA
Changelog
Vendas
Recibos
Clientes
Clientes - Contas em aberto
Artigos
Artigos - Stock
Artigos - Movimentos stock
Agenda - Marcações
Agenda - Indisponibilidades
Administração
Administração - Armazéns
Administração - Categorias
Administração - Colaboradores
Administração - Condições de pagamento
Administração - Formas de pagamento
Administração - Modos de expedição
Administração - Moedas
Administração - Preços
Administração - Séries
Administração - Taxas de IVA
Administração - Tipos de documento
Administração - Veículos
Administração - Unidades
Subscrição - Locais
Clientes - Lista
—Devolve a lista de clientes. Devolve no máximo 15 resultados.
skip
integer
Determina que indice deve saltar. Deve ser enviado um valor multiplicador de 15.
active
mixed
Define que estados de clientes deve retornar. Deve ser enviado um dos seguintes valores: true
, false
, All
.
Request POST /customers/list
{
"skip": ..
"active": ..
}
Response 200
{
"status": true,
"data":
[
{
"id": ..
"code": ..
"name": ..
"vat_number": ..
...
}
]
}
Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Possíveis erros
- Não tem permissões para executar esta operação