...
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):Request utilizada para pegar as informações do cliente no ERP com base no CPF/CNPJ dele
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"cnpj_cpf": "" # Documento do cliente (cpf/cnpj)
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"idnome_clientecompleto": "", # Nome "nome": "",
"fantasia": "",completo do cliente / razão social da empresa
"tipo_pessoaaniversario": "", "cnpj_cpf": "", "ie_identidade": "", # Data de "rg_orgao_emissor": "",aniversário do cliente
"inscricaodata_municipalregistro": "", "contribuinte_icms": "N", "nacionalidade": "",
"cidade_naturalidade": "",# Data de cadastro do cliente no ERP
"estado_nascimentoativo": "", "data_nascimento": "", "estado_civil": "", # Cliente está "ativo": "", no ERP
"Sexoid_remoto": "", "profissao": "", "data_cadastro": "",
"cep": "", # ID do cliente dentro do ERP
"enderecoid_contrato": "", "numero": "", "complemento": "", # ID do contrato "bairro": "",do cliente
"cidaderua_endereco": "", "uf": "", # Nome da rua do endereço do cliente
"latitudenumero_endereco": "", "longitude": "",
"fone": "", # Número da casa do endereço do cliente
"telefonecep_comercialendereco": "", "telefone_celular": "", "whatsapp": "", # 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": "",
"data_vencimentoEstado 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 |
|---|
| {
"document": "", # Documento do cliente (cpf/cnpj)
"linhaid_digitavelcontrato": "", # ID do contrato do "url_boleto": ""cliente
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
[
}{
] } |
|
Pegar notas fiscais (GET):
Request utilizada para listar as notas fiscais emitidas para um cliente
| Expandir |
|---|
|
| Bloco de código |
|---|
| { "id_clientefatura": ""
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {, [ # 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
"datavalor_vencimentoinicial": "", # Valor original do Boleto
"datavalor_baixaatual": "", # Valor atualizado na data da Consulta
"url_nota_fiscaljuros": "", # }Juros aplicado ao boleto na ]
} |
|
Request utilizada para listar os extratos financeiros de um cliente
| Expandir |
|---|
|
| Bloco de código |
|---|
| {data de consulta
"id_clientemulta": ""
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {, [ # 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 da "id_nota": "",
Fatura (ex. Mensalidade Plano X)
"valorbank_code": "", # Codigo que indica "valor_pago": "",
a qual banco pertence a fatura
"multalinha_digitavel": "", # Linha digitavel do Boleto
"jurosintegration_id": "", # Id da integraçõ ERP a qual o boleto pertence
"descontoidentifier": "", # Identificador de pagamento (Ex. Carteira de cobrança)
"obspix_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
| Expandir |
|---|
|
| Bloco de código |
|---|
| {de sistema de pagamento do ERP
"contract_id_cliente": "" } |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| { [ # Id do contrado(s) a qual pertence a {
Fatura
"idbill_quitacaoreceipt": "", # Cabeço de impressão gerado para o Totem (TEF)
"ano": "",
"valorbill_pix_receipt": "", # Cabeço de impressão gerado para o "url_arquivo": ""Totem (PIX)
}
]
} |
|
...
Pegar Contratos do Cliente (GET):Request utilizado para listar todos os produtos/instalações/serviços de um clienteo 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 |
|---|
| {
"id_clientedocument": "" # Documento do cliente (cpf/cnpj)
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
[
"remote_id": "", # Id {do Contrato no ERP. Utilizado para filtrar o boletos
"idcontract_instalacaoname": "", # Endereço da "cepinstalação
} |
|
Pegar notas fiscais (GET):Request utilizada para listar as notas fiscais emitidas para um cliente
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"document": "", # Documento do cliente (cpf/cnpj)
"enderecoid_cliente": "", # ID do cliente no ERP
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"numero": "",[
{
"complemento": "", "bairro"id_nota": "", # ID da nota fiscal dentro "cidade": "",do ERP
"uf"id_tipo_nota: "", # ID do tipo da nota "latitude": "",fiscal dentro do ERP
"longitudenumero_nota": "", # Número da "obs": "",nota fiscal
"servicosvalor": "", [ # Valor {da nota fiscal
"protocolo": "", "id_servico": "", # Protocolo da nota fiscal
"nomedata_lancamento": "", # Data que a nota foi lançada "descricao": "",
no ERP
"valoridentificacao": "", # Identificação da nota fiscal
"statusurl_nota_fiscal": "", # Url do pdf da nota fiscal
"obs": "" }
}
]
}
]
} |
|
...
Pegar extratos financeiros (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 produtosos extratos financeiros de um cliente
| Expandir |
|---|
|
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
[
"document": "" # Documento do cliente {(cpf/cnpj)
"id_cliente": "" # ID do cliente "id_servico": "",no ERP
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
[
"nome": "", {
"descricaoid_nota": "", # ID "valor": "",da fatura
"obsdata_lancamento": "", } # Data de lançamento ]
} |
|
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 |
|---|
| {da fatura
[ "data_vencimento": {"", # Data de vencimento da fatura
"iddata_revendedorbaixa": "", # Data da baixa da fatura
"nomehistorico": "", # Histórico da fatura
"obs "valor": "", } ]
} |
|
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 |
|---|
| {
[ # Valor recebido da fatura
{ "saldo": "", "id_funcionario": "", # Valor da "nome": "",fatura
"obscobranca": "", # Descrição da cobrança
}
]
} |
|
Pegar ...
declaração de quitação de débitos (GET):
Request utilizada para listar todos os departamentos, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um departamentoas declarações de quitação de débito 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_departamento": "", {
"nomeid_quitacao": "", # ID da quitação de débito
"obs "ano": "", } # Ano referente a ]
} |
|
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 |
|---|
| {quitação de débito
[ "valor": "", { # Valor total da "id_vencimento": "",quitação de débito
"dataurl_arquivo": "", # URL do pdf da quitação "obs": ""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_origemservico": "", # ID do serviço "nome": "",no ERP
"obsnome": "", } ]
} |
|
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 |
|---|
| {
[
# Nome do serviço
{ "id_cidade"situacao": "", "nome": "",# Situação do serviço no ERP (ativo, suspenso, etc.)
"latitudeobs": "", # Observações/comentários sobre o serviço
"longitudevalor": "", # Valor do serviço
"obs "numero_plano": "", }# Número/posição do serviço no ]
} |
|
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 |
|---|
| {
ERP
[ {
"id_tipo_de_atendimento"endereco": "", "nome": "",
"obs": ""# Endereço referente ao serviço do cliente
}
]
} |
|
| Estado |
|---|
| colour | Purple |
|---|
| title | PROSPECTO |
|---|
|
Pegar todos os ...
produtos (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)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_revendedor": "", # ID do revendedor no ERP
"extra_data": "" # Dados extras do lead
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"id_lead": "", # ID do lead retornado do ERP
"obs": "" # Observação ou menssagem do ERP
} |
|
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 |
|---|
| {
"id_cliente": "", # ID do cliente no ERP
"id_servico": "", # ID do serviço do cliente no ERP
"id_tipo_de_atendimento": "", # ID do tipo de atendimento escolhido pelo cliente no ERP
"id_departamento": "", # ID do departamento escolhido pelo cliente no ERP
"id_funcionario": "", # ID do funcionário responsável no ERP
"email": "", # Email do cliente
"telefone": "", # Telefone do cliente
"assunto": "", # Assunto do chamado que o cliente esta abrindo
"mensagem": "", # Mensagem do chamado que o cliente esta abrindo
"anexo": [ # Anexos enviados pelo cliente (se a opção estiver [liberada)
{
"status_prospeccaoanexo": "", # Conteúdo do arquivo em "nome": "",base 64
"obs": "", } ] } |
|
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": "", # Observação do anexo
"nome_fantasia": "", "statusnome_prospeccaoanexo": "status_prospeccao"," "tipo_pessoa": "",
"cnpj_cpf": "", # Nome do anexo
"ie_identidade": "", }
"data_nascimento": "",]
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"dataid_cadastroatendiemnto": "", # ID do lead "id_revendedor": "id_revendedor",retornado do ERP
"id_origemobs": "id_origem"," "id_vencimento": "id_vencimento",
"cep": "",# 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 |
|---|
| {
"enderecoid_cliente": "", # ID "numero": "",
"bairro": "",do cliente no ERP
"cidade": "",
"id_cidadeservico": "id_cidade", # ID "complemento": "",
"referencia": "",do serviço do cliente no ERP
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"ufstatus": "", # Status "latitude": "",
"longitude": "",
"fone": "",
"telefone_comercial": "",do serviço após a chamada de ativação (se foi ativo ou não)
} |
|
| 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 |
|---|
| {
"telefoneid_celularprospecto": "", "whatsapp": "", "ramal": "",
"email": "",# ID do prospecto no ERP
"obsstatus_prospeccao": "",
"alerta": "",
"servicos": [
{
# ID do status do prospecto no ERP
"id_servicorevendedor": "", } # ID do revendedor ]
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {do ERP
"id_prospectoobs": "", "obs": ""
} |
|
Criar lead (POST):
...
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"nomestatus": "", # "nome_fantasia": "",
"tipo_pessoa": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_nascimento": "",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 |
|---|
| {
"dataid_cadastrocliente": "", "id_revendedor": "id_revendedor", "cep": "", # ID do cliente "endereco": "",no ERP
"numeronome": "", "bairro": "", "cidade": "", "id_cidade": "id_cidade", # Nome do cliente "complemento": "",no ERP
"referenciafantasia": "", "uf": "", "latitude": "",
"longitude": "", # Nome fantasia do cliente para empresa
"fonetipo_pessoa": "", "telefone_comercial": "", "telefone_celular": "",
"whatsapp": "", # Tipo da pessoa, Física ou Juridica
"ramalcnpj_cpf": "", "email": "", "obs": "", # CPF ou CNPJ "alerta": "",do cliente
"servicosie_identidade": ["", { # Inscrição Estadual parra clientes PJ (Opcional)
"idrg_orgao_servicoemissor": "", #
}
"inscricao_municipal": "", ]
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {#
"idcontribuinte_leadicms": "", "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 |
|---|
| { #
"id_clientenacionalidade": "id_cliente", "id_servico": "id_servico", "id_tipo_de_atendimento": "id_tipo_de_atendimento",#
"idcidade_departamentonaturalidade": "id_departamento", #
"idestado_funcionarionascimento": "id_funcionario", "email": "",#
"telefonedata_nascimento": "", "assunto": "",#
"mensagemestado_civil": "", "obs": "", "alerta": "",#
"anexoativo": "", [ { #
"anexoSexo": B64_DO_ARQUIVO"", "obs": "", #
"nome_anexoprofissao": "", } ]
} |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| {#
"iddata_atendiemntocadastro": "", "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_clientecep": "id_cliente",", "id_servico": "id_servico", } |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| { "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
| Expandir |
|---|
|
| Bloco de código |
|---|
| { #
"id_prospectoendereco": "", "status_prospeccao": "status_prospeccao", "id_revendedor": "id_revendedor",#
"obsnumero": "", "alerta": "", } |
|
| Expandir |
|---|
|
| Bloco de código |
|---|
| { "status": "",
} |
|
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_clientecomplemento": "", #
"nomebairro": "", #
"fantasiacidade": "", #
"tipo_pessoauf": "", "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": "",
} |
|
| Estado |
|---|
| colour | Purple |
|---|
| title | Prospecto |
|---|
|
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
...
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"status": "",
} |
|
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
...
| Expandir |
|---|
|
| Bloco de código |
|---|
| {
"status": "",
} |
|
| Estado |
|---|
| colour | Purple |
|---|
| title | Prospecto |
|---|
|
Status do Prospecto (GET):Request utilizada para receber o status atual do prospecto, mantendo o sistema da Datacake sincronizado com o ERP
...