Comparação de Páginas

...

{
    "nome_completo": "",            # Nome completo do cliente / razão social da empresa
    "aniversario": "",              # Data de aniversário do cliente
    "data_registro": "",            # Data de cadastro do cliente no ERP
    "ativo": "",                    # Cliente está ativo no ERP
    "id_remoto": "",                # ID do cliente dentro do ERP
    "id_contrato": "",              # ID do contrato do cliente
    "rua_endereco": "",             # Nome da rua do endereço do cliente
    "numero_endereco": "",          # Número da casa do endereço do cliente
    "cep_endereco": "",             # Cep do endereço do cliente
    "cidade_endereco": "",          # Cidade do endereço do cliente
    "complemento_endereco": "",     # Complemento do endereço do cliente
    "bairro_endereco": "",          # Bairro do endereço do cliente
    "estado_endereco": ""           # Estado do endereço do cliente
}

...

{
    "document": ""      # Documento do cliente (cpf/cnpj)
    "id_contrato": "",  # ID do contrato do cliente
}

{
    [
        {
          "id_fatura": "",        # ID utilizado para identificação e baixa de Fatura 
          "code_fatura": "",      # Valor composto pelo ID da fatura e docuemento do cliente  
          "nome_cliente": "",     # Nome do Cliente
          "document_number": "",  # Documento do cliente, o mesmo informado para obter as faturas
          "remote_id": "",        # Código do cliente no ERP
          "valor_inicial": "",    # Valor original do Boleto
          "valor_atual": "",      # Valor atualizado na data da Consulta
          "juros": "",            # Juros aplicado ao boleto na data de consulta
          "multa": "",            # Multa aplicado ao boleto na data de consulta
          "desconto": "",         # Desconto aplicado ao boleto na data de consulta
          "data_emissao": "",     # Data de emissão do Boleto
          "data_vencimento": "",  # Data de vencimento do Boleto
          "historico": "",        # Mensagem de referência da Fatura (ex. Mensalidade Plano X)
          "bank_code": "",        # Codigo que indica a qual banco pertence a fatura
          "linha_digitavel": "",  # Linha digitavel do Boleto
          "integration_id": "",   # Id da integraçõ ERP a qual o boleto pertence
          "identifier": "",       # Identificador de pagamento (Ex. Carteira de cobrança)
          "pix_code": "",         # Código PIX copia e cola de sistema de pagamento do ERP
          "contract_id": ""       # Id do contrado(s) a qual pertence a Fatura
          "bill_receipt": "",     # Cabeço de impressão gerado para o Totem (TEF)
          "bill_pix_receipt": "", # Cabeço de impressão gerado para o Totem (PIX)
        }
    ]
}

...

{
    "document": ""    # Documento do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do cliente no ERP
}

...

{
    "document": ""    # Documento do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do cliente no ERP
}

...

{
    "document": ""    # Documento do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do cliente no ERP
}

{
    [
        {
            "id_quitacao": "",    # ID da quitação de débito
            "ano": "",            # Ano referente a quitação de débito
            "valor": "",          # Valor total da quitação de débito
            "url_arquivo": ""     # URL do pdf da quitação de débito
        }
    ]
}

...

{
    "id_clientedocument": ""
}

    # Documento do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do cliente no ERP
}

{
    [
        {
            "id_instalacaoservico": "",           # ID do serviço "cep": "",no ERP
            "endereconome": "",              "numero": "",   # Nome do serviço
            "complementosituacao": "",             "bairro": "",
      # Situação do serviço no ERP (ativo, suspenso, etc.)
     "cidade       "obs": "",             "uf": "",    # Observações/comentários sobre o serviço
    "latitude": "",             "longitude"valor": "",             "obs": "",  # Valor do serviço
       "servicos": [    "numero_plano": "",         # Número/posição do {serviço        no ERP
            "id_servicoendereco": "",             # Endereço referente ao serviço do cliente
 "nome": "",       }
             "descricao": "",
                    "valor]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar todos os produtos (GET):

Request utilizada para listar todos os produtos disponíveis no sistema. Isso é utilizado para mapear o produto do eCommerce, assim o prospecto/lead já é criado com um vínculo aos produtos

{}

{
    [
        {
            "id_servico": "",   # ID do produto/serviço no ERP
            "statusnome": "",         # Nome de apresentação do produto
            "obsdescricao": "",    # Descrição do produto
         }   "valor": "",        # ]Valor do produto
      }     ]
} "obs": ""           # Observações
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar todos os

...

revendedores (GET):

Request utilizada para listar todos os produtos disponíveis no sistema. revendedores, Isso é utilizado para mapear o produto do os revendedores no eCommerce, assim o prospecto/lead já é criado com um vínculo aos produtosas vendas dos mesmos podem ser vinculados a eles nos relatórios e os prospectos/leads já são criados com o vínculo do revendedor que realizou a venda/captação

{}

{
    [
        {
            "id_revendedor": "",  # ID do revendedor no ERP
            "nome": "",           # Nome do revendedor
            "documento": "",      # Documento do revendedor (CPF/CNPJ)
            "email": "",          # Email do revendedor
            "obs": ""             # Observações
        }
    ]
}

Estado
title APP

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Pegar todos os funcionários (GET):

Request utilizada para listar todos os funcionários, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um funcionário

{}

{
    [
        {
            "id_funcionario": "",   # ID do funcionário no ERP
            "nome": "",             # Nome do funcionário
            "obs": ""               # Observações
        }
    ]
}

Estado
title APP

Pegar todos os departamentos (GET):

Request utilizada para listar todos os departamentos, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um departamento

{}

{
    [
        {
            "id_departamento": "",    # ID do departamento no ERP
            "nome": "",               # Nome do departamento
            "obs": ""                 # Observações
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Pegar todos os vencimentos (GET):

Request utilizada para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente

{}

{
    [
        {
            "id_vencimento": "",    # ID do vencimento no ERP
            "data": "",             # "Nome" da data de vencimento (Exemplo: "dia 5")
            "obs": ""               # Observações
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar as origens comerciais (GET):

Request utilizada para listar as origens comerciais, isso é utilizado para que os prospectos sejam criados com a origem comercial vinculada corretamente. (Ex. Google, Outdoor, Indicação de Amigo, Anúncio de Rádio)

{}

{
    [
        {
            "id_origem": "",    # ID da origem comercial no ERP
            "nome": "",         # Nome da origem comercial
            "obs": ""           # Observações
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar todas as cidades (GET):

Request utilizada para listar as cidades cadastradas no sistema, isso é utilizado pois muitos sistemas utilizam um código proprietário para a cidade. assim os prospectos são criados com a cidade vinculada corretamente.

{}

{
    [
        {
            "id_cidade": "",    # ID da cidade no ERP
            "nome": "",         # Nome da cidade no ERP
            "latitude": "",     # Latitude da cidade
            "longitude": "",    # Longitude da cidade
            "obs": ""           # Observações
        }
    ]
}

Estado
title APP

Pegar todos os tipos de atendimentos (GET):

Request utilizada para listar todos os tipos de atendimentos, Isso é utilizado para que os atendimentos criados pelo eCommerce/App caiam no sistema com o tipo correto

{}

{
    [
        {
            "id_tipo_de_atendimento": "",   # ID do tipo de atendimento no ERP
            "nome": "",                     # Nome do tipo de atendimento no ERP
            "obs": ""                       # Observações
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Pegar todos os status de prospectos (GET):

Request utilizada para listar os status de prospectos, isso é utilizado para classificar os prospectos conformes eles são criados e para atualizar os prospectos durante a automação. (Ex. Inicial, Em analise, Reprovado, Suspenso, Aprovado, Cancelado)

{}

{
    [
        {
            "status_prospeccao": "",    # Código do status no ERP
            "nome": "",                 # Nome do status no ERP
            "obs": ""                   # Observações
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Criar prospectos (POST):

Request utilizada para a criação de uma prospecção no sistema, esse é o principal canal de entrada de novas assinaturas.

Se for necessário o EPR deve informar todos APIs necessárias para criar um pedido no sistema integrado com o maior numero das informações possível.

Se for o caso pode-se fracionar o em varias APIs para chegar ao resultado final, exemplo: API para cadastro de Prospecto/Cliente, API para cadastro de endereço, APi para upload de arquivos no prospecto, etc.

{
    "nome": "",                     # Nome do Cliente ou Responsavel pela Empresa
    "razão_social": "",             # Razão do social para clientes PJ (Opcional)
    "tipo_pessoa": "",              # Tipo da pessoa, Física ou Juridica
    "cnpj_cpf": "",                 # CPF ou CNPJ do cliente
    "ie_identidade": "",            # Inscrição Estadual parra clientes PJ (Opcional)
    "data_nascimento": "",          # Data de nascimento do cliente ou do responsável
    "id_revendedor": "",            # Id do revendedor
    "id_origem": "",            {    # Id da Origem comercial
    "id_servicovencimento": "",            # Id do Vencimento no ERP
    "cep": "",                      # CEP do cliente
    "nomeendereco_instalação": "",      # Logradouro do endereço de instalação
 "descricao   "numero_instalação": "",,        # Numero do endereço de instalação
    "valorbairro_instalação": "",        # Bairro do endereço de instalação
"obs    "cidade_instalação": "",         }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar todos os revendedores (GET):

Request utilizada para listar todos os revendedores, Isso é utilizado para mapear os revendedores no eCommerce, assim as vendas dos mesmos podem ser vinculados a eles nos relatórios e os prospectos/leads já são criados com o vínculo do revendedor que realizou a venda/captação

{}

{
    [
        {
       # Cidade do endereço de instalação
    "complemento_instalação": "",   # Complemento do endereço de instalação
    "referencia_instalação": "",    # Referencia do endereço de instalação
    "iduf_revendedorinstalação": "",            # "nome": "",
  Estado do endereço de instalação
         "obs"endereco_cobranca": "",        # Logradouro }do endereço de cobrança
   ]
}

Estado
title APP

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Pegar todos os funcionários (GET):

Request utilizada para listar todos os funcionários, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um funcionário

{}

{
    [
  "numero_cobranca": "",          # Numero do endereço de cobrança
    "bairro_cobranca": "",       {   # Bairro do endereço de cobrança
    "idcidade_funcionariocobranca": "",          # Cidade do endereço de "nomecobrança
    "complemento_cobranca": "",     # Complemento do endereço de cobrança
    "obsreferencia_cobranca": "",      # Referencia do endereço }de cobrança
   ]
}

Estado
title APP

Pegar todos os departamentos (GET):

Request utilizada para listar todos os departamentos, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um departamento

{}

{
    [ "uf_cobranca": "",           {   # Estado do endereço de cobrança
    "id_departamentolatitude": "",
            "nome": "",    # Latitude da instalação
     "obslongitude": "",          }
      # Longitude da instalação
   ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Pegar todos os vencimentos (GET):

Request utilizada para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente

{}

{
    [ "telefone": "",                 # Telefone residencial
    "celular": "",           {       # Celular
    "idcelular_vencimentoextra": "",            # Celular extra (geralmente whatsapp)
    "dataemail": "",                    # Email
    "obs": "",           }         ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar as origens comerciais (GET):

Request utilizada para listar as origens comerciais, isso é utilizado para que os prospectos sejam criados com a origem comercial vinculada corretamente. (Ex. Google, Outdoor, Indicação de Amigo, Anúncio de Rádio)

{}

{
     # Resumo de todas as informações do pedido
    "servicos": [                   # Array serviços contratados/interesse
        {
            "id_origem": "",servico"            # ID do serviço no ERP
        }
   "nome": "", ],         
    "obsanexos": ""[         }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar todas as cidades (GET):

Request utilizada para listar as cidades cadastradas no sistema, isso é utilizado pois muitos sistemas utilizam um código proprietário para a cidade. assim os prospectos são criados com a cidade vinculada corretamente.

{}

{
    [          # Array de anexos dos documentos anexados ao pedido
        {
            "idnome_cidadedocumento": "",   # Nome do documento
            "nomeformato": "",          # Formato do arquivo
            "",
      base_64" ""    	    # Conteúdo do arquivo em base 64
     "latitude": "",  }
    ]
}

{
    "longitudeid_prospecto": "",      # Id do Prospecto retornado do ERP
    "obs": ""           }     #  ]Observação ou menssagem do ERP
}

Estado
colour Red title

...

Request utilizada para listar todos os tipos de atendimentos, Isso é utilizado para que os atendimentos criados pelo eCommerce/App sejam do tipo correto utilizado

...

...

...

LEAD

Estado
colour Yellow title TOTEM

Criar lead (POST):

Request utilizada para a criação de um lead no sistema, esse é como você irá registrar clientes que tem a intenção de assinar no futuro ou que ainda não estão cobertos pelos seus serviços/produtos.

Dados podem varia conforme formulário do pre-checkout

{
    [
        {
            "id_tipo_de_atendimento "nome": "",           # Nome do cliente
    "nomedocumento": "",      # Documento do cliente
    "obsemail": "",         } # Email do cliente
  ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Pegar todos os status de prospectos (GET):

Request utilizada para listar os status de prospectos, isso é utilizado para classificar os prospectos conformes eles são criados e para atualizar os prospectos durante a automação. (Ex. Inicial, Em analise, Reprovado, Suspenso, Aprovado, Cancelado)

{}

{
    [
        {
         "telefone": "",       # Telefone do cliente
    "endereco": "",       # Logradouro do endereço de instalação
    "status_prospeccaonumero": "",         # Numero do endereço "nomede instalação
    "bairro": "",         # Bairro do endereço de instalação
    "obscidade": "",         }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Yellow title TOTEM

Criar prospectos (POST):

Request utilizada para a criação de uma prospecção no sistema, esse é o principal canal de entrada de novas assinaturas.

Se for necessário o EPR deve informar todos APIs necessárias para criar um pedido no sistema integrado com o maior numero das informações possível.

Se for o caso pode-se fracionar o em varias APIs para chegar ao resultado final, exemplo: API para cadastro de Prospecto/Cliente, API para cadastro de endereço, APi para upload de arquivos no prospecto, etc.

{# Cidade do endereço de instalação
    "estado": "",         # Estado do endereço de instalação
    "CEP": "",            # CEP do endereço de instalação
    "nomecobertura": "",      # JSON com dados da Cobertura
   # Nome do Cliente ou Responsavel pela Empresa "latitude": "",       # Latitude da instalação
    "razão_sociallongitude": "",      # Razão do social para clientes PJ (Opcioanl) Longitude da instalação
    "revendedor": "",     # Nome do revendedor
    "tipoid_pessoarevendedor": "",  # ID do  # Pessoa Física ou Juridicarevendedor no ERP
    "cnpjextra_cpfdata": "",      # Dados extras #do CPF ou CNPJlead
}

{
     "ieid_identidadelead": "",  # ID # Inscrição Estadualdo lead retornado do ERP
    "data_nascimentoobs": "",   # Data de nascimento do# clienteObservação ou menssagem do responsável
    "id_revendedor": "",    # Id revendedor
    "id_origemERP
}

Estado
title APP

Criar atendimento (POST):

Request utilizada para criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64

{
    "id_cliente": "",        # Id Origem comercial     "id_vencimento": "",    # IdID do Vencimentocliente no ERP
    "cepid_servico": "",              # CEP do cliente# ID do serviço do "endereco": "", cliente no ERP
       # Logradouro
    "numero"id_tipo_de_atendimento": "",     # ID do tipo de atendimento escolhido pelo cliente #no NumeroERP
    "bairroid_departamento": "",            # BairroID do departamento escolhido pelo cliente no ERP
    "cidadeid_funcionario": "",             # Cidade ID do funcionário responsável no ERP
    "complementoemail": "",       #  Complemento     "referencia": "",       # Email do Referenciacliente
    "uftelefone": "",                   # Telefone do Estadocliente
    "latitudeassunto": "",            # Latitude     "longitude": "", # Assunto do chamado que o cliente #esta Longitudeabrindo
    "telefonemensagem": "",         # Telefone Principal     "celular": "",  # Mensagem do chamado que o cliente esta #abrindo
Telefone Secundario     "celular_extraanexo": "",[    # Whats APP     "email": "",            # EmailAnexos enviados pelo cliente  "obs": "",  (se a opção estiver liberada)
        {
  # Resumo de todas as informa     "servicosanexo": [        "",   # Array serviços contratados/interesse        # {Conteúdo do arquivo em base 64
       "id_serviços"     "obs": "",   }     ],        # Observação do anexo
  "anexos": [         "nome_anexo": ""   # Array de anexos dos documentos anexados ao# pedidoNome do anexo
      {  }
    ]
}

{
    "nomeid_documentoatendiemnto": "",   # ID do lead retornado do ERP
    "formatoobs": "",             "base_64" ""         }# Observação ou menssagem do ]ERP
}

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Habilitação provisória (POST):

Request utilizada para habilitar provisoriamente um serviço suspenso geralmente por falta de pagamento. também conhecido como ativação de confiança

{
    "id_prospecto": "",      # Id do Prospecto retornado do ERP
    "obsid_cliente": "",   # ID do cliente no ERP
    "id_servico": "",   # ObservaçãoID odo menssagemserviço do ERP
}

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Criar lead (POST):

Request utilizada para a criação de um lead no sistema, esse é como você irá registrar clientes que tem a intenção de assinar no futuro ou que ainda não estão cobertos pelos seus serviços/produtos.

...

cliente no ERP
}

{
    "nomestatus": "",   # Status do serviço após a chamada de ativação (se foi ativo #ou Nome
    "taxvat": "",             # Documento
    "emailnão)
}

Estado
colour Purple title Prospecto

Estado
colour Yellow title TOTEM

Edição do prospecto (PUT):

Request utilizada para atualizar uma prospecção conforme a automação acontece. Nem todos os campos são necessariamente editados/atualizados

{
    "id_prospecto": "",              # EmailID do prospecto no ERP
"phone": "",              # Telefone
    "address"status_prospeccao": "",            # LogradouroID do status do prospecto "number": "",             # Numerono ERP
    "neighborhoodid_revendedor": "",          # Bairro ID do revendedor do ERP
    "cityobs": "",               # Cidade     # Observações
}

{
    "statestatus": "",   # Status atual do prospecto        # Estadono ERP
}

Estado
title APP

Edição do cliente (PUT):

Request utilizada para atualizar as informações de um cliente. Geralmente atualiza-se apenas as informações de contato (email, telefone, WhatsApp)

{
    "postalid_codecliente": "",        # CEP     "coverage": "",           # JSONID comdo dadoscliente dano CoberturaERP
    "latitudenome": "",           # Latitude     "longitude": "",          # LongitudeNome do cliente   "reseller": "",           # Revendedorno ERP
    "extra_datafantasia": "",               # Dados
}

{ Nome fantasia do cliente para empresa
    "idtipo_leadpessoa": "",            # "obs": ""
}

Estado
title APP

Criar atendimento (POST):

Request utilizada para criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64

{Tipo da pessoa, Física ou Juridica
    "idcnpj_clientecpf": "id_cliente",        "id_servico       # CPF ou CNPJ do cliente
    "ie_identidade": "id_servico",",          # Inscrição Estadual parra clientes PJ (Opcional)
    "idrg_tipoorgao_de_atendimentoemissor": "id_tipo_de_atendimento",",       # 
    "idinscricao_departamentomunicipal": "id_departamento",    # 
    "idcontribuinte_funcionarioicms": "id_funcionario",     "email": "", # 
    "telefonenacionalidade": "",     "assunto": "",     # 
    "mensagemcidade_naturalidade": "",     "obs": "",# 
    "alertaestado_nascimento": "",     "anexo": [# 
    "data_nascimento": "",  {      # 
    "estado_civil": "anexo": B64_DO_ARQUIVO,,           # 
    "obsativo": "",                  # 
    "nome_anexoSexo": "",         }     ] }

{     "id_atendiemnto": "",
    "obs": ""
}

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Habilitação provisória (POST):

Request utilizada para habilitar provisoriamente um serviço suspenso geralmente por falta de pagamento. também conhecido como ativação de confiança

{# 
    "profissao": "",              # 
    "iddata_clientecadastro": "id_cliente",     "id_servico     # 
    "cep": "id_servico",
}

{                    # 
    "statusendereco": "",
}

Estado
colour Purple title Prospecto

Estado
colour Yellow title TOTEM

Edição do prospecto (PUT):

Request utilizada para atualizar uma prospecção conforme a automação acontece. Nem todos os campos são necessariamente editados/atualizados

{        "id_prospecto": "",     "status_prospeccao": "status_prospeccao", # 
    "id_revendedornumero": "id_revendedor",          "obs": "",     "alerta": "",
}

{ # 
    "statuscomplemento": "",
}

Estado
title APP

Edição do cliente (PUT):

Request utilizada para atualizar as informações de um cliente. Geralmente atualiza-se apenas as informações de contato (email, telefone, WhatsApp)

{            # 
    "id_clientebairro": "",     "nome            # 
    "cidade": "",     "fantasia            # 
    "uf": "",       "tipo_pessoa": "",              "cnpj_cpf": "",# 
    "ie_identidadelatitude": "",       "rg_orgao_emissor": "",        "inscricao_municipal": "",# 
    "contribuinte_icmslongitude": "N",       "nacionalidade": "",       "cidade_naturalidade": "",# 
    "estado_nascimentofone": "",       "data_nascimento": "",     "estado_civil": "",     "ativo": "",# 
    "Sexotelefone_comercial": "",     "profissao": "",# 
    "datatelefone_cadastrocelular": "",       "cep": "",# 
    "enderecowhatsapp": "",       "numero": "",        "complemento": "",# 
    "bairroemail": "",      "cidade": "",     "uf": "",     "latitude": "",# 
    "longitudeobs": "",       "fone": "",       "telefone_comercial": "",     "telefone_celular": "",# 
    "whatsappalerta": "",      "email": "",     "obs": "",     "alerta": ""# 
}

{
    "status": "",
}

...