Gerenet


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

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00

Variaveis criadas

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

Nome Exemplo de valor retornado
CLIENT_ID retorna o identificador unico do cliente.
Ex: 158
TYPE Tipo de cliente.
Ex: Pré-venda | Assinante
CODE_TYPE Código do tipo de cliente.
Ex: 321

Retornos

{success.fa-check} 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 ja será preenchida automaticamente. Também serão preenchidas automaticamente as variáveis TYPE e CODE_TYPE. pelo fluxo.

{danger.fa-close} Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar cliente por telefone

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

Itens dependentes

Este item não depende de nenhum item

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
PHONE SIM Telefone para consulta de cliente.
Ex: DDD99999999 ou DDD999999999

Variaveis criadas

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

Nome Exemplo de valor retornado
CLIENT_NAME retorna o nome do cliente.
Ex: Maria José
CPF_CNPJ retorna documento do cliente.
Ex: 000.000.000-00

Retornos

{success.fa-check} Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então a variável CLIENT_NAME e CPF_CNPJ já serão preenchidas automaticamente.

{danger.fa-close} Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar e-mails

Neste item pode-se consultar email(s) do cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_ID SIM Identificador único do cliente.
Ex: 123

Variaveis criadas

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

Nome Exemplo de valor retornado
EMAIL E-mail do usuário.
Ex: exemplo@email.com
LIST_EMAILS Lista de e-mails do usuário.
Ex:
exemplo01@email.com
exemplo02@email.com

Retornos

{success.fa-check} Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

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

{warning.fa-exclamation} 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áivel LIST_EMAILS para definir a variavel EMAIL e então prosseguir com a integração.

{danger.fa-close} Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boletos - PDF - link - linha digitável

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

{info.fa-arrow-right}Serão retornados todos os boletos em aberto.
Ex.: Se o cliente realizar a consulta no mês 06/2020, serão retornados os boletos do mês de 04/2020, 05/2020, 06/2020, 07/2020, 08/2020, 09/2020... caso estejam em aberto.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00
CLIENT_ID SIM Identificador único do cliente.
Ex: 12345
STATUS_TITLE SIM Determina quais boletos serão retornados.
Ex:
0 = todos | 1 = atrasados | 2 = mês atual
TRANSACTION_GER SIM Retorna ID dos boletos Gerencianet.
Ex: S | N
UPDATE_VECTO SIM Atualiza a data/valor dos boletos.
Ex: S | N
GENERATE_PDF NÃO Para gerar PDF dos boletos com entrada confirmada.
Ex: S | N
TYPE_RETURN SIM Indica qual forma de retorno dos boletos.
Ex:
P = PDF (só será gerado PDF caso o cliente utilize a v2 Gerencianet)
L = Link
LD = Linha digitável

Variaveis criadas

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

Nome Exemplo de valor retornado
INVOICE_RETURN Retorna resposta do serviço.
Ex: OK | EMPTY | ERROR_1 | ERROR_2 | etc...
INVOICE_ORIGIN Retorna origem do boleto.
Ex:
1 - gerado pela empresa
2 - gerado por Gerencianet
INVOICE_DUEDATE Retorna resposta do serviço.
Ex: 01/01/2020
INVOICE_VALUE Retorna valor do boleto.
Ex: 49.90
INVOICE_DATA Caso INVOICE_ORIGIN seja = 1
retorna linha digitável do boleto.
Ex: 000 00000 00000 000000
Caso INVOICE_ORIGIN seja = 2
retorna link de visualizção do boleto.
Ex: http://link_do_boleto.com.br/
INVOICE_DATA2 Caso INVOICE_ORIGIN seja = 1
retorna link de visualizção do boleto.
Ex: http://link_do_boleto.com.br/
Caso INVOICE_ORIGIN seja = 2
retorna ID Gerencianet (somente se o parâmetro TRANSACTION_GER estiver preenchido com "S").
Ex: 12345875

Retornos

{success.fa-check} Encontrado

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

{danger.fa-close} Não encontrado

Quando o boleto não for encontrado

Enviar boletos (e-mail)

Este item envia boletos do cliente por e-mail.
Será recebido via e-mail boleto(s) PDF ou link (caso seja Gerencianet) de acordo com o valor informado no parâmetro STATUS_TITLE

Itens dependentes

Nome
Consultar cliente

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_ID SIM Identificador único do cliente.
Ex: 12345
EMAIL_COUNT SIM Código de conta de e-mail cadastrado.
Ex: 1 | 2 | 10
EMAIL_MESSAGE SIM Mensagem do e-mail.
Ex: Aqui vai a mensagem...
STATUS_TITLE SIM Determina quais boletos serão retornados.
Ex:
0 = todos | 1 = atrasados | 2 = mês atual
ONLINE_PAYMENT SIM Informa se o boleto é gerado pela Gerencianet.
Ex: S | N

Variaveis criadas

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

Nome Exemplo de valor retornado
REASON Essa tag será gerada apenas em caso de erro para informar qual o motivo.
Ex: ERROR_1 | ERROR_2 | ERROR_3 | etc...

Retornos

{success.fa-check} Enviado

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

{danger.fa-close} Não encontrado

Quando não for enviado nenhum boleto

Verifica queda de serviço

Neste item é possível verificar serviços em não funcionamento

Itens dependentes

Nome
Consultar cliente

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_ID SIM Identificador único do cliente.
Ex: 123
POINT_ID NÃO Identificador do ponto do cliente.
Ex: 123

Variaveis criadas

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

Nome Exemplo de valor retornado
STATUS_SERVICE Informa o status do serviço retornado.
Ex: UP | DOWN | nao_encontrado

Retornos

{success.fa-check} Encontrado

Quando for detectado queda em algum serviço/ponto.

{danger.fa-close} Não encontrado

Quando não for encontrado ponto com queda ou alguma informação estiver errada.

Verifica pendência financeira

Neste item é possível verificar se o cliente possui ou não pendência financeira.

Itens dependentes

Nome
Consultar cliente

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_ID SIM Identificador único do cliente.
Ex: 123

Variaveis criadas

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

Retornos

{success.fa-check} Encontrado

Assinante possui pendências financeiras.

{danger.fa-close} Não encontrado

Assinante não possui pendências financeiras.

Desbloqueio por confiança

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

Itens dependentes

Nome
Consultar cliente

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_ID SIM Identificador único do cliente.
Ex: 123

Variaveis criadas

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

Retornos

{success.fa-check} Encontrado

Quando o desbloqueio for realizado com sucesso

{danger.fa-close} 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

Este item não depende de nenhum item

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
TOKEN SIM Token de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00
REQUESTER SIM Código do solicitante.
Ex: 2
ORIGIN_CODE SIM Código de origem de atendimento.
Ex: 5
DESCRIPTION SIM Descrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...
TYPE_TICKET_COD SIM Código do tipo de atendimento.
Ex: 40001
REQUESTER_NAME SIM Nome do solicitante.
Ex: José Maria
REQUESTER_DEGREE SIM Grau do solicitante.
Ex: 1

Variaveis criadas

Nome Exemplo de valor retornado
PROTOCOL Número do protocolo do atendimento.
Ex: 2004201120569

Retornos

{success.fa-check} Encontrado

Quando o chamado for aberto com sucesso, então a variável PROTOCOL ja será preenchida automaticamente pelo fluxo.

{danger.fa-close} Não encontrado

Quando não for possível abrir chamado