Comment on page
Clientes
post
clientes/cadastrar
Cadastrar Cliente
Função responsável pelo cadastro de clientes na plataforma.
Atenção. Campos personalizáveis não disponíveis nessa versão.
Parameters
Body
nome*
String
nome do cliente
email*
Email
email do cliente
senha*
String
senha do cliente
cpfCnpj*
String
cpf ou CNPJ do cliente com mascara
endereco
String
numero
String
bairro
String
cidade
String
estado
String
UF do Estado
cep
String
CEP com mascara
status
String
Status do cliente.
S -> ativo,
I -> Inativo,
N -> Bloqueado.
Se não informado adotará S como padrão
Responses
200: OK
Retorna objeto com status e dados do cliente cadastrado
404: Not Found
Objeto com informações sobre o erro
get
/clientes/listar
Listar Clientes
Lista todos os clientes vinculados na base de consulta.
Filtros estão disponíveis
Parameters
Query
nome
String
Filtra busca pelo nome
cpfCnpj
Number
Filtra pelo CPF ou CNPJ do cliente. (apenas números)
empresa
String
Filtra pelo campo empresa (razão social)
telefone
Number
filtra pelo campo telefone (apenas números)
email
Email
Filtra pelo email do cliente
status
Status
Filtra pelo status do cliente
S -> Ativo
I -> Inativo
N -> Bloqueado
registros
Number
Quantidade de registros a serem listados por consulta (pagina)
Se não informado, adota 20 por padrão
pagina
Number
Página atual da consulta (registros listados em paginação)
padrão: 1
Responses
200: OK
Retora
404: Not Found
get
/clientes/listar/{ID}
Busca dados de um cliente determinado
responsável por listar dados de um cliente.
Parameters
Path
ID
Number
ID do cliente. Esse id pode ser obtido na lista de clientes ou ao buscar faturas, domínios e contas.
Responses
200: OK
retorna um Objeto com os dados do cliente
404: Not Found
Erro na consulta
Last modified 4mo ago