Abrir Detalhe Cliente
Endpoints - Busca de dados do cliente
Para buscar todos os dados de um cliente, são necessárias algumas requisições para a API, que irão retornar os dados do cliente, as observações cadastradas, as notificações cadastradas, o resumo financeiro do cliente e os dependentes cadastrados.
Busca os dados do cliente selecionado
É enviada uma requisição do tipo GET para o endpoint abaixo, passando como parâmetro o ID do cliente desejado, que irá retornar os dados do cliente.
{{ BASE_API_URL }}/v1/cliente/{id}{
"id": 343290,
"mensagem": null,
"permissao": null,
"dataInicial": null,
"dataFinal": null,
"dataCadastro": "2023-05-19",
"lojaId": null,
"redeId": null,
"empresaId": null,
"nome": "Nome do Cliente",
"cpf": "17534614287",
"segmentacao": null,
"tipoDocumento": "CNH",
"identidade": "1R1312224",
"orgaoEmissor": "ssp",
"dataEmissao": "2001-01-01",
"uf": "SC",
"grupo": "B",
"dataNascimento": "1953-09-24",
"naturalEstado": "RS",
"naturalCidade": 4314902,
"sexo": "F",
"estadoCivil": "D",
"dependentes": 0,
"nomePai": "",
"nomeMae": "LUCIA BEZERRA MARQUES",
"telResidencial": "(48) 3891 - 0604",
"celular": "(48) 92822 - 8778",
"email": "cecinovac@gmail.com",
"escolaridade": "SEGUNDO_GRAU_COMPLETO",
"rendaPrincipal": 5000.00,
"enderecoAlternativo": null,
"endereco": {
"cep": "88070-700",
"logradouro": "Rua Professora Antonieta de Barros",
"numero": "732",
"complemento": null,
"bairro": "Canto",
"estado": "SC",
"cidadeIbge": 4205407,
"cidadeNome": "Florianópolis"
},
"tipoResidencia": "P",
"tempoResidenciaAnos": null,
"tempoResidenciaMeses": null,
"resideDesde": "01/1994",
"empresa": "aposentado",
"cargo": "Pensionista",
"tempoEmpregoAnos": null,
"tempoEmpregoMeses": null,
"telComercial": "(48) 3209 - 5961",
"ramal": null,
"nomeRef1": "pablo",
"relacaoRef1": "A",
"telRef1": "(48) 99837 - 8287",
"nomeRef2": "gisa",
"relacaoRef2": "A",
"telRef2": "(48) 99858 - 1509",
"nomeRef3": null,
"relacaoRef3": null,
"telRef3": null,
"nomeRef4": null,
"relacaoRef4": null,
"telRef4": null,
"status": "NORMAL",
"trabalhaNessaEmpresaDesde": "01/2000",
"permitirEnvioSPC": true,
"jaTemCadastroNaLoja": false,
"negativadoSpc": false,
"provedor": null,
"outroProvedor": null,
"flagAutorizacao": null,
"autorizaCompra": null,
"enderecoSecundario": null,
"outrasRendas": 0.00,
"limiteCompartilhado": 3000.00,
"tipoClienteScore": "RESTRITO",
"observacoes": null,
"descricao": null,
"observacao": null,
"assuntoObs": null,
"exibirNaLojaObs": null,
"exibirAte": null,
"exibirMsg": null,
"mensagemErro": null,
"limitesPreAprovado": null,
"valorAluguel": null,
"empregoCBO": 2670,
"score": 754
}Listar observações do cliente
É enviada uma requisição do tipo GET para o endpoint abaixo, passando como parâmetro o ID do cliente desejado, que irá retornar a lista de observações cadastradas para o cliente.
{{ BASE_API_URL }}/v1/cliente/{id}/observacao[
{
"id": 1035,
"clienteId": 343288,
"lojaId": null,
"descricao": "teste de cadastro de obs para exibição",
"dataCadastro": "2023-11-07",
"usuarioNome": null,
"loja": "Sonho Azul",
"observacao": null,
"assuntoObs": "Cobrança",
"exibirNaLojaObs": 441,
"exibirAte": "2023-11-10",
"exibirMsg": true
}
]Listar notificações do cliente
É enviada uma requisição do tipo GET para o endpoint abaixo, passando como
parâmetro o ID do cliente desejado e o ID da loja correspondente, que irá
retornar a lista de notificações cadastradas para o cliente.
{{ BASE_API_URL }}/v1/cliente/{id}/observacao-notif/{lojaId}Buscar Resumo financeiro do cliente
É enviada uma requisição do tipo GET para o endpoint abaixo, passando como parâmetro o ID do cliente desejado e o ID da loja correspondente, que irá retornar o resumo financeiro do cliente.
{{ BASE_API_URL }}/v1/cliente/{id}/resumo-cliente/{lojaId}{
"clienteId": 343290,
"lojaId": 437,
"nomeRede": "Óticas Ferri - Brusque",
"nomeEmpresa": "PRATICO ADMINISTRADORA DE CREDIARIO",
"nomeLoja": "Óticas Ferri - Brusque",
"dataAssinatura": 1689130800000,
"ultimaCompraEm": 1698202800000,
"qtdTotalCompras": 10,
"vlTotalCompras": 513.18,
"saldoDevedorTotal": 414.00,
"saldoDevedorMes": 0,
"limiteExclusivo": 3000.00,
"limiteCompartilhadoDisponivel": 3000.00,
"limiteExclusivoDisponivel": 2586.00,
"ultimoPagamentoEm": null,
"qtdTotalPagamentos": 0,
"vlTotalPagamentos": 0,
"dataStatus": 1689130800000,
"status": "NORMAL",
"atrasoDias": 0,
"atrasoVencto": null,
"maiorAtrasoAteHojeDias": 0,
"maiorAtrasoAteHojeVencto": null,
"maiorAtrasoPrim12mesesDias": 0,
"maiorAtrasoPrim12mesesVencto": null,
"creditScore": null
}Lista os dependentes cadastrados
É enviada uma requisição do tipo GET para o endpoint abaixo, passando como parâmetro o ID do cliente desejado, que irá retornar a lista de dependentes cadastrados para o cliente.
{{ BASE_API_URL }}/v1/dependente/getDependentes/{clienteId}[
{
"id": 10,
"mensagem": null,
"permissao": null,
"clienteId": null,
"nomeCompleto": "nome do dependente",
"parentesco": "C",
"parentescoLabel": "Cônjuge",
"cpf": "155.249.149-87",
"limiteMensal": "900.00",
"celular": "(48) 99999 - 5555",
"operadora": null,
"nomeMae": "nome da mae",
"email": "emai@cliente.com",
"dataNascimento": "2000-05-01",
"isExcluido": false,
"dataExclusao": null
}
]Endpoints - Busca os tipos de dados para montagem do formulário
Para montagem do formulário de cadastramento / detalhamento de cliente, é necessário que seja feita a busca de todos os tipos de dados que serão utilizados no formulário, como por exemplo: estado civil, sexo, escolaridade, etc.
Lista de UF's
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a lista de UF's cadastradas na base de dados.
{{ BASE_API_URL }}/v1/estado[
{
"id": 1,
"dataCadastro": null,
"dataExclusao": null,
"dataAlteracao": null,
"nome": "Acre",
"uf": "AC",
"excluido": false
},
{
"id": 2,
"dataCadastro": null,
"dataExclusao": null,
"dataAlteracao": null,
"nome": "Alagoas",
"uf": "AL",
"excluido": false
}...
] Listar cidades por UF
É enviada uma requisição do tipo GET para o endpoint abaixo, passando como parâmetro a UF desejada, que irá retornar a lista de cidades correspondentes.
{{ BASE_API_URL }}/v1/cidade/uf/{uf}[
{
"id": 3851,
"dataCadastro": null,
"dataExclusao": null,
"dataAlteracao": 1629238205044,
"nome": "Água Santa",
"ibge": 4300059,
"estado": {
"id": 23,
"dataCadastro": null,
"dataExclusao": null,
"dataAlteracao": null,
"nome": "Rio Grande do Sul",
"uf": "RS",
"excluido": false
},
"nomeSemAcento": "AGUA SANTA",
"latLon": "(-28.167200088500977,-52.03099822998047)",
"excluido": false
},
{
"id": 3852,
"dataCadastro": null,
"dataExclusao": null,
"dataAlteracao": 1629238205820,
"nome": "Agudo",
"ibge": 4300109,
"estado": {
"id": 23,
"dataCadastro": null,
"dataExclusao": null,
"dataAlteracao": null,
"nome": "Rio Grande do Sul",
"uf": "RS",
"excluido": false
},
"nomeSemAcento": "AGUDO",
"latLon": "(-29.644699096679688,-53.25149917602539)",
"excluido": false
}....
]Lista os tipos de profissões cadastradas na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a lista de profissões cadastradas na base de dados.
{{ BASE_API_URL }}/v1/emprego_cbo [
{
"id": 2669,
"mensagem": null,
"permissao": null,
"codigo": 0,
"renda": 1000.00,
"titulo": "APOSENTADO"
},
{
"id": 2670,
"mensagem": null,
"permissao": null,
"codigo": 1,
"renda": 1000.00,
"titulo": "Pensionista"
},
{
"id": 754,
"mensagem": null,
"permissao": null,
"codigo": 261110,
"renda": 0.00,
"titulo": "Assessor de imprensa"
},
{
"id": 839,
"mensagem": null,
"permissao": null,
"codigo": 300305,
"renda": 0.00,
"titulo": "Técnico em eletromecânica"
}...
] Lista os tipos de assunto cadastrados na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a lista de assuntos cadastrados na base de dados. Essa é a tipagem utilizada no campo assuntoObs no cadastro de observações do cliente.
{{ BASE_API_URL }}/v1/tipos/assunto-observacao[
{
"id": "ATRASO_FATURA",
"descricao": "Atraso na fatura"
},
{
"id": "COBRANCA",
"descricao": "Cobrança"
},
{
"id": "CONTROLE_INTEIRO",
"descricao": "Controle interno"
},
{
"id": "CANCELAMENTO_PAGTO",
"descricao": "Pagamento cancelado"
}...
]Lista os tipos de escolaridade cadastradas na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo escolaridade do cadastro do cliente.
{{ BASE_API_URL }}/v1/tipos/escolaridade[
{
"id": "ANALFABETO",
"descricao": "Analfabeto"
},
{
"id": "PRIMEIRO_GRAU_INCOMPLETO",
"descricao": "1 Grau Incompleto"
},
{
"id": "PRIMEIRO_GRAU_COMPLETO",
"descricao": "1 Grau Completo"
},
{
"id": "SEGUNDO_GRAU_INCOMPLETO",
"descricao": "2 Grau Incompleto"
}...
]Lista os tipos de estado civil cadastradas na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo estado civil do cadastro do cliente.
{{ BASE_API_URL }}/v1/tipos/estado-civil[
{
"id": "C",
"descricao": "Casado"
},
{
"id": "D",
"descricao": "Divorciado"
},
{
"id": "S",
"descricao": "Solteiro"
},
{
"id": "U",
"descricao": "União Estável"
},
{
"id": "V",
"descricao": "Viúvo"
},
{
"id": "X",
"descricao": "Outro"
}
]Lista os tipos de gênero cadastradas na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo gênero do cadastro do cliente.
{{ BASE_API_URL }}/v1/tipos/sexo[
{
"id":"F",
"descricao":"Feminino"
},
{
"id":"M",
"descricao":"Masculino"
}
]Lista os tipos de status de cliente cadastradas na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo status de cliente do cadastro do cliente.
{{ BASE_API_URL }}/v1/tipos/status-cliente[
{
"id": "ATIVO",
"descricao": "Ativo"
},
{
"id": "NORMAL",
"descricao": "NORMAL"
},
{
"id": "BLOQUEADO",
"descricao": "BLOQUEADO"
},
{
"id": "BLOQUEADO_EM_ANALISE",
"descricao": "BLOQUEADO - Em Análise"
},
{
"id": "BLOQUEADO_EM_ACORDO",
"descricao": "BLOQUEADO - Em Acordo"
}...
]Lista os tipos de relacionamentos cadastrados na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo relação ao cadastrar uma referência pessoal do cliente.
{{ BASE_API_URL }}/v1/tipos/tipo-referencia-pessoal[
{
"id": "A",
"descricao": "Amigo"
},
{
"id": "C",
"descricao": "Cônjuge"
},
{
"id": "F",
"descricao": "Filho(a)"
},
{
"id": "I",
"descricao": "Irmão"
},
{
"id": "M",
"descricao": "Pai / Mãe"
},
{
"id": "P",
"descricao": "Familiar"
},
{
"id": "X",
"descricao": "Outros"
}
]Lista os tipos de residência cadastrados na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo tipo de residência do cadastro do cliente.
{{ BASE_API_URL }}/v1/tipos/tipo-residencia[
{
"id": "A",
"descricao": "Alugada"
},
{
"id": "F",
"descricao": "Financiada"
},
{
"id": "M",
"descricao": "Com os Pais"
},
{
"id": "N",
"descricao": "Com Familiares"
},
{
"id": "P",
"descricao": "Própria"
},
{
"id": "X",
"descricao": "Outra"
}
]Lista os tipos de documentos cadastrados na base
É enviada uma requisição do tipo GET para o endpoint abaixo, que irá retornar a tipagem utilizada no campo tipo de documento no cadastro do cliente.
{{ BASE_API_URL }}/v1/tipos/cliente-tipo-doc[
{
"id": "RG",
"descricao": "RG"
},
{
"id": "CNH",
"descricao": "CNH"
},
{
"id": "CTPS",
"descricao": "CTPS"
},
{
"id": "CC",
"descricao": "Conselho de classe"
},
{
"id": "PASS",
"descricao": "Passaporte"
}
]Para visualização dos documentos digitalizados do cliente salvos na base de dados, siga as instruções contidas na funcionalidade Digitalizar Documentos do cliente.