Comparação de Páginas

...

Exemplo de requisições GET, POST e PUT com payload e resposta esperadas em JSON para integração. Recomendamos autenticação com token no header da requisição

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Pegar infos de clientes (GET):

Request utilizada para pegar as informações do cliente no ERP com base no CPF/CNPJ dele

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

{
    "idnome_clientecompleto": "",     "nome": "",       # Nome "fantasia": "",
    "tipo_pessoa": "",completo do cliente / razão social da empresa
    "cnpj_cpfaniversario": "",     "ie_identidade": "",       "rg_orgao_emissor": "", # Data de  "inscricao_municipal": "",aniversário do cliente
    "contribuintedata_icmsregistro": "N",     "nacionalidade": "",       "cidade_naturalidade": "",
    "estado_nascimento": "",# Data de cadastro do cliente no ERP
    "data_nascimentoativo": "",     "estado_civil": "",       "ativo": "",     "Sexo": "", # Cliente está ativo "profissao": "",no ERP
    "dataid_cadastroremoto": "",     "cep": "",     "endereco": "",    # "numero": "",
    "complemento": "",ID do cliente dentro do ERP
      "bairroid_contrato": "",      "cidade": "",     "uf": "", # ID do contrato "latitude": "",do cliente
    "longituderua_endereco": "",             "fone": "",
    "telefone_comercial": "",# Nome da rua do endereço do cliente
    "telefonenumero_celularendereco": "",     "whatsapp": "",
    "email": "",     # Número da casa do endereço do cliente
    "obscep_endereco": "",       "alerta": ""
}

Pegar boletos abertos/faturas (GET):

Request utilizada para listar os boletos dos clientes com base id do cliente

{      # Cep do endereço do cliente
    "idcidade_clienteendereco": ""
}

{,      [    # Cidade do endereço  {
     do cliente
    "idcomplemento_faturaendereco": "",     # Complemento do endereço do cliente
    "nomebairro_clienteendereco": "",          # Bairro  "valor_inicial": "",  
     do endereço do cliente
    "valorestado_atualendereco": "",           #  "data_emissao": "",  
          "data_vencimento": "", Estado do endereço do cliente
}

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Pegar boletos abertos/faturas (GET):

Request utilizada para listar os boletos dos clientes com base no documento do cliente (cpf/cnpj)

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

{
    [
"url_boleto": ""       {
 }     ] }

Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas de um cliente

{     "id_clientefatura": ""
}

{,      [  # ID utilizado para identificação e baixa {de Fatura 
          "idcode_notafatura": "",      # Valor composto pelo ID da fatura e docuemento "status": "",do cliente  
            "valornome_cliente": "",     # Nome do Cliente
          "valordocument_pagonumber": "",  # Documento do cliente, o mesmo informado para obter as faturas
  "data_lancamento        "remote_id": "",        # Código do cliente no ERP
 "data_vencimento         "valor_inicial": "",    # Valor original do Boleto
          "datavalor_baixaatual": "",      # Valor atualizado na data da Consulta
          "url_nota_fiscaljuros": "",           } # Juros aplicado  ]
}

Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros

{ao boleto na data de consulta
          "id_clientemulta": ""
}

{,         [   # Multa aplicado ao boleto na {data de consulta
          "id_extrato_financeirodesconto": "",         # Desconto aplicado ao boleto na "data_lancamento": "",
 de consulta
           "data_vencimentoemissao": "",     # Data de emissão do Boleto
          "data_baixavencimento": "",  # Data de vencimento do Boleto
          "id_boletohistorico": "",        # Mensagem de referência  "id_nota": "",
 da Fatura (ex. Mensalidade Plano X)
          "valorbank_code": "",        # Codigo que indica a  "valor_pago": "",
 qual banco pertence a fatura
          "multalinha_digitavel": "",  # Linha digitavel do Boleto
          "jurosintegration_id": "",   # Id da integraçõ ERP a qual o boleto pertence
   "desconto       "identifier": "",       # Identificador de pagamento (Ex. Carteira "obsde cobrança)
          "pix_code": "",         }# Código PIX copia e ]cola }

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

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

{de sistema de pagamento do ERP
          "contract_id_cliente": "" }

{     [ # Id do contrado(s) a qual pertence a {
Fatura
           "idbill_quitacaoreceipt": "",     # Cabeço de impressão gerado para o Totem (TEF)
 "ano": "",               "valor"bill_pix_receipt": "", # Cabeço de impressão gerado para o Totem (PIX)
     "url_arquivo": ""
        }
    ]
}

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

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

{
    "id_cliente": ""
}

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   (cpf/cnpj)
}

{
            "id_instalacao"remote_id": "",      # Id do Contrato no ERP. Utilizado para filtrar o boletos
    "cepcontract_name": "",   # Endereço da instalação
}

Estado
title APP

Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas para um cliente

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

{
    [
      "complemento": "",  {
            "bairroid_nota": "",             "cidade": "", # ID da nota fiscal dentro do ERP
            "uf"id_tipo_nota: "",          # ID do tipo da nota fiscal dentro "latitude": "",do ERP
            "longitudenumero_nota": "",          # Número da "obs": "",nota fiscal
            "servicosvalor": ["",                # {Valor da nota  fiscal
                "id_servico"protocolo": "",            # Protocolo da nota fiscal
     "nome       "data_lancamento": "",      # Data que a nota foi lançada no ERP  
            "descricaoidentificacao": "",        # Identificação da nota fiscal
            "valorurl_nota_fiscal": "",      # Url do pdf da nota fiscal 
       "status": "", }
    ]
}

Estado
title APP

Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros de um cliente

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

{
    [
   }     {
       ]     "id_nota": "",   }     ] }

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 da fatura
 {             "iddata_servicolancamento": "",          # Data de lançamento da fatura
            "nomedata_vencimento": "",          # Data de vencimento da "descricaofatura
            "data_baixa": "",               # Data da baixa da fatura
            "valorhistorico": "",             "obs": ""  # Histórico da fatura
   }     ]
}

Pegar todos os revendedores (GET):

...

    "valor": "",                    # Valor recebido da fatura
            "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 as declarações de quitação de débito de um cliente

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

Estado
title APP

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

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

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

{
    [
        {
            "id_servico": "",           # ID do serviço no ERP
            "nome": "",                 # Nome do serviço
            "situacao": "",             # Situação do serviço no ERP (ativo, suspenso, etc.)
            "obs": "",                  # Observações/comentários sobre o serviço
            "valor": "",                # Valor do serviço
            "numero_plano": "",         # Número/posição do serviço no ERP
            "endereco": "",             # Endereço referente ao serviço do cliente
        }
    ]
}

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
            "nome": "",         # Nome de apresentação do produto
            "descricao": "",    # 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 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": "",  # 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_vencimento": "",            # Id do Vencimento no ERP
    "cep": "",                      # CEP do cliente
    "endereco_instalação": "",      # Logradouro do endereço de instalação
    "numero_instalação": "",        # Numero do endereço de instalação
    "bairro_instalação": "",        # Bairro do endereço de instalação
    "cidade_instalaçã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
    "uf_instalação": "",            # Estado do endereço de instalação
    "endereco_cobranca": "",        # Logradouro do endereço de cobrança
    "numero_cobranca": "",          # Numero do endereço de cobrança
    "bairro_cobranca": "",          # Bairro do endereço de cobrança
    "cidade_cobranca": "",          # Cidade do endereço de cobrança
    "complemento_cobranca": "",     # Complemento do endereço de cobrança
    "referencia_cobranca": "",      # Referencia do endereço de cobrança
    "uf_cobranca": "",              # Estado do endereço de cobrança
    "latitude": "",                 # Latitude da instalação
    "longitude": "",                # Longitude da instalação
    "telefone": "",                 # Telefone residencial
    "celular": "",                  # Celular
    "celular_extra": "",            # Celular extra (geralmente whatsapp)
    "email": "",                    # Email
    "obs": "",                      # Resumo de todas as informações do pedido
    "servicos": [                   # Array serviços contratados/interesse
        {
            "id_servico"            # ID do serviço no ERP
        }
    ],         
    "anexos": [                     # Array de anexos dos documentos anexados ao pedido
        {
            "nome_documento": "",   # Nome do documento
            "formato": "",          # Formato do arquivo
            "base_64" ""    	    # Conteúdo do arquivo em base 64
        }
    ]
}

{
    "id_prospecto": "",      # Id do Prospecto retornado do ERP
    "obs": ""                # Observação ou 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 do cliente
      "id_revendedordocumento": "",      # Documento do cliente
    "nomeemail": "",          # Email do "obs": ""cliente
         }
    ]
}

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

{}

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

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

{}

{
    [
        {# Cidade do endereço de instalação
    "estado": "",         # Estado do endereço de instalação
    "id_departamentoCEP": "",            # CEP "nomedo endereço de instalação
    "cobertura": "",      # JSON com dados da Cobertura
    "obslatitude": "",       # Latitude da instalação
    "longitude": "",      # Longitude }da instalação
   ]
}

Pegar todos os vencimentos (GET):

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

{}

{ "revendedor": "",     [# Nome do revendedor
     {"id_revendedor": "",  # ID do revendedor no ERP
     "idextra_vencimentodata": "",      # Dados extras do lead
}

{
    "dataid_lead": "",  # ID do lead retornado do ERP
    "obs": ""       # Observação }ou menssagem do ERP
 ]
}

...

Estado
title APP

Criar atendimento (POST):

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, Anuncio de Rádio)criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64

{}

{
 
    "id_cliente": "",   [         {     # ID do cliente no ERP
    "id_origemservico": "",               "nome": "", # ID do serviço do cliente no ERP
    "obsid_tipo_de_atendimento": "",     # ID do  }
tipo de atendimento escolhido pelo cliente no ERP
   ]
}

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_departamento": "",     [       # ID {do departamento escolhido   pelo cliente no ERP
    "id_cidadefuncionario": "",             "nome": "",
       # ID do funcionário responsável no ERP
    "latitudeemail": "",             "longitude": "",         # Email do cliente
    "obstelefone": "",         }          ]
}

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

{}

{# Telefone do cliente
    "assunto": "",           [         {# Assunto do chamado que o cliente esta abrindo
    "id_tipo_de_atendimentomensagem": "",                   # Mensagem do chamado que o cliente esta abrindo
    "nomeanexo": "",[             "obs": ""         } # Anexos enviados pelo ]
}

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)

{}

{cliente (se a opção estiver liberada)
        {
            "anexo": "",           [   # Conteúdo do arquivo em base {64
            "status_prospeccaoobs": "",,                # Observação do anexo
            "nome_anexo": "",          # Nome  "obs": ""do anexo
        }
    ]
}

...

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

{
    "nomeid_atendiemnto": "",   # ID do lead  "nome_fantasia": "",retornado do ERP
    "status_prospeccaoobs": "status_prospeccao",     "tipo_pessoa": "",     "cnpj_cpf": "",     "ie_identidade": "",
    "data_nascimento": "",# 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

{
    "dataid_cadastrocliente": "",   #  "id_revendedor": "id_revendedor",
    "id_origem": "id_origem",
    "id_vencimentoID do cliente no ERP
    "id_servico": "id_vencimento",   # ID "cep": "",
    "endereco": "",do serviço do cliente no ERP
}

{
     "numerostatus": "",   # Status "bairro": "",
    "cidade": "",
    "id_cidade": "id_cidade",do serviço após a chamada de ativação (se foi ativo ou nã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

{
    "complementoid_prospecto": "",     "referencia": "",     "uf": "",
    "latitude": "",# ID do prospecto no ERP
      "longitudestatus_prospeccao": "",     "fone": "",
    "telefone_comercial": "", # ID do status do prospecto no ERP
    "telefoneid_celularrevendedor": "",
    "whatsapp": "",     "ramal": "",     "email": "", # ID do revendedor "obs": "",do ERP
    "alertaobs": "",     "servicos": [         {     # Observações
}

{
     "id_servicostatus": "",   # Status atual      }
    ]
}do prospecto no 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)

{
    "id_prospectocliente": "",         "obs": ""
}

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

{    # ID do cliente no ERP
    "nome": "",       "nome_fantasia": "",            # Nome do cliente no ERP
    "tipo_pessoafantasia": "",     "cnpj_cpf": "",         "ie_identidade": "",
    "data_nascimento": "", # Nome fantasia do cliente para empresa
    "datatipo_cadastropessoa": "",       "id_revendedor": "id_revendedor",     # Tipo "cep": "",
da pessoa, Física ou Juridica
    "enderecocnpj_cpf": "",     "numero": "",        "bairro": "", # CPF ou CNPJ "cidade": "",do cliente
    "idie_cidadeidentidade": "id_cidade",     "complemento": "",     "referencia": "",
    "uf": "",# Inscrição Estadual parra clientes PJ (Opcional)
    "latituderg_orgao_emissor": "",      "longitude": "", # 
    "foneinscricao_municipal": "",    # "telefone_comercial":
"",     "telefonecontribuinte_celularicms": "",      "whatsapp": "",# 
    "ramalnacionalidade": "",     "email": "",     "obs": "",# 
    "alertacidade_naturalidade": "",    # "servicos":
[         {"estado_nascimento": "",        # 
    "iddata_serviconascimento": "",         }# 
   ] }

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

Criar atendimento (POST):

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

{      # 
    "id_clienteativo": "id_cliente",               "id_servico   # 
    "Sexo": "id_servico",      "id_tipo_de_atendimento             # 
    "profissao": "id_tipo_de_atendimento",          "id_departamento": "id_departamento",    # 
    "iddata_funcionariocadastro": "id_funcionario",          # 
    "emailcep": "",              "telefone": "",     "assunto": "",# 
    "mensagemendereco": "",        "obs": "",       "alerta": "",# 
    "anexonumero": "", [         {       # 
    "anexocomplemento": B64_DO_ARQUIVO,"",            # 
    "obsbairro": "",             "nome_anexo": ""   # 
    }
"cidade": "",    ] }

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

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_clienteuf": "id_cliente",            "id_servico": "id_servico", }

{     "status": "",
}

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_prospectolatitude": "",               # 
 "status_prospeccao   "longitude": "status_prospeccao",      "id_revendedor        # 
    "fone": "id_revendedor",      "obs": "",            "alerta": "",
}

{ # 
    "statustelefone_comercial": "",
}

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)

{     # 
    "idtelefone_clientecelular": "",       # 
    "nomewhatsapp": "",          "fantasia": "",     # 
    "tipo_pessoaemail": "",     "cnpj_cpf": "",       "ie_identidade": "",     "rg_orgao_emissor": "",# 
    "inscricao_municipalobs": "",     "contribuinte_icms": "N",     "nacionalidade": "",     "cidade_naturalidade": "",     "estado_nascimento": "",# 
    "data_nascimentoalerta": "",       "estado_civil": "",     "ativo": "",    # "Sexo": "",
}

{
    "profissaostatus": "",
    "data_cadastro": "",
    "cep": "",
    "endereco": "",}

Estado
colour Purple title Prospecto

Estado
colour Yellow title TOTEM

Envio de arquivos (POST)

Request utilizada para enviar arquivos anexados pelos clientes na hora da assinatura, de modo a deixar os arquivos vinculados aos prospectos/leads. Os arquivos são enviados em Base64, geralmente imagens (jpg, png, gif) ou PDF

{
    "numeroid_prospecto": "",
    "complementonome_arquivo": "",
    "bairroarquivo": "",
    "cidadeobs": "",
    "uf": "",}

{
    "latitudestatus": "",
    "longitude": "",}

Estado
title APP

Estado
colour Yellow title TOTEM

Estado
colour Green title Boleto

Baixa na fatura/Sinalização de pagamento (POST)

Request utilizada para sinalizar ao ERP que a fatura em questão do cliente foi paga pelo terminal de atendimento da Datacake (Totem) ou pelo aplicativo; permitindo o ERP marcar a mesma como paga e caso necessário retomar os serviços suspensos

{
    "foneid_cliente": "id_cliente",
    "telefoneid_comercialfatura": "",
    "telefone_celular": "",
    "whatsapp": "",id_fatura",
}

{
    "email": "",
    "obsstatus": "",
}

Estado
colour Purple title Prospecto

Estado
colour Yellow title TOTEM

Status do Prospecto (GET):

Request utilizada para receber o status atual do prospecto, mantendo o sistema da Datacake sincronizado com o ERP

{
    "alertaid_prospecto": "id_prospecto",
}

{
    "status": "",
    "motivo": "motivo_do_cancelamento_ou_rejeição"
}