Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 7 Próxima »

⚙ Funcionalidades:

Criação de pedidos

Criação de pedidos para clientes existentes

Criação de lead

Listagem de boletos

Listagem de boletos para totem

PDF de boleto

Baixa de boleto

Informações do cliente

Criação de chamado

Listagem de nota fiscal

PDF da nota fiscal

Listar planos do cliente

Listar planos bloqueados do cliente

Desbloqueio de confiança

Listar faturas do cliente

Editar dados do cliente

🔧 Configurações:

Para a configuração dessa integração é preciso criar uma automação para cada função, o guia de como configurar as automações segue abaixo

https://myog.atlassian.net/l/cp/sBcxiw2W

Cada função tem determinadas informações que podem ser usadas nas ações, as informações de cada função são as seguintes:

Criação de pedido:

Entrada:

ORDER order= Pedido feito pelo cliente

STRING message = Mensagem com informações do pedido, geralmente usado num campo de observações

Saída:

STRING

“{

ORDER wda_order = Pedido

STRING remote_id = ID do pedido no ERP

STRING remote_message = Resposta da API ou None

BOOL is_issue = Aberto como chamado ou não

}“

Criação de pedido para cliente já existente:

Entrada:

ORDER order= Pedido feito pelo cliente

STRING message= Mensagem com informações do pedido, geralmente usado num campo de observações

STRING customer_document_number = CPF/CNPJ do cliente

USER wda_user = Usuário do cliente


Saída:

STRING

“{

STRING remote_id = ID do pedido no ERP

}“

Criação de lead:

Entrada:

lead: Lead = Informações do lead gerado

Saída:

N/A

Listar revendedores:

Entrada:

N/A


Saída:

STRING

“[

{

STRING code = ID do revendedor no ERP

STRING name = Nome do revendedor

STRING taxvat = CPF/CNPJ do revendedor

STRING email = Email do revendedor

}

]“

Listar produtos:

Entrada:

N/A


Saída:

STRING

“[

{

STRING codigo = ID do produto no ERP

STRING nome = Nome do produto

}

]“

Listar datas de vencimento:

Entrada:

N/A


Saída:

STRING

“[

{

STRING code = ID da data de vencimento no ERP

STRING name = Dia do vencimento

}

]“

Listar origens comerciais:

Entrada:

N/A


Saída:

STRING

“[

{

STRING code = ID da origem comercial no ERP

STRING description = Nome da origem comercial

}

]“


Listar faturas:

Entrada:

STRING customer_document_number = CPF/CNPJ do cliente


Saída:

STRING

“[

{

STRING document_number = CPF/CNPJ do cliente

STRING fatura = ID da fatura

STRING nome_cliente = Nome do cliente

STRING valor_inicial = Valor inicial da fatura

STRING valor_final = Valor final da fatura

STRING juros = Juros da fatura

STRING multa = Multa da fatura

STRING emissao = Data de emissão do boleto

STRING vencimento = Data de vencimento

STRING historico = ID ou nome do plano

STRING link_boleto = url do boleto (usa a função “Pegar pdf de um boleto“ se estiver vazio)

STRING linha_digitavel = Código da linha digitável, usado para criar o código de barra no boleto do totem

STRING code_fatura = Código da fatura no ERP

STRING identifier = Identificador de qual método pix utilizar, caso haja vários configurados

STRING remote_id = ID do boleto no ERP

STRING pix_code = Código do pix pra ser usado nesse boleto, usa o configurado no sistema se estiver vazio

}

]“

Pegar pdf de um boleto:

Entrada:

STRING boleto_id= ID do boleto no ERP


Saída:

STRING

“{

STRING base_64 = string contendo o pdf do boleto em formato de base64

}“

Pegar uma fatura pelo ID:

usado na listagem de boletos do totem

Entrada:

STRING customer_bill_id= ID do boleto no ERP

STRING customer_document_number = CPF/CNPJ do cliente

Saída:

“[

{

STRING document_number = CPF/CNPJ do cliente

STRING fatura = ID da fatura

STRING nome_cliente = Nome do cliente

STRING valor_inicial = Valor inicial da fatura

STRING valor_final = Valor final da fatura

STRING juros = Juros da fatura

STRING multa = Multa da fatura

STRING emissao = Data de emissão do boleto

STRING vencimento = Data de vencimento

STRING historico = ID ou nome do plano

STRING link_boleto = url do boleto (usa a função “Pegar pdf de um boleto“ se estiver vazio)

STRING linha_digitavel = Código da linha digitável, usado para criar o código de barra no boleto do totem

STRING code_fatura = Código da fatura no ERP

STRING identifier = Identificador de qual método pix utilizar, caso haja vários configurados

STRING remote_id = ID do boleto no ERP

STRING pix_code = Código do pix pra ser usado nesse boleto, usa o configurado no sistema se estiver vazio

}

]“

Baixa de boleto:

Entrada:

TRANSACTION transaction= Transação do boleto que foi pago

STRING boleto_id = ID do boleto que foi pago

STRING customer_document_number = CPF/CNPJ do cliente

Saída:

“{

BOOL success = Booleano falando se a baixa foi um sucesso ou não

STRING api_response = Resposta completa da api, independente se deu certo ou não

}“


Pegar contatos do cliente (email, celular):

Entrada:

STRING customer_document_number = CPF/CNPJ do cliente

Saída:

“[

{

STRING type = Tipo do contato, os valores podem ser "email" ou "phone"

STRING value = String contendo o contato do cliente

}

]“


Pegar texto para avaliar pendência interna:

Entrada:

STRING customer_document_number = CPF/CNPJ do cliente

Saída:

Lista de strings com cada mensagem de pendencia interna para ser avaliada

“[

“mensagem de pendencia interna“,

“outra mensagem de pendencia interna“

]“

  • Sem rótulos