Comparação de Páginas

...

{
  "cnpj_cpf": ""  # Documento do cliente (cpf/cnpj)
}

{
    "idnome_clientecompleto": "",     "nome": "",     "fantasia": "",
    "tipo_pessoa": "",
    "cnpj_cpf": "",
    "ie_identidade # Nome completo do cliente / razão social da empresa
    "aniversario": "",     "rg_orgao_emissor": "",     "inscricao_municipal": "",  # Data  "contribuinte_icms": "N",de aniversário do cliente
    "nacionalidadedata_registro": "",     "cidade_naturalidade": "",       "estado_nascimento": "",
    "data_nascimento": "",# Data de cadastro do cliente no ERP
    "estado_civilativo": "",     "ativo": "",     "Sexo": "",     "profissao": "",  # Cliente  "data_cadastro": "",está ativo no ERP
    "cepid_remoto": "",     "endereco": "",          "numero": "",
    "complemento": "", # ID do cliente dentro do ERP
    "bairrorua_endereco": "",       "cidade": "",     "uf": "",
    "latitude": "",# Nome da rua do endereço do cliente
    "longitudenumero_endereco": "",     "fone": "",    # "telefone_comercialNúmero da casa do endereço do cliente
    "cep_endereco": "",             # Cep do endereço do cliente
    "telefonecidade_celularendereco": "",        "whatsapp": "", # Cidade do endereço "email": "",do cliente
    "obscomplemento_endereco": "",     "alerta": ""
}

...

# Complemento do endereço do cliente
    "bairro_endereco": "",          # Bairro do endereço do cliente
    "estado_endereco": ""           # Estado do endereço do cliente
}

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Pegar boletos abertos/faturas (GET):

...

{
    "document": ""
}

  # Documento do cliente (cpf/cnpj)
}

{
    [
        {
          "id_fatura": "",        # ID utilizado para  "nome_cliente": "", identificação e baixa de Fatura 
          "valorcode_inicialfatura": "",      # Valor composto pelo ID da fatura e  "valor_atual": "",docuemento do cliente  
          "datanome_emissaocliente": "",     # Nome do Cliente
    "data_vencimento      "document_number": "",  # Documento do cliente, o mesmo informado para obter as faturas
 "linha_digitavel         "remote_id": "",        # Código do cliente no "juros": "",
ERP
          "multavalor_inicial": "",    # Valor original     "desconto": "",do Boleto
          "codigovalor_faturaatual": "",      # Valor atualizado na data "historico": "",da Consulta
          "bank_codejuros": "",             "document_number": "",
     # Juros aplicado ao boleto na data de consulta
    "remote_id      "multa": "",           "integration_id": "", # Multa aplicado ao boleto na data de consulta
          "identifierdesconto": "",         # Desconto aplicado ao boleto na  "pix_code": "",data de consulta
          "billdata_receiptemissao": "",     # Data de emissão   "bill_pix_receipt": "",do Boleto
          "contractdata_idvencimento": "",  # Data de vencimento do   }Boleto
    ] }

Estado
title APP

Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas para um cliente

{     "id_clientehistorico": ""
}

{,      [  # Mensagem de referência da Fatura (ex. {Mensalidade Plano X)
          "idbank_notacode": "",        # Codigo que indica a qual banco "status": "", pertence a fatura
             "valor"linha_digitavel": "",  # Linha digitavel do Boleto
          "valorintegration_pagoid": "",   # Id da integraçõ ERP a qual o boleto pertence
          "data_lancamentoidentifier": "",       # Identificador de pagamento (Ex. Carteira de  "data_vencimento": "",  
  cobrança)
          "datapix_baixacode": "",         # Código PIX copia e  "url_nota_fiscal": "",  
 cola de sistema de pagamento do ERP
      }
    ]
}

Estado
title APP

Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros de um cliente

{     "contract_id_cliente": "" }

{     [ # Id do contrado(s) a qual pertence a {Fatura
            "idbill_extrato_financeiroreceipt": "",     # Cabeço de impressão gerado para o    "data_lancamento": "",
 Totem (TEF)
          "databill_pix_vencimentoreceipt": "", # Cabeço de impressão gerado para o Totem (PIX)
     "data_baixa": "",  }
            "id_boleto": "",]
}

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Pegar Contratos do Cliente (GET):

Request utilizado para listar o contratos do cliente. Utilizado para listar os boletos por contrato. Para pleno funcionamento, ID do contrato deverá ser enviado junto ao response que lista fatura abertas.

{
    "document": ""  # Documento do cliente  "id_nota": "",
     (cpf/cnpj)
}

{
      "valorremote_id": "",      # Id do Contrato no ERP.  "valor_pago": "",
 Utilizado para filtrar o boletos
          "multa"contract_name": "",   # Endereço da        "jurosinstalação
}

Estado
title APP

Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas para um cliente

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

{
    "obs": ""[
        {
}     ]
}

Estado
title APP

Pegar declaração de quitação de débitos (GET):

Request utilizada para listar as declarações de quitação de débito de um cliente

{       "id_clientenota": ""
}

{,            [  # ID da nota fiscal dentro do {ERP
            "id_tipo_quitacao"nota: "",          # ID do tipo da nota fiscal dentro do ERP
"ano            "numero_nota": "",          # Número da nota fiscal
            "valor": "",                # Valor da nota fiscal
  "url_arquivo          "protocolo": "",         }
     # Protocolo da nota fiscal
  ]
}

Estado
title APP

Pegar instalações/produtos de um cliente (GET):

Request para listar todos os produtos/instalações/serviços de um cliente

{          "iddata_clientelancamento": ""
}

{,      # [Data que a nota foi lançada no ERP  {
            "id_instalacaoidentificacao": "",        # Identificação da nota fiscal
  "cep": "",
            "enderecourl_nota_fiscal": "",      # Url do pdf da nota  "numero": "",
 fiscal 
        }
    ]
}

Estado
title APP

Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros de um cliente

{
    "complementodocument": "",  # Documento do cliente (cpf/cnpj)
      "bairroid_cliente": "",  # ID do cliente no ERP
}

{
    [
       "cidade": "", {
            "ufid_nota": "",                  # ID "latitude": "",da fatura
            "longitudedata_lancamento": "",          # Data de lançamento "obs": "",da fatura
            "servicosdata_vencimento": ["",          # Data de vencimento da   {
fatura
                   "id_servico"data_baixa": "",               # Data da baixa da fatura
 "nome": "",          "historico": "",          "descricao": "",     # Histórico da fatura
            "valor": "",                    # "status": "",
 Valor recebido da fatura
                  "obs"saldo": "",                 }   # Valor da fatura
       ]     "cobranca": "",   }     ]
}

...

         # Descrição da cobrança
        }
    ]
}

Estado
title APP

Pegar declaração de quitação de débitos (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

...

as declarações de quitação de débito de um cliente

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

{
    [
        {
            "id_servicoquitacao": "",    # ID da quitação      "nome": "",de débito
            "descricaoano": "",             "valor"# Ano referente a quitação de débito
            "valor": "",          # Valor total da quitação de débito
            "obsurl_arquivo": ""     # URL do pdf da quitação de débito
        }
    ]
}

Estado

...

...

title

...

...

APP

Pegar instalações/produtos de um cliente (GET):

Request para listar todos os produtos/instalações/serviços de um cliente

{}

    "id_cliente": ""
}

{
    [
        {
            "id_revendedorinstalacao": "",  
            "nomecep": "",
            "obsendereco": "",
            "numero": "",
    }       ]
}

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

{}

{ "complemento": "",
    [         {"bairro": "",
            "id_funcionariocidade": "",
            "nomeuf": "",
            "obslatitude": "",
        }     "longitude": "",
    ]
}

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

{}

{        "obs": "",
      [      "servicos": [
 {             "id_departamento  {
                    "id_servico": "",
                    "nome": "",
                    "descricao": "",
            "obs        "valor": "",
             }      ] }

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

{}

{
    [
"status": "",
       {             "id_vencimentoobs": "",
             "data": "",
   }
           "obs": "" ]
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar

...

todos os produtos (GET):

Request utilizada para listar as origens comerciáis, 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)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_origemservico": "",
            "nome": "",
            "obsdescricao": "",
        }    "valor": "",
            "obs": ""
        }
    ]
}

Estado
colour Purple title PROSPECTO

Estado
colour Red title LEAD

Estado
colour Yellow title TOTEM

Pegar

...

todos os revendedores (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.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

{}

{}

{
    [
        {
            "id_revendedor": "",
            "nome": "",
            "obs": ""
        }
    ]
}

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": "",
            "nome": "",
            "obs": ""
        }
    ]
}

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": "",
            "nome": "",
            "obs": ""
        }
    ]
}

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": "",
            "data": "",
            "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)

{}

{
    [
        {
            "id_origem": "",
            "nome": "",
            "obs": ""
        }
    ]
}

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": "",
            "nome": "",
            "latitude": "",
            "longitude": "",
            "obs": ""
        }
    ]
}

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 sejam do tipo correto utilizado

{}

{
    [
        {
            "id_tipo_de_atendimento": "",
            "nome": "",
            "obs": ""
        }
    ]
}

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": "",
            "nome": "",
            "obs": ""
        }
    ]
}

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 (Opcioanl)
    "tipo_pessoa": "",  {    # Pessoa Física ou Juridica
    "idcnpj_cidadecpf": "",         # CPF ou CNPJ
 "nome   "ie_identidade": "",    # Inscrição Estadual
      "latitudedata_nascimento": "",  # Data de nascimento do cliente ou do responsável
    "longitudeid_revendedor": "",    # Id   revendedor
    "obsid_origem": "",        # Id }Origem comercial
   ]
}

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 sejam do tipo correto utilizado

{}

{
    [ "id_vencimento": "",    # Id do Vencimento no ERP
    "cep": "",         {     # CEP do cliente
    "id_tipo_de_atendimentoendereco": "",         # Logradouro
    "nomenumero": "",           # Numero
    "obsbairro": "",         }  # Bairro
   ]
}

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)

{}

{
    [
 "cidade": "",           # Cidade
    "complemento": "",      # Complemento
    "referencia": "",       # {Referencia
    "uf": "",       "status_prospeccao": "",       # Estado
    "nomelatitude": "",         # Latitude
    "obslongitude": "",         }
    ]
}

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

{ # Longitude
    "nometelefone": "",     "nome_fantasia    # Telefone Principal
    "celular": "",           "status_prospeccao": "status_prospeccao",# Telefone Secundario
    "tipocelular_pessoaextra": "",     "cnpj_cpf": "",# Whats APP
    "ie_identidadeemail": "",     "data_nascimento": "",       "data_cadastro": "",# Email
    "id_revendedorobs": "id_revendedor",     "id_origem": "id_origem",       "id_vencimento": "id_vencimento", # Resumo de todas "cep": "",as informa
    "enderecoservicos": "",[     "numero": "",     "bairro": "",
 # Array serviços contratados/interesse
  "cidade": "",     "id_cidade": "id_cidade",{
      "complemento": "",     "referenciaid_serviços":
 "",     "uf": "", }
   "latitude": "", ],       "longitude": "",  
    "foneanexos": [ "",     "telefone_comercial": "",     "telefone_celular": "",
    "whatsapp": "",
    "ramal": "", # Array de anexos dos documentos anexados ao pedido
        {
"email": "",     "obs": "",     "alertanome_documento": "",
    "servicos": [         {"formato": "",
            "idbase_servico64": ""
        }
    ]
}

{
    "id_prospecto": "",
    "obs": """: "",      # Id do Prospecto retornado do ERP
    "obs": ""                # Observação o menssagem 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.

Dados podem varia conforme formulário do pre-checkout

{
    "nome": "",               # Nome
    "taxvat": "",             # Documento
    "nomeemail": "",        "nome_fantasia      # Email
    "phone": "",              # Telefone
    "tipo_pessoaaddress": "",           "cnpj_cpf": "", # Logradouro
    "ie_identidadenumber": "",      "data_nascimento": "",       "data_cadastro": "",# Numero
    "id_revendedorneighborhood": "id_revendedor",     "cep": "",  # Bairro
    "enderecocity": "",     "numero": "",     "bairro": "",     "cidade": "",# Cidade
    "id_cidadestate": "id_cidade",     "complemento": "",         "referencia": "",# Estado
    "ufpostal_code": "",       "latitude": "", # CEP
    "longitudecoverage": "",     "fone": "",     "telefone_comercial": "",
    "telefone_celular": "",# JSON com dados da Cobertura
    "whatsapplatitude": "",     "ramal": "",     "email": "",# Latitude
    "obslongitude": "",     "alerta": "",    # "servicos":Longitude
[    "reseller": "",    {       # Revendedor
    "idextra_servicodata": ""         } #    ]Dados
}

{
    "id_lead": "",
    "obs": ""
}

...