A fim de melhorar a automatização do processo de atendimento ao cliente e garantir o sucesso da operação, o sistema VocallContact disponibiliza integrações dinâmicas.
\nAqui está o escopo e especificação da API RESTful de integração VocallContact. A metodologia utilizada é REST e significa Representational State Transfer. Em português, Transferência de Estado Representacional. Trata-se de uma abstração da arquitetura da Web. Resumidamente, o REST consiste em princípios/regras/constraints que, quando seguidas, permitem a criação de um projeto com interfaces bem definidas. Desta forma, permitindo, por exemplo, que aplicações se comuniquem.
\nA integração disponibiliza a manutenção completa dos cadastros de Empresas, Contatos, Vendedores, Pedidos, Notas Fiscais e Faturas (Duplicatas) dentro da ferramenta VocallContact, onde é possível criar, ler, alterar e excluir registros de todas as entidades.
\nCada cliente do VocallContact tem um usuário e uma chave única (token) para acesso aos métodos da API, esta chave será fornecida no início do contrato.
\nPara os campos das entidades, temos os seguintes tipos mapeados:
\nRequisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["empresa"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"55d34e80-17a3-444c-8623-beef7655e656"},{"name":"Delete","id":"539912bb-3ae4-4a5d-b849-eb6daa449ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["empresa","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["empresa","Entidade onde serão cadastrados os clientes do tipo Pessoa Física/Jurídica
\ncodigo_empresa: Código único da empresa. Será utilizado posteriormente para as atualizações, pode ser o ID do SISTEMA LEGADO ou o CNPJ somente com números.tipo_relacao: Tipo de relação da empresa com sua operação. Exemplos: Cliente, Fornecedor, etc.codigo_vendedor: Código do vendedor responsável pela empresa no SISTEMA LEGADO.razao_social: Razão social da empresa.nome_fantasia: Nome fantasia da empresa.cnpj: CNPJ da empresa, caso seja MEI também aceitará o CPF.inscricao_estadual: Inscrição estadual da empresa.inscricao_municipal: Inscrição municipal da empresacodigo_cnae: Código CNAE da empresa.codigo_empresa_matriz: ID da matriz do grupo caso haja Hierarquia Matriz X Filial. Se o cadastro trata-se de uma filial, informar aqui o mesmo valor enviado no codigo_empresa da respectiva matriz.restricao: Campo para informar se o cliente tem alguma restrição. Qualquer valor informado neste campo deixará o cliente como restrito para contato.data_fundacao: Data da fundação da empresa.setor: Setor da empresa.segmento: Segmento da empresa.ramo_atividade: Ramo de atividade da empresa.porte: Porte da empresa.nivel_relacionamento: Nível de relacionamento do cliente (ouro, prata, bronze, etc.)email: E-mail principal da empresa.email_alternativo: E-mail alternativo da empresa.telefone_principal: Telefone principal da empresa.telefone_alternativo_1: Telefone alternativo da empresa.telefone_alternativo_2: Telefone alternativo adicional da empresa.whatsapp: Telefone WhatsApp da empresa.site: Website da empresa.logradouro_faturamento: Logradouro do endereço de faturamento da empresa.numero_faturamento: Número do endereço de faturamento da empresa.complemento_faturamento: Complemento do endereço de faturamento da empresa.bairro_faturamento: Bairro do endereço de faturamento da empresa.cep_faturamento: CEP do endereço de faturamento da empresa.cidade_faturamento: Cidade do endereço de faturamento da empresa.uf_faturamento: UF do endereço de faturamento da empresa.pais_faturamento: País do endereço de faturamento da empresa.logradouro_entrega: Logradouro do endereço de entrega da empresa.numero_entrega: Número do endereço de entrega da empresa.complemento_entrega: Complemento do endereço de entrega da empresa.bairro_entrega: Bairro do endereço de entrega da empresa.cep_entrega: CEP do endereço de entrega da empresa.cidade_entrega: Cidade do endereço de entrega da empresa.uf_entrega: UF do endereço de entrega da empresa.pais_entrega: País do endereço de entrega da empresa.data_cadastro: Data de cadastro da empresa no SISTEMA LEGADO.limite_credito: Limite de crédito da empresa.saldo_disponivel: Saldo disponível para compras da empresa.data_ultimo_pedido: Data do último pedido feito para a empresa.valor_ultimo_pedido: Valor do último pedido feito para a empresa.data_ultimo_faturamento: Data do último faturamento feito para a empresa.valor_ultimo_faturamento: Valor do último pedido feito para a empresa.situacao_financeira: Situação financeira da empresa. Informar ‘A’ para adimplente e ‘I’ para inadimplente.campo_complementar: Campo adicional para outras informações relacionadas à empresacampo_complementar_2: Campo adicional para outras informações relacionadas à empresaobservacoes: Observações sobre a empresa.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["contato"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"70a2a281-5ce6-4784-971f-96ac3de089bf"},{"name":"Delete","id":"0b3a41a4-314a-4a2c-aae9-1e12bf859208","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["contato","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["contato","Entidade onde serão cadastrados os contatos dos clientes do tipo Pessoa Juridica.
\ncodigo_empresa Código da empresa no sistema legado relacionado ao contato. Devesse usar o mesmo valor informado no campo codigo_empresa no cadastro da empresa no VocallContact.codigo_contato Código único do contato no SISTEMA LEGADO. Será utilizado posteriormente para as atualizações.nome Nome do contatoemail E-mail do contato.email_alternativo E-mail alternativo do contato.cargo Cargo do contato.telefone_principal Telefone principal do contato. telefone_celular Telefone alternativo do contato.telefone_alternativo Telefone alternativo do contato.telefone_residencial Telefone alternativo adicional do contato.whatsapp Telefone WhatsApp do contato.observacoes Observações sobre o contato.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["vendedor"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3c903f1-1893-4c52-8a41-0a425f88dd20"},{"name":"Delete","id":"688b899e-8dff-46a3-b439-7cb5a6558a7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["vendedor","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["vendedor","Entidade onde serão cadastrados os vendedores que serão vinculados às empresas.
\ncodigo_vendedor: Código do vendedor no SISTEMA LEGADO que será relacionado aos usuários do sistema. Deve ser informado o mesmo valor informado no campo codigo_vendedor no cadastro da empresa no VocallContact.nome: Nome do vendedor.email: E-mail do vendedor.codigo_gestor: Código do gestor responsável pelo vendedor.nome_gestor: Nome do gestor responsável pelo vendedor.email_gestor: E-mail do gestor responsável pelo vendedor.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["pedido"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"b444fcb6-ae32-4a2b-8948-ee6ae509b63e"},{"name":"Delete","id":"6ab2b312-76d6-4edc-a96f-1f501ccab9a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["pedido","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["pedido","Entidade onde serão cadastrados os pedidos dos clientes.
\ncodigo_filial: Código da filial responsável pelo pedido.codigo_pedido: Código interno do pedido.documento: Código do pedido que será exibido no CRM.codigo_empresa: Deve ser informado o mesmo valor do campo codigo_empresa do cadastro da empresa no VocallContact.marca: Marca relacionada ao pedido.data_pedido: Data do pedido.data_entrega: Data da entrega do pedido.total_bruto_pedido: Este campo deverá conter a soma de todos os itens do pedido, incluindo amostras, brindes, devoluções.valor_total_desconto: Valor total do desconto do pedido.total_faturado: Neste campo deve conter o valor total que já foi emitido NF deste pedido, quando existir faturamento parcial no pedido.saldo_faturar: Neste campo deve conter o saldo a faturar, quando existir faturamento parcial no pedido.qtd_itens: Soma da quantidade de itens do pedido.qtd_itens_recusa: Quantidade de itens recusados do pedido.qtd_itens_faturado: Quantidade de itens faturados do pedido.prazo: Prazo de pagamento do pedido.parcelas: Quantidade de parcelas do pedido.comprador: Nome do comprador responsável pelo pedido.codigo_vendedor: Deve ser informado o mesmo valor do campo codigo_vendedor informado no cadastro dos vendedores.situacao: Descrição do status do pedido.considerar_venda: S ou N, campo para informar se este pedido deve ser considerado nas estatísticas de vendas e categorização do cliente.venda_apoio: S ou N, Se o pedido deve ser considerado na contagem de vendas apoio do televendas no cliente do representante.observacoes: Observações do pedido.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["itempedido"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"45586efe-2b48-49dc-81e1-535d508cc112"},{"name":"Delete","id":"efbeddfb-8d31-4c33-a034-80ba01ca9a27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["itempedido","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["itempedido","Entidade de cadastro dos itens dos pedidos das empresas.
\ncodigo_filial: Código da filial responsável pelo pedido.codigo_pedido: Código interno do pedido.item: Sequencial do item do pedido.codigo_produto: Código do item do pedido.unidade_medida: Unidade de medida do item.quantidade: Quantidade adquirida do item.descricao: Descrição do item.grupo_produto: Grupo de produto do item.valor_unitario: Valor unitário do item.valor_total: Valor total do item.percentual_desconto: Percentual de desconto concedido ao item.data_entrega: Data de entrega do item.base_calculo_icms: Base de cálculo ICMS do item.valor_icms: Valor do ICMS do item,aliquota_icms: Aliquota ICMS do item.valor_ipi: Valor do IPI do item.aliquota_ipi: Aliquota IPI do item.base_calculo_icms_st: Base de cálculo do ICMS ST do item.valor_icms_st: Valor do ICMS ST do item.ncm: NCM do item.sequencia_entrega: Sequência de entrega do item.observacoes: Observações do item.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["nota"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc00e90a-1893-4158-8832-5716eeb66a49"},{"name":"Delete","id":"94d16972-1cbb-4561-b89a-6a0fe9dbfc1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["nota","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["nota","Entidade onde serão cadastradas as notas fiscais dos clientes.
\ncodigo_filial: Código da filial responsável pela nota.codigo_nota: Código da nota fiscal.codigo_empresa: Deve ser informado o mesmo valor do campo codigo_empresa do cadastro da empresa no VocallContact.documento: Código da nota que será exibido no CRM.serie: Série da nota fiscal.num_fatura: Número da fatura relacionada à nota fiscal.codigo_vendedor: Deve ser informado o mesmo valor do campo codigo_vendedor informado no cadastro dos vendedores.total_nota: Total da nota para considerar como venda. Irá contar para a meta do vendedor.situacao: Descrição do status da nota.comprador: Nome do comprador responsável pela nota.tipo_nota: Tipo de notachave_acesso: Chave de acesso da nota.natureza_operacao: Natureza da operação da nota.data_emissao: Data de emissão da nota.data_saida: Data no qual o produto foi entregue.hora_saida: Horário de entrega do produto.qtd_volumes: Quantidade de volumes da nota.especie_volumes: Tipo de carga.peso_bruto: Peso bruto do produto.peso_liquido: Peso líquido do produto.tipo_frete: Tipo de frete da nota.transportadora: Nome da transportadora responsável pela entrega do produto.data_recebimento: Data de recebimento do produto.valor_frete: Valor em reais do frete.valor_seguro: Valor em reais do seguro.descontos: Descontos concedidos na nota.outras_despesas: Outras despesas da nota.base_calculo_icms: Base de cálculo ICMS da nota.valor_icms: Valor em reais do ICMS da nota.base_calculo_icms_st: Valor em reais do ICMS ST da nota.valor_icms_st: Valor em reais do ICMS ST da nota.valor_total_tributos: Valor total em reais dos tributos da nota.valor_total_produtos: Valor total em reais dos produtos da nota.valor_ipi: Valor em reais do IPI da nota.valor_total_nota: Valor total em reais da nota.valor_total_servicos: Valor total em reais dos serviços da nota.base_calculo_issqn: Valor da base de cálculo para o ISSQN.valor_isqn: Valor em reais do ISSQNinformacoes_complementares: Informações complementares da nota.parcelas: Quantidade de parcelas da nota.prazo: Prazo de pagamento da nota.considerar_venda: S ou N, campo para informar se este pedido deve ser considerado nas estatísticas de vendas e categorização do clientevenda_apoio: S ou N, Se o pedido deve ser considerado na contagem de vendas apoio do televendas no cliente do representante.observacoes: Observações da nota.previsao_entrega: Previsão de entrega da mercadoria.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["itemnota"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"bebe72dd-7cf5-4279-977c-7b1d875af550"},{"name":"Delete","id":"1d18fa21-a7a4-4ade-9673-596cae8c42ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["itemnota","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["itemnota","Entidade de cadastro dos itens das notas fiscais das empresas.
\ncodigo_filial: Código da filial responsável pela nota.codigo_nota: O mesmo do endpoint de notas fiscais.item: Sequencial do item da nota.lote: Lote do item.codigo_produto: Código interno do item.descricao: Descrição do item.ncm: Nomenclatura Comum do Mercosul.cst: Código de Situação Tributária.cfop: Código Fiscal de Operações e Prestação.unidade_medida: Unidade de medida do item.quantidade: Quantidade adquirida do item.grupo_produto: Nome do grupo do item.base_calculo_icms: Base de cálculo do ICMS do item.valor_icms: Valor do ICMS do item.aliquota_icms: Alíquota ICMS do item.valor_ipi: Valor do IPI do item.aliquota_ipi: Alíquota do IPI do item.valor_unitario: Valor unitário do item.valor_total: Valor total dos itens.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["fatura"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"706cf6ff-d75d-499f-aa4c-8dc766a766e2"},{"name":"Delete","id":"183fd09e-4608-411b-84ba-ba1e2736af93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["fatura","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["fatura","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["fatura","Entidade de cadastro das faturas (duplicatas) dos clientes.
\ncodigo_filial: Código da filial responsável pela fatura.codigo_fatura: Código da fatura.parcela: Parcela relacionada à fatura.codigo_empresa: Deve ser informado o mesmo valor do campo codigo_empresa do cadastro da empresa no VocallContact.numero_documento: Número do documento.data_faturamento: Data do faturamento.nosso_numero: Identificação única do emissor do documento.data_vencimento: Data de vencimento da fatura.valor_documento: Valor da fatura.data_pagamento: Data do pagamento da faturadesconto_abatimento: Desconto abatido na fatura.mora_multa: Juros moratórios da fatura.valor_pagamento: Valor pago da fatura.outros_acrescimos: Outros acréscimos da fatura.observacoes: Observações da fatura.Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["cotacao"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1dda7a0a-7cf8-4aa6-8584-c897e3dd0ba9"},{"name":"Delete","id":"64d0b4c0-dac3-4596-9e8f-4b894d35bd4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["cotacao","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["cotacao","Entidade de cadastro das cotações das empresas.
\ncodigo_filial: Código da filial responsável pela nota.
codigo_cotacao: Código da cotação.
documento: Código da cotação que será exibido no CRM.
data_cotacao: Data da criação da cotação.
total_cotacao: Valor total da cotação.
parcelas: Total de parcelas da cotação.
prazo: Prazo de pagamento da cotação.
codigo_empresa: Código da empresa no sistema legado relacionado ao contato. Devesse usar o mesmo valor informado no campo codigo_empresa no cadastro da empresa no VocallContact.
comprador: Nome do comprador responsável pela cotação.
codigo_vendedor: Deve ser informado o mesmo valor do campo codigo_vendedor informado no cadastro dos vendedores.
observacoes: Observações da cotação.
situacao: Descrição do status da cotação.
Requisição para a criação e alteração de registros.
\n","urlObject":{"protocol":"https","path":["itemcotacao"],"host":["integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"31781f05-74a0-41d7-99e3-3986f5966ba4"},{"name":"Delete","id":"d6ee0f93-5472-482a-ab53-49d7b30770a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros.
\n","urlObject":{"protocol":"https","path":["itemcotacao","Requisição para leitura de registro(s).
\n","urlObject":{"protocol":"https","path":["itemcotacao","Entidade de cadastro dos itens das cotações das empresas.
\ncodigo_filial: Código da filial responsável pela cotação.codigo_cotacao: Código da cotação.item: Sequencial do item da cotação.codigo_produto: Código interno do item.unidade_medida: Unidade de medida do item.quantidade: Quantidade deste mesmo item cotada.descricao: Descrição do item.grupo_produto: Nome do grupo do item.valor_unitario: Valor unitário do item.valor_total: Valor total dos itens.