Consultar cliente

Neste item da integração podemos consultar os dados de um determinado cliente.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioDescrição
HOSTSIMHost da API do integrador.
Ex: https://radiusnet.domain.com.br
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeDescriçãoExemplo
STATUSStatus do cliente4
CLIENT_IDIdentificador do cliente2
CLIENTSMensagem com lista de clientes encontradosDigite: 1 para CHARLES MCGILL
Digite: 2 para JIMMY MCGILL
CLIENTS_DATAIDs da lista de clientes encontrados[123, 456, 789]
STATUS_CLIENTStatus do cliente. Quanto encontra somente 1 clienteAtivo, Avisado, Bloqueado

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então as variáveis CLIENT_IDSTATUS_CLIENT serão preenchidas automaticamente pelo fluxo.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, deve-se utilizar a variável CLIENTS para definir a variável CLIENT_ID através do item Selecionar cliente e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar contratos

Neste item pode-se consultar o(os) contrato(s) do cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://radiusnet.domain.com.br
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99
CLIENT_IDSIMConsultar clienteIdentificador do cliente.
Ex: 2

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeDescriçãoExemplo
CONTRACT_IDID do contrato encontrado12
CONTRACTSMensagem com lista de contratosDigite: 12 para Endereço: RUA 1 Plano: VIPTELECOM_10MB
Digite: 13 para Endereço: RUA 1 Plano: INTERNET_FIBRA_20MB
CONTRACTS_DATAIDs da lista de contratos[12, 13]
REGION_PROBLEMInforma se esta com problemas. Quando encontra somente 1 contrato0, 1

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 contrato encontrado, então as variável CONTRACT_IDREGION_PROBLEM serão preenchidas automaticamente pelo fluxo.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, deve-se utilizar a variável CONTRACTS para definir a variável CONTRACT_ID através do item Selecionar contrato e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar boletos (linha digitável)

Este item retorna uma listagem de boletos do cliente de acordo com o filtro especificado

Itens dependentes

Nome
Consultar contratos

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://radiusnet.domain.com.br
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CONTRACT_IDSIMConsultar contratosID do contrato encontrado.
Ex: 12
FILTERSIMFiltro para tipos de boletos.
Ex: npat pg

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeDescriçãoExemplo
INVOICESMensagem com lista de boletosNúmero do boleto: 35948 Valor: 169.98 Vencimento: 25/02/2017 Linha Digitável: 1326449898040749840...
INVOICES_DATAIDs da lista de boletos[35948, 35949]
INVOICE_IDID do boleto encontrado35948

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 contrato encontrado, então a variável INVOICE_ID ja será preenchida automaticamente pelo fluxo.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, deve-se utilizar a variável INVOICES para definir a variável INVOICE_ID e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boletos (PDF)

Este item envia um boleto em PDF para o cliente

Itens dependentes

Nome
Consultar boletos

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://radiusnet.domain.com.br
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
INVOICE_IDSIMConsultar boletosID do boleto.
Ex: 35948

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o boleto for encontrado e enviado com sucesso

Não encontrado

Quando o boleto não for encontrado

Desbloqueio por confiança

Neste item é possível realizar o desbloqueio de um contrato

Itens dependentes

Nome
Consultar boletos

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://radiusnet.domain.com.br
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
INVOICE_IDSIMConsultar boletosID do boleto.
Ex: 35948

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o desbloqueio for realizado com sucesso

Não encontrado

Quando não for possível realizar o desbloqueio ou o contrato não foi localizado

Selecionar cliente

Este item é utilizado quando se encontra mais de um registro para o cliente no mesmo CPF

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioOrigemDescrição
CLIENT_IDSIMIdentificador do cliente fornecido pelo contato.
Ex: 123
CLIENTS_DATASIMConsultar clienteLista contendo os registros do cliente encontrado.
Ex: [...]

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeDescriçãoExemplo
STATUS_CLIENTStatus do clienteAtivo, Avisado, Bloqueado

Retornos

Encontrado

Quando o cliente for encontrado dentro da listagem

Não encontrado

Quando o cliente não for encontrado dentro da listagem

Selecionar contrato

Este item é utilizado para selecionar um determinado contrato do cliente quando o mesmo possui mais de um contrato

Itens dependentes

Nome
Consultar contratos

Parâmetros

NomeObrigatórioOrigemDescrição
CONTRACT_IDSIMIdentificador do contrato fornecido pelo contato.
Ex: 123
CONTRACTS_DATASIMConsultar contratosLista contendo os registros dos contratos encontrados.
Ex: [...]

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeDescriçãoExemplo
REGION_PROBLEMInforma se esta com problemas0, 1

Retornos

Encontrado

Quando o contrato for encontrado dentro da listagem

Não encontrado

Quando o contrato não for encontrado dentro da listagem