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://rdomain.com.br/endpoint
USERNAMESIMUsuário para autenticação.
Ex: usuario1
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
CLIENT_IDID do cliente123

Retornos

Encontrado

Quando o cliente for encontrado

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar contrato

Este item procura pelo contrato do cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
USERNAMESIMUsuário para autenticação.
Ex: usuario1
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 123

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 contratosContrato: 12 Endereço: Baker Street, 221B, Marylebone - London
CONTRACTS_DATAIDs da lista de contratos[10, 11, 12]

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 contrato encontrado, então a variável CONTRACT_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 CONTRACTS para definir a variavel CONTRACT_ID e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boleto

Este item envia os boletos (Link de download e linha digitável) para o cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
USERNAMESIMUsuário para autenticação.
Ex: usuario1
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 123

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 boletosValor: 200,00
Vencimento: 21/04/2020
Linha digitável: 80718740874874408...
INVOICES_DATAIDs da lista de boletos[123, 456, 789]
HISTORICMensagem informando os boletos que foram enviados para o clienteBoleto com data de vencimento 21/04/2020 foi enviado

Retornos

Após realizar a consulta de boletos é necessário inserir o item de envio de Enviar histórico para que seja enviado o histórico de consulta de boletos do cliente para a API do integrador

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar histórico

Este item envia o histórico de consulta de boletos e de desbloqueio de contrato para a API do integrador

Para executar este item é necessário ter executado antes uma consulta de boletos ou desbloqueio de contrato

Itens dependentes

Nome
Consultar cliente
Enviar boleto
Desbloquear contrato

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
USERNAMESIMUsuário para autenticação.
Ex: usuario1
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 123
HISTORICSIMEnviar boleto ou Desbloquear contratoMensagem informando os boletos que foram enviados para o cliente.
Ex: Boleto com data de vencimento 21/04/2020 foi enviado

Variáveis criadas

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

Retornos

Encontrado

Quando o histórico for enviado com sucesso

Não encontrado

Quando não for possível enviar o histórico

Consultar bloqueio

Este item consulta se o cliente possui contratos bloqueados que possam ser desbloqueados

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
USERNAMESIMUsuário para autenticação.
Ex: usuario1
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 123

Variáveis criadas

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

NomeDescriçãoExemplo
IDRECTOID meio recebimento123
MEIORECTOID tipo recebimento123

Retornos

Encontrado

Quando for encontrado o contrato para desbloqueio.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Desbloquear contrato

Este item realiza o desbloqueio por confiança de um contrato do cliente

Itens dependentes

Nome
Consultar bloqueio

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
USERNAMESIMUsuário para autenticação.
Ex: usuario1
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
IDRECTOSIMConsultar bloqueioID meio recebimento.
Ex: 123
MEIORECTOSIMConsultar bloqueioID tipo recebimento.
Ex: 123

Variáveis criadas

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

NomeDescriçãoExemplo
HISTORICID do contrato desbloqueado123

Retornos

Encontrado

Quando o contrato for desbloqueado com sucesso

Não encontrado

Quando não for possível desbloquear o contrato