Obtendo os Clientes

A lista dos clientes distribuídos para a assessoria pode ser obtida através do método Clientes API - Listar clientes e, por poder retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas a este método.

Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de clientes retornados. O parâmetro nome pode ser utilizado para pesquisar clientes cujo nome inicie com um determinado conteúdo e também para pesquisar clientes específicos através do nome completo. O parâmetro tipoPessoa (FISICA e JURIDICA) pode ser utilizado para retornar apenas clientes de um tipo de pessoa. Também é possível pesquisar clientes específicos através dos parâmetros cic, para pesquisar pelo CPF/CNPJ, codigo, para pesquisar pelo código do cliente, numeroContrato, para pesquisar através do número de um contrato do cliente, e cliente, para pesquisar através do ID (identificador único) do cliente.

Para que nas informações cadastrais sejam retornadas também as listas dos telefones, e-mails, endereços, referências, informações adicionais e marcadores, o parâmetro de entrada selector pode ser utilizado com uma ou mais opções (telefones, emails, enderecos, referencias, informacoesAdicionais e marcadores), conforme consta na documentação deste método. Para utilizar o parâmetro de entrada selector é necessário utilizar também o modo de paginação CONTINUABLE, informando o parâmetro de entrada mode com a opção CONTINUABLE, conforme descrito em Paginação. Se for informado o parâmetro selector e não for informado o parâmetro mode, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "A consulta deve ser realizada com continuable para usar selector".

Também está disponível o método Clientes API - Buscar cliente que retorna as informações de apenas um cliente específico, cuja identificação (id) deve ser informada na URL de chamada do método.

Somente são retornadas as informações se o cliente estiver distribuído para a assessoria. Caso contrário, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "Você não tem permissão para visualizar esse cliente".

Exemplos de chamadas e de retornos destes métodos constam no arquivo Assessorias - Clientes API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.