⚙ 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
...
Cada função tem determinadas informações que podem ser usadas nas ações, as funcionalidades disponíveis, assim como informações de cada função são as seguintes:
Criação de pedido:
...
...
order = Pedido feito pelo cliente message = |
...
...
inforrmações do pedido, geralmente usado num campo de observações |
...
...
...
...
...
...
“{
...
{
"remote_id" = ""
"remote_message" = ""
"is_issue" = False
} |
remote_id = ID do pedido |
...
dentro do ERP remote_message = Resposta da API ou None is_issue = |
...
Pedido foi aberto como chamado ou não |
...
Este método é chamado quando um pedido é criado dentro do sistema e o cliente não é usuário do erp, ou ele é cliente do erp e a configuração Procedimento para Pedidos Migração esta em Criar Pedido/Prospecto
Criação de pedido para cliente já existente:
...
|
order= Pedido feito pelo cliente message= Mensagem com informações do pedido, geralmente usado num campo de observações customer_document_number = CPF/CNPJ do cliente wda_user = Usuário do cliente |
...
...
...
...
...
...
...
remote_id = ID do pedido no ERP |
...
Este método é chamado quando um pedido é criado dentro do sistema e o cliente já é usuário do erp, e a configuração Procedimento para Pedidos Migração esta em Criar Chamado/Atendimento
Criação de lead:
...
...
= Informações do lead gerado |
...
Este método é chamado quando um lead é gerado durante o checkout para criar um lead dentro do ERP
Listar revendedores:
...
...
...
...
...
...
...
...
...
{
"code" = ""
"name" = ""
"taxvat" = ""
"email" = ""
}
] |
code = ID do revendedor no ERP name = Nome do revendedor taxvat = CPF/CNPJ do revendedor email = Email do revendedor |
}
...
Este método é chamado quando se abre a página para configurar um revendedor, ele é usado para associar um revendedor no sistema datacake com o ERP
Listar produtos:
...
...
...
...
...
...
...
...
...
{
"codigo" = ""
"nome" = ""
}
] |
codigo = ID do produto no ERP nome = Nome do produto |
}
...
Este método é chamado quando se abre a página para configurar um produto, ele é usado para associar um produto no sistema datacake com o ERP
Listar datas de vencimento:
...
...
...
...
...
...
...
...
...
{
"code" = ""
"name" = ""
}
] |
code = ID da data de vencimento no ERP name = Dia do vencimento |
}
]“
Este método é chamado quando se abre a página para configurar um vencimento de fatura, ele é usado para associar uma data de vencimento no sistema datacake com o ERP
Listar origens comerciais:
...
...
...
...
...
...
...
...
...
{
"code" = ""
"description" = ""
}
] |
code = ID da origem comercial no ERP description = Nome da origem comercial |
Este método é chamado quando se abre a página para configurar uma origem comercial, ele é usado para associar uma origem comercial no sistema datacake com o ERP
...
Listar faturas:
| Expandir |
|---|
|
customer_document_number = CPF/CNPJ do cliente contract_id= ID do contrato (opcional) |
| Expandir |
|---|
|
| Bloco de código |
|---|
| [
{
"document_number" = ""
"fatura" = ""
"nome_cliente" = ""
"valor_inicial" = ""
"valor_final" = ""
"juros" = ""
"multa" = ""
"emissao" = ""
"vencimento" = ""
"historico" = ""
"link_boleto" = ""
"linha_digitavel" = ""
"code_fatura" = ""
"identifier" = ""
"remote_id" = ""
"pix_code" = ""
} |
|
...
]“
...
document_number = CPF/CNPJ do cliente fatura = ID da fatura nome_cliente = Nome do cliente valor_inicial = Valor inicial da fatura valor_final = Valor final da fatura juros = Juros da fatura multa = Multa da fatura emissao = Data de emissão do boleto vencimento = Data de vencimento historico = ID ou nome do plano link_boleto = url do boleto (usa a função “Pegar pdf de um boleto“ se estiver vazio) linha_digitavel = Código da linha digitável, usado para criar o código de barra no boleto do totem code_fatura = Código da fatura no ERP identifier = Identificador de qual método pix utilizar, caso haja vários configurados remote_id = ID do boleto no ERP pix_code = Código do pix pra ser usado nesse boleto, usa o configurado no sistema se estiver vazio |
Este método é chamado nas listagem de boleto, tanto do site, quanto do app e do totem, deve retornar as faturas do cliente no ERP
Pegar pdf de um boleto:
| Expandir |
|---|
|
boleto_id= ID do boleto no ERP |
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"base_64" = ""
} |
base_64 = string contendo o pdf do boleto em formato de base64 |
Este método é chamado quando o cliente quer acessar o pdf de uma fatura e o campo link_boleto da fatura veio vazio, tanto do site, quanto do app e do totem, o aplicativo pode exigir esse método por questões de segurança para não acessar um link fora do sistema.
Pegar uma fatura pelo ID:
| Expandir |
|---|
|
customer_bill_id= ID do boleto no ERP customer_document_number = CPF/CNPJ do cliente |
| Expandir |
|---|
|
| Bloco de código |
|---|
| [
{
"document_number" = ""
"fatura" = ""
"nome_cliente" = ""
"valor_inicial" = ""
"valor_final" = ""
"juros" = ""
"multa" = ""
"emissao" = ""
"vencimento" = ""
"historico" = ""
"link_boleto" = ""
"linha_digitavel" = ""
"code_fatura" = ""
"identifier" = ""
"remote_id" = ""
"pix_code" = ""
}
] |
document_number = CPF/CNPJ do cliente fatura = ID da fatura nome_cliente = Nome do cliente valor_inicial = Valor inicial da fatura valor_final = Valor final da fatura juros = Juros da fatura multa = Multa da fatura emissao = Data de emissão do boleto vencimento = Data de vencimento historico = ID ou nome do plano link_boleto = url do boleto (usa a função “Pegar pdf de um boleto“ se estiver vazio) linha_digitavel = Código da linha digitável, usado para criar o código de barra no boleto do totem code_fatura = Código da fatura no ERP identifier = Identificador de qual método pix utilizar, caso haja vários configurados remote_id = ID do boleto no ERP pix_code = Código do pix pra ser usado nesse boleto, usa o configurado no sistema se estiver vazio |
Este método é usado na listagem de faturas do totem e na baixa de fatura, funciona de forma similar ao Listar faturas, porém deve retornar apenas a fatura que o id é igual ao customer_bill_id
Baixa de boleto:
| Expandir |
|---|
|
| Estado |
|---|
| colour | Purple |
|---|
| title | Transaction |
|---|
|
transaction= Transação do boleto que foi pago boleto_id = ID do boleto que foi pago customer_document_number = CPF/CNPJ do cliente |
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"success" = Booleano falando se a baixa foi um sucesso ou não
"api_response" = Resposta completa da api, independente se deu certo ou não
} |
success = Booleano falando se a baixa foi um sucesso ou não api_response = Resposta completa da api, independente se deu certo ou não |
Este método é chamado quando uma fatura é paga pelo sistema (pix se ele foi integrado com o banco e TEF), usado para dar baixa em uma fatura dentro do erp
...
Pegar contatos do cliente (email, celular):
| Expandir |
|---|
|
customer_document_number = CPF/CNPJ do cliente |
| Expandir |
|---|
|
| Bloco de código |
|---|
| [
{
type = ""
value = ""
}
] |
type = Tipo do contato, os valores podem ser "email" ou "phone" value = String contendo o contato do cliente |
Este método é chamado para compartilhar faturas, criar conta no app e alguns outros pontos que precisam do contato do cliente, ele deve retornar os contatos (email, celular) do cliente do ERP
...
Pegar texto para avaliar pendência interna:
| Expandir |
|---|
|
customer_document_number = CPF/CNPJ do cliente |
| Expandir |
|---|
|
| Bloco de código |
|---|
| [
“mensagem de pendencia interna“,
“outra mensagem de pendencia interna“
] |
|
Este método é chamado para fazer a validação de pendência interna do cliente dentro do ERP, ele deve retornar as mensagens que vão ser avalidadas para saber se aquele cliente já tem uma pendência com o provedor, caso o cliente não esteja no ERP ou não tenha pendencias com o provedor esse método deve retornar uma lista vazia