Comparação de Páginas

Índice

minLevel	1
maxLevel	7

⚙ 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

...

Expandir

title	Entrada

Estado

colour	Purple
title	order

order = Pedido feito pelo cliente

Estado

colour	Yellow
title	string

message = mensagem com inforrmações do pedido, geralmente usado num campo de observações

Expandir

title	Saída

Bloco de código

language	json

{
  "remote_id" = ""
  "remote_message" = ""
  "is_issue" = False
}

Estado

colour	Yellow
title	string

remote_id = ID do pedido dentro do ERP

Estado

colour	Yellow
title	string

remote_message = Resposta da API ou None

Estado

colour	Yellow
title	bool

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:

Expandir

title	Entrada

Estado

colour	Purple
title	Order

order= Pedido feito pelo cliente

Estado

colour	Yellow
title	string

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

Estado

colour	Yellow
title	string

customer_document_number = CPF/CNPJ do cliente

Estado

colour	Purple
title	User

wda_user = Usuário do cliente

Expandir

title	Saída

Bloco de código

language	json

{
  "remote_id" = ""
}

Estado

colour	Yellow
title	String

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:

Expandir

title	Entrada

Estado

colour	Purple
title	Lead

lead= Informações do lead gerado

Expandir

title	Saída

N/A

Este método é chamado quando um lead é gerado durante o checkout para criar um lead dentro do ERP

Listar revendedores:

Expandir

title	Entrada

N/A

Expandir

title	Saída

Bloco de código

language	json

[
  {
    "code" = ""
    "name" = ""
    "taxvat" = ""
    "email" = ""
  }
]

Estado

colour	Yellow
title	String

code = ID do revendedor no ERP

Estado

colour	Yellow
title	String

name = Nome do revendedor

Estado

colour	Yellow
title	String

taxvat = CPF/CNPJ do revendedor

Estado

colour	Yellow
title	String

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:

Expandir

title	Entrada

N/A

Expandir

title	Saída

Bloco de código

language	json

[
  {
    "codigo" = ""
    "nome" = ""
  }
]

Estado

colour	Yellow
title	String

codigo = ID do produto no ERP

Estado

colour	Yellow
title	String

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:

Expandir

title	Entrada

N/A

Expandir

title	Saída

Bloco de código

language	json

[
  {
    "code" = ""
    "name" = ""
  }
]

Estado

colour	Yellow
title	String

code = ID da data de vencimento no ERP

Estado

colour	Yellow
title	String

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:

Expandir

title	Entrada

N/A

Expandir

title	Saída

Bloco de código

language	json

[
  {
    "code" = ""
    "description" = ""
  }
]

Estado

colour	Yellow
title	String

code = ID da origem comercial no ERP

Estado

colour	Yellow
title	String

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

title	Entrada

Estado

colour	Yellow
title	string

customer_document_number = CPF/CNPJ do cliente

Estado

colour	Yellow
title	string

contract_id= ID do contrato (opcional)

Expandir

title	Saída

Bloco de código

language	json

[
  {
    "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" = ""
  }
]

Estado

colour	Yellow
title	String

document_number = CPF/CNPJ do cliente

Estado

colour	Yellow
title	String

fatura = ID da fatura

Estado

colour	Yellow
title	String

nome_cliente = Nome do cliente

Estado

colour	Yellow
title	String

valor_inicial = Valor inicial da fatura

Estado

colour	Yellow
title	String

valor_final = Valor final da fatura

Estado

colour	Yellow
title	String

juros = Juros da fatura

Estado

colour	Yellow
title	String

multa = Multa da fatura

Estado

colour	Yellow
title	string

emissao = Data de emissão do boleto

Estado

colour	Yellow
title	String

vencimento = Data de vencimento

Estado

colour	Yellow
title	String

historico = ID ou nome do plano

Estado

colour	Yellow
title	String

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

Estado

colour	Yellow
title	String

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

Estado

colour	Yellow
title	String

code_fatura = Código da fatura no ERP

Estado

colour	Yellow
title	String

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

Estado

colour	Yellow
title	String

remote_id = ID do boleto no ERP

Estado

colour	Yellow
title	String

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

title	Entrada

Estado

colour	Yellow
title	string

boleto_id= ID do boleto no ERP

Expandir

title	Saída

Bloco de código

language	json

{
  "base_64" = ""
}

Estado

colour	Yellow
title	String

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:

...

Este método é usado na listagem de boletos do totemfaturas 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

title	Entrada

Estado

colour	Purple
title	Transaction

transaction= Transação do boleto que foi pago

Estado

colour	Yellow
title	string

boleto_id = ID do boleto que foi pago

Estado

colour	Yellow
title	string

customer_document_number = CPF/CNPJ do cliente

Expandir

title	Saída

Bloco de código

language	json

{
  "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
}

Estado

colour	Yellow
title	bool

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

Estado

colour	Yellow
title	String

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

title	Entrada

Estado

colour	Yellow
title	string

customer_document_number = CPF/CNPJ do cliente

Expandir

title	Saída

Bloco de código

language	json

[
  {
    type = ""
    value = ""
  }
]

Estado

colour	Yellow
title	STRING

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

Estado

colour	Yellow
title	String

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

title	Entrada

Estado

colour	Yellow
title	string

customer_document_number = CPF/CNPJ do cliente

Expandir

title	Saída

Bloco de código

language	json

[
  “mensagem de pendencia interna“,
  “outra mensagem de pendencia interna“
]

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

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

Versões comparadas

Versão antiga 9

Nova versão 10

Chave

⚙ Funcionalidades:

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

Criação de lead:

Listar revendedores:

Listar produtos:

Listar datas de vencimento:

Listar origens comerciais:

Listar faturas:

Pegar pdf de um boleto:

Pegar uma fatura pelo ID:

Baixa de boleto:

Pegar contatos do cliente (email, celular):

Pegar texto para avaliar pendência interna: