...
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
Índice |
---|
minLevel | 1 |
---|
maxLevel | 7 |
---|
outline | true |
---|
|
Pegar infos de clientes (GET):
...
Expandir |
---|
|
Bloco de código |
---|
| {
"cnpj_cpf": "" # Documento do cliente (cpf/cnpj)
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"idnome_clientecompleto": "", "nome": "", # Nome "fantasia": "",
"tipo_pessoa": "",completo do cliente / razão social da empresa
"cnpj_cpfaniversario": "", "ie_identidade": "", "rg_orgao_emissor": "", # Data "inscricao_municipal": "",de 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": "", # ID "numero": "",
"complemento": "",do cliente dentro do ERP
"bairroid_contrato": "", "cidade": "", "uf": "", # ID do contrato "latitude": "",do cliente
"longituderua_endereco": "", "fone": "", "telefone_comercial": "", # Nome da "telefone_celularrua do endereço do cliente
"numero_endereco": "", # Número da casa do endereço do cliente
"whatsappcep_endereco": "", # Cep do endereço "email": "",do cliente
"obscidade_endereco": "", "alerta": ""
} |
|
Pegar boletos abertos/faturas (GET):Request utilizada para listar os boletos dos clientes com base id do cliente
Expandir |
---|
|
Bloco de código |
---|
| {# Cidade do endereço do cliente
"idcomplemento_clienteendereco": ""
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {, # [Complemento do endereço do cliente
{
"bairro_endereco": "", "id_fatura": "",
"nome_cliente": "",
# Bairro do endereço do cliente
"valorestado_inicialendereco": "", # "valor_atual": "",
"data_emissao": "",
Estado do endereço do cliente
}
|
|
Pegar boletos abertos/faturas (GET):Request utilizada para listar os boletos dos clientes com base no documento do cliente (cpf/cnpj)
Expandir |
---|
|
Bloco de código |
---|
| {
"data_vencimentodocument": "", # Documento do cliente (cpf/cnpj)
"linhaid_digitavelcontrato": "", # ID do contrato do "url_boleto": ""
}
]
} |
|
Pegar notas fiscais (GET):Request utilizada para listar as notas fiscais emitidas para um cliente
Expandir |
---|
|
Bloco de código |
---|
| {
"id_cliente": ""
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_notafatura": "", # ID utilizado para identificação e baixa "status": "", de Fatura
"valorcode_fatura": "", # Valor composto pelo ID da fatura e "valor_pago": "", docuemento do cliente
"datanome_lancamentocliente": "", # Nome do Cliente
"datadocument_vencimentonumber": "", # Documento do cliente, o mesmo informado para obter "data_baixa": "",
as faturas
"urlremote_nota_fiscalid": "", # Código do }cliente no ERP
] } |
|
Pegar extratos financeiros (GET):Request utilizada para listar os extratos financeiros de um cliente
Expandir |
---|
|
Bloco de código |
---|
| { "idvalor_clienteinicial": ""
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {, # [Valor original {
do Boleto
"idvalor_extrato_financeiroatual": "", # Valor atualizado na data da Consulta
"data_lancamento "juros": "", # Juros "data_vencimento": "",
aplicado ao boleto na data de consulta
"data_baixamulta": "", # Multa aplicado ao "id_boleto": "",
boleto na data de consulta
"id_notadesconto": "", # Desconto aplicado ao boleto "valor": "",
na data de consulta
"valordata_pagoemissao": "", # Data de emissão do "multa": "",Boleto
"juros"data_vencimento": "", # Data de vencimento do Boleto
"descontohistorico": "", # Mensagem de referência da Fatura (ex. Mensalidade Plano X)
"obsbank_code": "", # Codigo que indica a qual banco pertence a fatura
} ] } |
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
"id_cliente"linha_digitavel": ""
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {, # Linha digitavel [do Boleto
{ "integration_id": "", # Id da integraçõ ERP "id_quitacao": "",
a qual o boleto pertence
"anoidentifier": "", # Identificador de pagamento (Ex. Carteira de cobrança)
"valorpix_code": "", # Código PIX copia e cola de sistema de pagamento do ERP
"urlcontract_arquivoid": "" # Id do contrado(s) a qual pertence a Fatura
} ]
} |
|
Pegar instalações/produtos de um cliente (GET):Request para listar todos os produtos/instalações/serviços de um cliente
Expandir |
---|
|
Bloco de código |
---|
| {
"id_cliente "bill_receipt": ""
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {, [# Cabeço de impressão gerado para o {
Totem (TEF)
"idbill_pix_instalacaoreceipt": "", # Cabeço de impressão gerado para o Totem (PIX)
"cep": "", }
]
} |
|
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.
Expandir |
---|
|
Bloco de código |
---|
| {
"enderecodocument": "", # Documento do cliente (cpf/cnpj)
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"numeroremote_id": "", # Id do Contrato no ERP. Utilizado "complemento": "",
para filtrar o boletos
"bairrocontract_name": "", # Endereço da "cidade": "",
instalação
} |
|
Pegar notas fiscais (GET):Request utilizada para listar as notas fiscais emitidas para um cliente
Expandir |
---|
|
Bloco de código |
---|
| {
"ufdocument": "", # Documento do cliente (cpf/cnpj)
"latitudeid_cliente": "", # ID do cliente no ERP
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"longitude": "",[
"obs": "",{
"servicosid_nota": ["", # ID da {nota fiscal dentro do ERP
"id_tipo_servico"nota: "", # ID do tipo da nota fiscal dentro do ERP
"nome": "", "numero_nota": "", "descricao": "",
# Número da nota fiscal
"valor": "", # Valor da "status": "",
nota fiscal
"obsprotocolo": "", # Protocolo da nota fiscal
} ]"data_lancamento": "", # Data que a nota foi lançada no ERP
} ]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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
Expandir |
---|
|
Bloco de código |
---|
| { "identificacao": "", [ # Identificação da nota {fiscal
"idurl_nota_servicofiscal": "", # Url do pdf da "nome": "",nota fiscal
}
"descricao": "", ]
} |
|
Pegar extratos financeiros (GET):Request utilizada para listar os extratos financeiros de um cliente
Expandir |
---|
|
Bloco de código |
---|
| {
"valordocument": "", # Documento do cliente (cpf/cnpj)
"obsid_cliente": "" # ID do cliente }
]no ERP
} |
|
...
...
...
...
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_nota": "", # ID da fatura
"iddata_revendedorlancamento": "", # Data de lançamento da fatura
"nomedata_vencimento": "", # Data de vencimento da fatura
"obsdata_baixa": "", } ]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
[ # Data da baixa da fatura
"historico": "", # Histórico da fatura
"valor": "", { # Valor "id_funcionario": "",recebido da fatura
"nomesaldo": "", "obs": "" # Valor da }fatura
] } |
|
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
Expandir |
---|
|
Bloco de código |
---|
| { [ "cobranca": "", { # "id_departamento": "",Descrição da cobrança
}
"nome ]
} |
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
"document": "", # Documento do cliente (cpf/cnpj)
"obsid_cliente": "" # ID do cliente no ERP
}} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
Pegar todos os vencimentos (GET):Request utilizada para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente
Expandir |
---|
|
Bloco de código |
---|
| {
[
[
{
"id_vencimentoquitacao": "", # ID da quitação de débito
"data "ano": "", # Ano referente a quitação de débito
"obsvalor": "", # Valor total da quitação de débito
} ]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
...
"url_arquivo": "" # URL do pdf da quitação de débito
}
]
} |
|
Pegar instalações/produtos de um cliente (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/instalações/serviços de um cliente
Expandir |
---|
|
|
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"document": "" # Documento do cliente (cpf/cnpj)
"id_cliente": "" # ID do cliente no ERP
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"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 |
---|
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"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 |
---|
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"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 |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_funcionario": "", # ID do funcionário no ERP
"nome": "", # Nome do funcionário
"obs": "" # Observações
}
]
} |
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_departamento": "", # ID do departamento no ERP
"nome": "", # Nome do departamento
"obs": "" # Observações
}
]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
Pegar todos os vencimentos (GET):Request utilizada para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_vencimento": "", # ID do vencimento no ERP
"data": "", # "Nome" da data de vencimento (Exemplo: "dia 5")
"obs": "" # Observações
}
]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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)
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_origem": "", # ID da origem comercial no ERP
"nome": "", # Nome da origem comercial
"obs": "" # Observações
}
]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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.
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_cidade": "", # ID da cidade no ERP
"nome": "", # Nome da cidade no ERP
"latitude": "", # Latitude da cidade
"longitude": "", # Longitude da cidade
"obs": "" # Observações
}
]
} |
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"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 |
---|
|
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)
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"status_prospeccao": "", # Código do status no ERP
"nome": "", # Nome do status no ERP
"obs": "" # Observações
}
]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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.
Expandir |
---|
|
Bloco de código |
---|
| {
"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
}
]
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"id_prospecto": "", # Id do Prospecto retornado do ERP
"obs": "" # Observação ou menssagem do ERP
} |
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
"nome": "", # Nome do cliente
"documento": "", # Documento do cliente
"email": "", # Email do cliente
"telefone": "", # Telefone do cliente
"endereco": "", # Logradouro do endereço de instalação
"numero": "", # Numero do endereço de instalação
"bairro": "", # Bairro do endereço de instalação
"cidade": "", # Cidade do endereço de instalação
"estado": "", # Estado do endereço de instalação
"CEP": "", # CEP do endereço de instalação
"cobertura": "", # JSON com dados da Cobertura
"latitude": "", # Latitude da instalação
"longitude": "", # Longitude da instalação
"revendedor": "", # Nome do revendedor
"id_origemrevendedor": "", # ID do revendedor no ERP
"extra_data": "" # Dados extras do lead
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"nomeid_lead": "", # ID do lead retornado do ERP
"obs": "" # Observação }ou menssagem do ]ERP
} |
|
...
...
...
Criar atendimento (POST):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.
...
...
...
criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64
Expandir |
---|
|
Bloco de código |
---|
| {
[
{
"id_cidadecliente": "", "nome": "", # ID do cliente no ERP
"latitudeid_servico": "", "longitude": "", # ID do serviço do cliente no ERP
"obsid_tipo_de_atendimento": "", # ID do tipo de atendimento escolhido pelo cliente }no ERP
]
} |
|
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
Expandir |
---|
|
Bloco de código |
---|
| { "id_departamento": "", [ # ID {do departamento escolhido pelo cliente no ERP
"id_tipo_de_atendimentofuncionario": "", "nome": "",
# ID do funcionário responsável no ERP
"obsemail": "", } ]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
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)
Expandir |
---|
|
Bloco de código |
---|
| {# Email do cliente
"telefone": "", [ { # Telefone do cliente
"status_prospeccaoassunto": "",
, # Assunto do chamado que o cliente esta abrindo
"nomemensagem": "", "obs": "" # Mensagem do }
]
} |
|
Estado |
---|
colour | Purple |
---|
title | PROSPECTO |
---|
|
Criar prospectos (POST):Request utilizada para a criação de uma prospecção no sistema, esse é o principal canal de entrada de novas assinaturas
Expandir |
---|
|
Bloco de código |
---|
| {
"nome": "",chamado que o cliente esta abrindo
"nome_fantasiaanexo": [ "", "status_prospeccao": "status_prospeccao", "tipo_pessoa": "", "cnpj_cpf": "", "ie_identidade": "",
"data_nascimento": "",
# Anexos enviados pelo cliente (se a opção estiver liberada)
"data_cadastro": "", {
"id_revendedor": "id_revendedor", "id_origem": "id_origem", "id_vencimentoanexo": "id_vencimento", "cep": "", # "endereco": "",
"numero": "",Conteúdo do arquivo em base 64
"bairro": "", "cidadeobs": "", "id_cidade": "id_cidade", "complemento": "", # Observação do anexo
"referencia": "", "uf": "", "latitudenome_anexo": "", "longitude": "", # "fone": "",
Nome do anexo
"telefone_comercial": "", "telefone_celular": "",}
"whatsapp": "",]
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"ramalid_atendiemnto": "", # ID do lead retornado "email": "",do ERP
"obs": "", "alerta": "",
"servicos": [# Observação ou menssagem do ERP
} |
|
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
Expandir |
---|
|
Bloco de código |
---|
| {
"id_cliente": "", {# ID do cliente no ERP
"id_servico": "", # ID do serviço do cliente }
]no ERP
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"id_prospectostatus": "", # Status do serviço após a chamada de ativação (se foi ativo "obs": ""ou não)
} |
|
...
...
...
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
Expandir |
---|
|
Bloco de código |
---|
| {
"nomeid_prospecto": "", # ID do prospecto no ERP
"nomestatus_fantasiaprospeccao": "", # ID do status do "tipo_pessoa": "",prospecto no ERP
"cnpjid_cpfrevendedor": "", "ie_identidade": "",
"data_nascimento": "", # ID do revendedor do ERP
"data_cadastroobs": "", "id_revendedor": "id_revendedor", "cep": "", # "endereco": "",Observações
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"numerostatus": "", # "bairro": "",
"cidade": "",Status atual do prospecto no ERP
} |
|
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)
Expandir |
---|
|
Bloco de código |
---|
| {
"id_cidadecliente": "id_cidade", "complemento": "", "referencia": "", # ID do cliente "uf": "",no ERP
"latitudenome": "", "longitude": "", "fone": "", "telefone_comercial": "", # Nome do "telefone_celular": "",cliente no ERP
"whatsappfantasia": "", "ramal": "", "email": "",
"obs": "", # Nome fantasia do cliente para empresa
"alertatipo_pessoa": "", "servicos": [ # Tipo da {pessoa, Física ou Juridica
"idcnpj_servicocpf": "", } ]
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"id_lead": "",
"obs": ""
} |
|
Criar atendimento (POST):Request utilizada para criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64
Expandir |
---|
|
Bloco de código |
---|
| { # CPF ou CNPJ do cliente
"idie_clienteidentidade": "id_cliente",", # Inscrição Estadual parra clientes PJ (Opcional)
"idrg_orgao_servicoemissor": "id_servico", #
"id_tipo_de_atendimentoinscricao_municipal": "id_tipo_de_atendimento", #
"idcontribuinte_departamentoicms": "id_departamento", "id_funcionario": "id_funcionario", #
"emailnacionalidade": "", "telefone": "",#
"assuntocidade_naturalidade": "", #
"mensagemestado_nascimento": "", "obs": "", #
"alertadata_nascimento": "", # "anexo":
[ "estado_civil": "", { #
"anexoativo": B64_DO_ARQUIVO,
"", "obs": "", #
"nome_anexoSexo": "", } ]
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {#
"id_atendiemntoprofissao": "", "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
Expandir |
---|
|
Bloco de código |
---|
| { #
"id_clientedata_cadastro": "", #
"cep": "id_cliente",", #
"id_servicoendereco": "id_servico",
} |
|
Expandir |
---|
|
Bloco de código |
---|
| { #
"statusnumero": "",
} |
|
Estado |
---|
colour | Purple |
---|
title | Prospecto |
---|
|
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
Expandir |
---|
|
Bloco de código |
---|
| { "id_prospecto": "", "status_prospeccao": "status_prospeccao", #
"id_revendedorcomplemento": "id_revendedor", "obs": "", "alerta": "",
} |
|
Expandir |
---|
|
Bloco de código |
---|
| { #
"statusbairro": "",
} |
|
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)
Expandir |
---|
|
Bloco de código |
---|
| { #
"id_clientecidade": "", #
"nomeuf": "", "fantasia": "", "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": ""#
} |
|
Expandir |
---|
|
Bloco de código |
---|
| {
"status": "",
} |
|
...