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órioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdf
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00

Variáveis criadas

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

NomeExemplo de valor retornado
CLIENT_IDretorna o identificador único do cliente.
Ex: 158
DATA_CLIENTRetorna contrato do cliente.
Ex:
12345
MSG_DATASRetorna dados dos contratos do cliente.
Ex:
Digite 1 para contrato 01
Digite 2 para contrato 02
DATASRetorna dados dos contratos do cliente.
Ex:
[{'id':1, 'code'12345}, {'id':2, 'code'12346}]

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então a variável CLIENT_ID já 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 as variáveis MSG_DATASDATAS para definir a variável CLIENT_ID e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar documentos abertos

Neste item pode-se consultar documento(s) em aberto (s) do cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdf
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
DATASSIMDados dos contratos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]

Variáveis criadas

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

NomeExemplo de valor retornado
DOCUMENTSRetorna dados dos documentos do cliente.
Ex:
[{'id':1, 'code'12345}, {'id':2, 'code'12346}]

Retornos

Encontrado

Quando for encontrado apenas 1 ou vários resultados para esta consulta.

Caso a consulta retorne resultado (s), então a variável DOCUMENTS já será preenchida automaticamente pelo fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boletos (e-mail)

Este item envia boletos do cliente por e-mail

Itens dependentes

Nome
Consultar cliente
Consultar documentos abertos

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: exemplo@email.com
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
EMAIL_SENDSIMEndereço de e-mail que receberá boleto.
Ex: 158
DOCUMENTSSIMDados dos documentos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]
DATASSIMDados dos contratos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]

Variáveis criadas

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

Retornos

Enviado

Quando o (s) boleto (s) for (em) enviado (s) com sucesso

Não encontrado

Quando não for enviado nenhum boleto

Enviar boletos (link)

Este item retorna link (s) para download do (s) boleto (s) do cliente

Itens dependentes

Nome
Consultar cliente
Consultar documentos abertos

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: exemplo@email.com
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
DOCUMENTSSIMDados dos documentos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]

Variáveis criadas

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

Retornos

Enviado

Quando o (s) boleto (s) for (em) enviado (s) com sucesso

Não encontrado

Quando não for enviado nenhum boleto

Enviar boletos (PDF)

Este item envia boleto (s) em PDF para o cliente

Itens dependentes

Nome
Consultar cliente
Consultar documentos abertos

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: exemplo@email.com
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
DOCUMENTSSIMDados dos documentos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]

Variáveis criadas

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

Retornos

Encontrado

Quando o (s) boleto (s) for (em) enviado (s) com sucesso

Não encontrado

Quando o boleto não for encontrado

Enviar linha digitável

Este item envia linha digitável do (s) boleto (s) para o cliente

Itens dependentes

Nome
Consultar cliente
Consultar documentos abertos

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: exemplo@email.com
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
DOCUMENTSSIMDados dos documentos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]
SENDBARCODESIMEnviar linha digitável.
Ex: true | false
PHONESIMTelefone que receberá informação.
Ex: 99999999999

Variáveis criadas

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

Retornos

Encontrado

Quando a (s) linha (s) digitável (is) for (em) enviada (s) com sucesso

Não encontrado

Quando nenhuma linha digitável for encontrado

Desbloqueio por confiança

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

Itens dependentes

Nome
Consultar cliente
Consultar documentos abertos

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: exemplo@email.com
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
DOCUMENTSSIMDados dos documentos do cliente.
Ex: [{'id':1, 'code'12345}, {'id':2, 'code'12346}]

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

Abertura de chamado

Neste item é possível realizar abertura de chamado

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: exemplo@email.com
CLIENT_IDSIMIdentificador único do cliente.
Ex: 158
INITIATIVESIMIniciativa de abertura de atendimento.
Ex: C = Cliente | A = Atendente
MODESIMPor onde foi realizado o atendimento.
Ex: T = Telefone | V = Visita | C = Chat
TYPE_CLIENTSIMTipo do cliente.
Ex: C = Clilente | M = Mercado
SUBJECTSIMAssunto do atendimento.
Ex: Assunto do atendimento
TYPESIMTipo de atendimento.
Ex: A = Administrativo | C = Comercial | T = Técnico
TOPICSIMCódigo de um tópico ativo cadastrado no RouterBOX.
Ex: C

Variáveis criadas

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

Retornos

Encontrado

Quando o chamado for aberto com sucesso

Não encontrado

Quando não for possível abrir chamado