Cliente
Consulta por nome ou cpf/cnpj
Retorna todos os clientes por nome ou cpf/cnpj.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Nome | Texto | Nome do cliente, aceita consulta parcial | Não |
| Cpfcnpj | Texto | CPF/CNPJ do cliente, aceita consulta parcial | Não |
| Start | Número | Posição do início da consulta | Não |
| Size | Número | Quantidade de itens retornados | Não |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | GUID | Identificador único do cliente |
| Nome | Texto | Nome do cliente |
| Texto | Email do cliente | |
| CPFCNPJ | Texto | CPF/CNPJ do cliente |
| Telefone | Texto | Telefone do cliente |
| CelularNotificacao | Texto | Número do celular do cliente |
| InscricaoMunicipal | Texto | Inscrição Municipal da empresa |
| InscricaoEstadual | Texto | Inscrição Estadual da empresa |
| CEP | Texto | CEP do cliente |
| Logradouro | Texto | Logradouro do cliente |
| Numero | Texto | Número residencial do cliente |
| Complemento | Texto | Complemento para ponto de referência |
| Bairro | Texto | Bairro onde o cliente reside |
| Cidade | Texto | Cidade onde o cliente se localiza |
| UF | Texto | Estado ao qual o cliente pertence |
| Observacoes | Texto | Observações importantes no cadastro do cliente |
| NotificacaoCobrancaDias | Número | Número de dias antes do vencimento da cobrança para o cliente ser notificado |
| NotificacaoCobrancaEmail | Booleano | Se esta opção for marcada, irá notificar via e-mail |
| NotificacaoCobrancaSMS | Booleano | Se esta opção for marcada, irá notificar via sms |
| NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção for marcada irá notificar, via carta impressa |
| PrimeiraTentativaHabilitada | Booleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada |
| PrimeiraTentativaDias | Número | Número de dias a partir do vencimento |
| PrimeiraTentativaEmail | Booleano | 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 | Booleano | Se esta opção for marcada a primeira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| SegundaTentativaHabilitada | Booleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada |
| SegundaTentativaDias | Número | Número de dias a partir do vencimento |
| SegundaTentativaEmail | Booleano | 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 | Booleano | Se esta opção for marcada a segunda tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| TerceiraTentativaHabilitada | Booleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada |
| TerceiraTentativaDias | Número | Número de dias a partir do vencimento |
| TerceiraTentativaEmail | Booleano | 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 | Booleano | Se esta opção for marcada a terceira tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| QuartaTentativaHabilitada | Booleano | Se esta opção for marcada a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| QuartaTentativaDias | Número | Número de dias a partir do vencimento |
| QuartaTentativaEmail | Booleano | 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 | Booleano | Se esta opção for marcada, a quarta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| QuintaTentativaHabilitada | Booleano | Se esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| QuintaTentativaDias | Número | Número de dias a partir do vencimento |
| QuintaTentativaEmail | Booleano | Se esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| QuintaTentativaSMS | Booleano | Se esta opção for marcada, a quinta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| SextaTentativaHabilitada | Booleano | Se esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada |
| SextaTentativaDias | Número | Número de dias a partir do vencimento |
| SextaTentativaEmail | Booleano | Se esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| SextaTentativaSMS | Booleano | Se esta opção for marcada, a sexta tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| SetimaTentativaHabilitada | Booleano | Se esta opção for marcada, a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada |
| SetimaTentativaDias | Número | Número de dias a partir do vencimento |
| SetimaTentativaEmail | Booleano | Se esta opção for marcada, a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| SetimaTentativaSMS | Booleano | Se esta opção for marcada, a sétima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| OitavaTentativaHabilitada | Booleano | Se esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada |
| OitavaTentativaDias | Número | Número de dias a partir do vencimento |
| OitavaTentativaEmail | Booleano | Se esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| OitavaTentativaSMS | Booleano | Se esta opção for marcada, a oitava tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| NonaTentativaHabilitada | Booleano | Se esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada |
| NonaTentativaDias | Número | Número de dias a partir do vencimento |
| NonaTentativaEmail | Booleano | Se esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| NonaTentativaSMS | Booleano | Se esta opção for marcada, a nona tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
| DecimaTentativaHabilitada | Booleano | Se esta opção for marcada, a décima tentativa de aviso em relação ao vencimento das cobranças será realizada |
| DecimaTentativaDias | Número | Número de dias a partir do vencimento |
| DecimaTentativaEmail | Booleano | Se esta opção for marcada, a décima tentativa de aviso em relação ao vencimento das cobranças será realizada via e-mail |
| DecimaTentativaSMS | Booleano | Se esta opção for marcada, a décima tentativa de aviso em relação ao vencimento das cobranças será realizada via SMS |
get/api/Cliente
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/Cliente
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
Query parameters
Nomestring
Nome do cliente, aceita consulta parcial
Cpfcnpjstring
CPF/CNPJ do cliente, aceita consulta parcial
Startinteger
Inicio da consulta
Sizeinteger
Tamanho da consulta
Headers
Aeskeystring required
Response
Clientes consultados com sucesso
Example response
[
{
"Id": "2db7eefc-3a6b-46dd-84ac-3c3c99c87c7d",
"Nome": "Teste Empresa",
"Email": "email@empresa.com",
"CPFCNPJ": "79661388000121",
"Telefone": "1128625266",
"CelularNotificacao": "11999382810",
"InscricaoMunicipal": "4508699",
"InscricaoEstadual": "152548505",
"CEP": "66613163",
"Logradouro": "Rua Terceira",
"Numero": "24",
"Complemento": "Predio azul",
"Bairro": "Floresta",
"Cidade": "Itaituba",
"UF": "PA",
"Observacoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vitae laoreet purus, vitae tristique justo. Mauris erat est, viverra nec ligula et, vehicula aliquet ligula. Proin condimentum leo nec purus iaculis euismod. Praesent nec sem mi. In dictum ante ex, eu porttitor magna dapibus non.",
"NotificacaoCobrancaDias": 0,
"NotificacaoCobrancaEMail": false,
"NotificacaoCobrancaSMS": false,
"NotificacaoCobrancaCartaImpressa": false,
"PrimeiraTentativaHabilitada": true,
"PrimeiraTentativaDias": 2,
"PrimeiraTentativaEMail": true,
"PrimeiraTentativaSMS": true,
"SegundaTentativaHabilitada": true,
"SegundaTentativaDias": 10,
"SegundaTentativaEMail": true,
"SegundaTentativaSMS": true,
"TerceiraTentativaHabilitada": true,
"TerceiraTentativaDias": 15,
"TerceiraTentativaEMail": true,
"TerceiraTentativaSMS": true,
"QuartaTentativaHabilitada": true,
"QuartaTentativaDias": 20,
"QuartaTentativaEMail": true,
"QuartaTentativaSMS": true,
"QuintaTentativaHabilitada": true,
"QuintaTentativaDias": 40,
"QuintaTentativaEMail": true,
"QuintaTentativaSMS": true,
"SextaTentativaHabilitada": true,
"SextaTentativaDias": 60,
"SextaTentativaEMail": true,
"SextaTentativaSMS": true,
"SetimaTentativaHabilitada": true,
"SetimaTentativaDias": 75,
"SetimaTentativaEMail": true,
"SetimaTentativaSMS": false,
"OitavaTentativaHabilitada": false,
"OitavaTentativaDias": 0,
"OitavaTentativaEMail": false,
"OitavaTentativaSMS": false,
"NonaTentativaHabilitada": false,
"NonaTentativaDias": 0,
"NonaTentativaEMail": false,
"NonaTentativaSMS": false,
"DecimaTentativaHabilitada": false,
"DecimaTentativaDias": 0,
"DecimaTentativaEMail": false,
"DecimaTentativaSMS": false
}
]Changes
No recorded changes to this operation across all 1 revision of this API.