WebService SOAP utilizado para integração de dados do Portal de Clientes.
\nCom o WsPortalClientesAPI, é possível:
\nPré-requisito
\nVerifica se a parcela informada possui boleto de segunda via disponível para emissão do Portal de Clientes:
\nTambém será informado caso a parcela esteja com boleto vinculado em processamento.
\nParâmetros
\nSerá obtido o objeto RetornoBoleto que possui as seguintes propriedades:
\nVerifica se a parcela informada possui boleto de antecipação disponível para emissão do Portal de Clientes:
\nTambém será informado caso a parcela esteja com boleto vinculado em processamento.
\nParâmetros
\nSerá obtido o objeto RetornoBoleto que possui as seguintes propriedades:
\nSimula ou gera o boleto de antecipação das parcelas de acordo com o parâmetro Efetivar.
\nCom o valor false, será retornado o valor total e valor de desconto.
\nCom o valor true, verifica se as parcelas informadas possuem boleto de antecipação disponível para emissão do Portal de Clientes:
\nTambém será informado caso as parcelas estejam com o boleto vinculado em processamento ou caso alguma das parcelas já tenha boleto disponível.
\nParâmetros
\nSerá obtido o objeto RetornoBoleto que possui as seguintes propriedades:
\nExemplo ObterBoletoAntecipacaoParcelas - Simulação
\nVerifica se a parcela informada possui boleto ativo retornando a linha digitável e o boleto em base64.
\nTambém será informado caso a parcela esteja com o boleto vinculado em processamento.
\nParâmetros
\nSerá obtido o objeto RetornoBoleto que possui as seguintes propriedades:
\nExemplo ObterBoletoHomepay - Antecipação de parcelas
\nSimula a antecipação de uma parcela.
\nParâmetros
\nSerá obtido o objeto SimulacaoAntecipacao que possui as seguintes propriedades:
\nExemplo ObterSimulacaoAntecipacao
\nRetorna se determinado contrato possui parcelas em aberto com data de vencimento menor ou igual a data atual para a solicitação de boleto.
\nParâmetros
\nNo retorno será obtido o objeto Retorno que possui as seguintes propriedades:
\nErro: Indica se houve erro na execução.
\nMensagemErro: Informações sobre o erro.
\nRetornoMega: Será retorno um valor para indicar se há ou não boleto em aberto para o contrato.
Valores válidos: True=Sim e False=Não.
Cria áreas de aplicações externas no Portal de Clientes.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nEdita áreas de aplicações externas no Portal de Clientes.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nExclui área de aplicações externas.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nGrava a data e hora de acesso de um usuário e as áreas criadas pelo serviço CriarArea.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nAltera a senha do usuário em seu primeiro acesso.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nRecebe o login e senha do usuário no Portal de Clientes para verificar se corresponde a algum cliente ativo do Portal de Clientes e retorna os links de acesso já conectado ao portal, não havendo necessidade de informar o login e senha novamente.
\nParâmetros
\nSerão retornados no objeto ClienteUsuario os dados do usuário de acordo com o perfil de acesso.
\n","urlObject":{"protocol":"http","port":"1090","path":["WsPortalClientesApi","PortalClientesApi.asmx"],"host":["localhost"],"query":[{"key":"op","value":"AutenticaUsuario"}],"variable":[]}},"response":[{"id":"b94aec43-801f-4e7b-85a3-20c2f68638ec","name":"AutenticaUsuario - Administrador/Operador","originalRequest":{"method":"POST","header":[{"key":"Cache-Control","value":"private, max-age=0","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\nVerifica a existência do usuário no Portal de Clientes e envia os dados de acesso por e-mail.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nObtém as áreas cadastradas pelo serviço CriarArea de acordo com o perfil do usuário.
\nParâmetros
\nNo retorno será obtido uma lista de objetos Area que possui as seguintes propriedades:
\nRetorna os contratos do Portal de Clientes consultando pelo CPF ou CNPJ recebido.
\nParâmetros
\nSerá obtida uma lista do objeto Contrato.
\nO valor do campo PARCELA_BOLETO_2VIA é apresentado somente quando a parcela está vinculada à banco e disponível para emissão de boleto de segunda via no Portal de Clientes.
\nO valor do campo TOTAL_DEVIDO retorna o valor total corrigido das parcelas em aberto do contrato e calcula os juros e multas das parcelas em atraso.
\nO campo possui uma regra de preenchimento: Quando a primeira parcela disponível para emissão de boleto, for atrasada, é atribuído o valor -1 para a propriedade e os campos PARCELA_BOLETO_2VIA, PARC_BOLETO_2VIA_VALOR, PARC_BOLETO_2VIA_VCTO, relacionados ao boleto de segunda via não são preenchidos.
Caso a primeira parcela disponível para emissão de boleto, com status ‘Emitir boleto’, não esteja atrasada, é preenchido o valor 1 para a propriedade e os campos relacionados a segunda via são preenchidos.
Caso não haja parcelas disponíveis para emissão de boleto, status ‘Emitir boleto’, é apresentado o valor 0.
O campo TOTAL_PARCELA_ANTECIPAR é preenchido com a quantidade de parcelas disponíveis para antecipação, status ‘Solicitar boleto’ no mês corrente.
Caso tenha somente uma parcela disponível para antecipação no mês corrente, é retornado o valor 1 e os campos PARCELA_ANTECIPAR, PARC_ANTECIPAR_TIPO, PARC_ANTECIPAR_VALOR e PARC_ANTECIPAR_VCTO são preenchidos de acordo com os dados da parcela.
Caso não encontre parcelas disponíveis para antecipação, é retornado o valor 0.
Caso tenha mais de uma parcela disponível para antecipação no mês corrente, é retornada a quantidade de parcelas e os campos PARCELA_ANTECIPAR, PARC_ANTECIPAR_TIPO, PARC_ANTECIPAR_VALOR e PARC_ANTECIPAR_VCTO não são preenchidos.
Lista os empreendimentos disponíveis no Portal de Clientes.
\nParâmetros
\nSerá retornado o objeto Empreendimento com os códigos e nomes dos empreendimentos.
\n","urlObject":{"protocol":"http","port":"1090","path":["WsPortalClientesAPI","PortalClientesApi.asmx"],"host":["localhost"],"query":[{"key":"op","value":"ListaEmpreendimentos"}],"variable":[]}},"response":[{"id":"86325cfd-2b32-46f8-8dda-7876c3187d36","name":"ListaEmpreendimentos","originalRequest":{"method":"POST","header":[{"key":"Cache-Control","value":"private, max-age=0","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\nLista todos os usuários clientes que possuem contrato em um determinado empreendimento.
\nParâmetros
\nNo retorno será obtida uma lista de objetos UsuarioEmpreendimento que possui as seguintes propriedades:
\nA propriedade Empreendimentos do objeto UsuarioEmpreendimento é composta pelo objeto ClienteEmpreendimento que possui as seguintes propriedades:
\nObtém o andamento da obra através do código do contrato.
\nParâmetros
\nSerá obtido o objeto EtapaDaObra que possui as seguintes propriedades:
\nObtém os contratos disponíveis vinculados ao usuário do tipo Operador ou Administrador/Operador.
\nParâmetros
\nNo retorno será obtido o objeto ObterContratosUsuarioResult, composto por uma lista de objetos ContratoUsuario com as seguintes propriedades:
\nRetorna o link de acesso para tela de recuperação de senha do Portal de Clientes.
\nParâmetros
\nNo retorno será obtido o objeto Retorno que possui as seguintes propriedades:
\nRetorna os links de acesso ao Portal de Clientes do contrato informado, na visão Cliente/Operador, para o usuário.
\nParâmetros
\nNo retorno será obtido o objeto LinksCliente que possui as seguintes propriedades:
\nHome: Link autenticado para a home do cliente.
\nAlterarSenha: Link autenticado para alterar a senha do usuário.
\nBoletosSegundaVia: Link autenticado para a tela de emissão de boletos de 2ª via.
\nAntecipacao: Link autenticado para a tela de antecipação de parcelas.
\nFaleConosco: Link autenticado para a tela do fale conosco.
\nPerguntasFrequentes: Link autenticado para a tela de perguntas frequentes.
\nSintese: Link autenticado para a tela de síntese do contrato.
\nDemonstrativo: Link autenticado para a tela de demonstrativo de valores pagos.
\nExtratoFinanceiro: Link autenticado para a tela de extrato financeiro.
\nErro: Indica se houve erro na execução.
\nMensagemErro: Informações sobre o erro.
\nA autenticação no Portal de Clientes será realizada automaticamente por meio dos links, dispensando o preenchimento manual dos dados de acesso.
\n","urlObject":{"protocol":"http","port":"1090","path":["WsPortalClientesApi","PortalClientesApi.asmx"],"host":["localhost"],"query":[{"key":"op","value":"ObterLinksCliente"}],"variable":[]}},"response":[{"id":"775c35b6-aa21-420a-aecf-373e5b5217b0","name":"ObterLinksCliente","originalRequest":{"method":"POST","header":[{"key":"Cache-Control","value":"private, max-age=0","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\nGrava o log das operações realizadas por um determinado usuário.
\nParâmetros
\nSerá obtido o objeto Retorno que possui as seguintes propriedades:
\nObtém o relatório de demonstrativo de valores pagos através do código do contrato e o ano e envia para o e-mail do cliente.
\nParâmetros
\nSerá obtido o objeto DemonstrativoValoresPagos que possui as seguintes propriedades:
\nObtém o relatório de extrato financeiro através do código do contrato e envia para o e-mail do cliente.
\nParâmetros
\nSerá obtido o objeto ExtratoFinanceiro que possui as seguintes propriedades:
\nERRO: Indica se houve erro na execução.
\nDESCRICAO: Informações sobre o erro.
\n