get https://pagamentos.k8bank.com.br/CobrancasAPI/api/Cliente
Retorna todos os clientes por nome ou cpf/cnpj
Requisiçao
| Campo | Tipo | Descrição |
|---|---|---|
| nome | Texto | Nome do cliente, aceita consulta parcial |
| cpgcnpj | Texto | CPF/CNPJ do cliente, aceita consulta parcial |
| start | Número | Posição do início da consulta |
| Size | Número | Quantidade de itens retornados |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | Numérico | Identificador único do cliente |
| Nome | Texto | Nome do cliente |
| Texto | Email do cliente | |
| CPFCNPJ | Numérico | CPF/CNPJ do cliente |
| Telefone | Numérico | Telefone do cliente |
| CelularNotificacao | Numérico | Número do celular do cliente |
| InscricaoMunicipal | Numérico | Inscrição Municipal da empresa |
| InscricaoEstadual | Numérico | Inscrição Estadual da empresa |
| CEP | Numérico | CEP do cliente |
| Logradouro | Texto | Logradouro do cliente |
| Numero | Numérico | Número residencial do cliente |
| Complemento | Texto | Complemento para ponto de referência |
| Bairro | Texto | Bairro aonde o cliente reside |
| Cidade | Texto | Cidade aonde o cliente se localiza |
| UF | Texto | Estado a qual o cliente pertence |
| Observacoes | Texto | Observações importantes no cadastro do cliente |
| TotalRecebido | Numérico | Valor total recebido das cobranças relacionadas a esse cliente |
| NotificacaoCobrancaDias | Numérico | Número de dias antes do vencimento da cobrança para o cliente ser notificado |
| NotificacaoCobrancaEmail | Boleano | Se esta opção for marcada irá notificar via e-mail |
| NotificacaoCobrancaSMS | Boleano | Se esta opção for marcada irá notificar via sms |
| NotificacaoCobrancaCartaImpressa | Boleano | Se esta opção for marcada irá notificar via carta impressa |
| PrimeiraTentativaHabilitada | Boleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada |
| PrimeiraTentativaDias | Numérico | Número de dias a partir do vencimento |
| PrimeiraTentativaEmail | Boleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| PrimeiraTentativaSMS | Boleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| SegundaTentativaHabilitada | Boleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada |
| SegundaTentativaDias | Numérico | Número de dias a partir do vencimento |
| SegundaTentativaEmail | Boleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| SegundaTentativaSMS | Boleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| TerceiraTentativaHabilitada | Boleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada |
| TerceiraTentativaDias | Numérico | Número de dias a partir do vencimento |
| TerceiraTentativaEmail | Boleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| TerceiraTentativaSMS | Boleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| QuartaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| QuartaTentativaDias | Numérico | Número de dias a partir do vencimento |
| QuartaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| QuartaTentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| QuintaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| QuintaTentativaDias | Numérico | Número de dias a partir do vencimento |
| QuintaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| QuintaTentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| SextaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| SextaTentativaDias | Numérico | Número de dias a partir do vencimento |
| SextaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| SextaTentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| SetimaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| SetimaTentativaDias | Numérico | Número de dias a partir do vencimento |
| SetimaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| SetimaentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| OitavaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| OitavaTentativaDias | Numérico | Número de dias a partir do vencimento |
| OitavaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| OitavaTentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| NonaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| NonaTentativaDias | Numérico | Número de dias a partir do vencimento |
| NonaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| NonaTentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| DecimaTentativaHabilitada | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| DecimaTentativaDias | Numérico | Número de dias a partir do vencimento |
| DecimaTentativaEmail | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| DecimaTentativaSMS | Boleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |