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:
\nTexto / Alfanumérico - Campo alfanumérico permitindo letras, números e pontuação
\nNumero Inteiro / INT - Campo numérico permitindo apenas números.
\nEmail - Campo no formato suporte@eox.com.br
\nData - Data no formato YYYY-MM-DD.
\nDecimal / Valor - Campo no formato decimal no formato 999999.99 ( Utilizar . Ponto )
\nTelefone - Campo no formato DDD 912345678
\nAdicione / {nome_entidade} /info no final da URL e sera retornado todos os campos da tabela solicitada,
\nEX: https://api-integracao.vocallcontact.com.br/v1/empresa/info
\nVocê pode trocar a entidade empresa, por qualquer outra entidade.
\nTodas as respostas de sucesso retornan o mesmo modelo, a diferença esta no retorno dos erros
\nRetorno de erros
os erros são detalhados na resposta
Resposta de sucesso
Retorno com o total de requisições recebidas
Resposta de erro
Retorna os erros dentro de strings separadas
Adicione o parametro no header Return = resume
\nResposta de sucesso
Retorno com o total de requisições recebidas
Resposta de erro
Não será retornado o local especifico do erro, somente a quantidade de requisições recebidas e a quantidade de erros
As requisições são limitadas em 1000 nós (POST, PUT e PATCH)
\nEX: pode ser enviado ate mil empresas, ou 500 empresas e 500 contatos
\nPara evitar qualquer tipo de problema não é permitido o uso de caracteres especiais, principalmente nos campos que são tratados como chave primaria ou chave única, como por exemplo o campo codigo_empresa.
\nNÃO SÃO PERMITIDOS O USO DOS SEGUINTES CARACTERES
\n# \\ / : ; ? % & $ \" ' ´ ` * + = § ( ) { } [ ] º ª ! ~ ^ | < >
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33093380","collectionId":"5b61ba25-94c4-44ea-9567-5e43ca0f7d20","publishedId":"2sA3JKdMqb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-08T19:33:40.000Z"},"item":[{"name":"Empresa / Contato","item":[{"name":"Inserir","id":"370e2b5e-dc3d-45e3-b8d4-8e93e16fe204","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"user","value":"Requisição para a criação de registros de Empresas e Contatos.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","empresa"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"370e2b5e-dc3d-45e3-b8d4-8e93e16fe204"},{"name":"Alterar Empresa","id":"5d71c33e-58e7-4841-a2bf-19ccdb3faad2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Empresas.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","empresa"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d71c33e-58e7-4841-a2bf-19ccdb3faad2"},{"name":"Alterar Contato","id":"ad675320-ace4-4d97-8ed2-d0b3269dce54","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Contatos.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","contato"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad675320-ace4-4d97-8ed2-d0b3269dce54"},{"name":"Consulta Empresa","id":"f91724eb-8124-431d-bcbf-9b8661a4945e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Empresas.
\n","urlObject":{"protocol":"https","path":["v1","empresa"," {codigo_empresa}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f91724eb-8124-431d-bcbf-9b8661a4945e"},{"name":"Consulta Contato","id":"53871c7c-0145-4c6c-bcd4-d332c3aa493f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Contatos.
\n","urlObject":{"protocol":"https","path":["v1","contato"," {codigo_contato}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"53871c7c-0145-4c6c-bcd4-d332c3aa493f"},{"name":"Deletar Empresa","id":"6ca7cdc6-bf8b-4311-9bc7-0a9d38467b08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Empresas.
\n","urlObject":{"protocol":"https","path":["v1","empresa"," {codigo_empresa}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ca7cdc6-bf8b-4311-9bc7-0a9d38467b08"},{"name":"Deletar Contato","id":"967a8bf3-9818-44cd-a5b3-00c615fe66a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Contatos.
\n","urlObject":{"protocol":"https","path":["v1","contato"," {codigo_contato}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"967a8bf3-9818-44cd-a5b3-00c615fe66a5"}],"id":"711b263d-8019-4fc7-8305-8700f30c69f3","description":"Entidade onde serão cadastrados os clientes do tipo Pessoa Física/Jurídica e os Contatos da Empresa
\nPara empresas internacionais
\nEnviar o cnpj da empresa no campo cnpj
\nEnviar o pais no campo pais_faturamento que seja diferente de Brasil
\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 ou CPF do cliente, caso o pais_faturamento seja diferente de brasil, é aceito cnpj estrangeiro
inscricao_estadual: Inscrição estadual da empresa.
inscricao_municipal: Inscrição municipal da empresa
codigo_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, Se for diferente de (BRASIL, BRAZIL, BR ou BRA) a empresa é tratada como internacional, permitindo cnpj estrangeiro
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 à empresa
campo_complementar_2: Campo adicional para outras informações relacionadas à empresa
observacoes: Observações sobre a empresa.
DESCRIÇÃO DOS CAMPOS
\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 contato
email 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 de registros de Vendedores.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","vendedor"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f087aee7-2644-4306-8ed7-612993320253"},{"name":"Alterar","id":"165d4c34-fa10-4181-b196-e86aa5c88da1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Vendedores.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","vendedor"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"165d4c34-fa10-4181-b196-e86aa5c88da1"},{"name":"Consulta","id":"50192185-2717-4949-9f9c-9a83ff95b0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Vendedores.
\n","urlObject":{"protocol":"https","path":["v1","vendedor","{codigo_vendedor}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"50192185-2717-4949-9f9c-9a83ff95b0ec"},{"name":"Deletar","id":"7bbe8de1-0962-47b0-9f54-db98eec06b5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registrosde Vendedores.
\n","urlObject":{"protocol":"https","path":["v1","vendedor","{codigo_vendedor}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"7bbe8de1-0962-47b0-9f54-db98eec06b5a"}],"id":"3905b5fe-cbc5-4f31-8378-819166bdc0d0","description":"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 de registros de Pedidos e Itens dos Pedidos.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","pedido"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"c517e065-3d38-4836-a739-2952cdf81e13"},{"name":"Alterar Pedido","id":"ddf47564-4ef3-4541-8fd8-34df048e8a15","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Pedidos.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","pedido"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"ddf47564-4ef3-4541-8fd8-34df048e8a15"},{"name":"Alterar Item","id":"85c592fa-7d9c-4d53-a0fe-020b77449ffb","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Itens dos Pedidos.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","itens_pedido"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"85c592fa-7d9c-4d53-a0fe-020b77449ffb"},{"name":"Consulta Pedido","id":"f2536bf1-c1e9-4810-90aa-d558146fc650","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Pedidos.
\n","urlObject":{"protocol":"https","path":["v1","pedido"," {codigo_pedido}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2536bf1-c1e9-4810-90aa-d558146fc650"},{"name":"Consulta Item","id":"c2cd1c24-8a6a-4de7-a265-be84c9407d86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Itens dos Pedidos.
\nPara consultar todos os itens, apenas não preencha o campo item na URL
\n","urlObject":{"protocol":"https","path":["v1","itens_pedido"," {codigo_pedido} "," {Item}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2cd1c24-8a6a-4de7-a265-be84c9407d86"},{"name":"Deletar Pedido","id":"91be8712-3a7f-4bd4-b8e4-aaba7229d337","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Pedidos.
\nAo Deletar um pedido, Todos os itens do mesmo serão apagados automaticamente
\n","urlObject":{"protocol":"https","path":["v1","pedido"," {codigo_pedido}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"91be8712-3a7f-4bd4-b8e4-aaba7229d337"},{"name":"Deletar Item","id":"90611979-4428-4c90-b4c5-beb037958567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Itens dos Pedidos.
\n","urlObject":{"protocol":"https","path":["v1","itens_pedido"," {codigo_pedido} "," {item}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"90611979-4428-4c90-b4c5-beb037958567"}],"id":"859f8d9b-4c7b-402a-89db-9aacaf98ca35","description":"Entidade onde serão cadastrados os pedidos dos clientes e os itens dos pedidos.
\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.
total_pedido: Este campo deve conter o valor total a ser considerado como venda (meta do vendedor), excluindo os itens de amostras, brindes, devoluções, quando aplicável. Verificar também o campo total_bruto_pedido..
\nvalor_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.
codigo_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 de registros de Notas e Itens de Notas.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","nota"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"49996545-42be-4c88-8bbb-a03e08b0c468"},{"name":"Alterar Nota","id":"69a940a0-442a-41e2-8e6b-761a06e13ee6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Notas.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","nota"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"69a940a0-442a-41e2-8e6b-761a06e13ee6"},{"name":"Alterar Item","id":"05e67a43-dd5b-4d14-b579-15967b575f67","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Itens das Notas.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","itens_nota"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"05e67a43-dd5b-4d14-b579-15967b575f67"},{"name":"Consulta Nota","id":"3367003b-0916-471e-944a-f43af2e98f47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Notas.
\n","urlObject":{"protocol":"https","path":["v1","nota"," {codigo_nota}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"3367003b-0916-471e-944a-f43af2e98f47"},{"name":"Consulta Item","id":"0d709b5d-cb2b-4067-9029-92434c3718bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Itens das Notas.
\nPara consultar todos os itens, apenas não preencha o campo item na URL
\n","urlObject":{"protocol":"https","path":["v1","itens_nota"," {codigo_nota} "," {Item}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d709b5d-cb2b-4067-9029-92434c3718bb"},{"name":"Deletar Nota","id":"d303ed42-1dd1-4e10-ad2d-17d356a3a7b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Notas.
\nAo Deletar uma Notas, Todos os itens do mesmo serão apagados automaticamente
\n","urlObject":{"protocol":"https","path":["v1","nota"," {codigo_nota}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"d303ed42-1dd1-4e10-ad2d-17d356a3a7b7"},{"name":"Deletar Item","id":"de8b6f02-7911-4e8d-b100-c2e53c9743a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Itens das Notas.
\n","urlObject":{"protocol":"https","path":["v1","itens_nota"," {codigo_nota} "," {item}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"de8b6f02-7911-4e8d-b100-c2e53c9743a9"}],"id":"8d91acac-995a-493e-824b-59fcafadd8d9","description":"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 nota
chave_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 ISSQN
informacoes_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 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 da nota.
previsao_entrega: Previsão de entrega da mercadoria.
codigo_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 de registros de Fatura.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","fatura"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ee4ed40-a9d5-4303-ad90-db0b6276916d"},{"name":"Alterar","id":"b96ab358-99ed-4ca4-b8eb-5177c02929a5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Fatura.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","fatura"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"b96ab358-99ed-4ca4-b8eb-5177c02929a5"},{"name":"Consulta","id":"a2683798-2e2a-4347-b8d7-04849c8400fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros da Fatura.
\n","urlObject":{"protocol":"https","path":["v1","fatura","{codigo_fatura}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2683798-2e2a-4347-b8d7-04849c8400fa"},{"name":"Deletar","id":"537041f1-6a36-4a5f-b527-205e8aef7d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros da Fatura.
\n","urlObject":{"protocol":"https","path":["v1","fatura","{codigo_fatura}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"537041f1-6a36-4a5f-b527-205e8aef7d54"}],"id":"6c9ba58b-7b6d-4439-b0b1-872c985ad211","description":"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 fatura
desconto_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 de registros de Cotações e itens da cotação
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","cotacao"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"7823b60f-eb9b-4c04-acdb-4616d17a9d83"},{"name":"Alterar Cotação","id":"576e0db7-0c8d-435f-bb36-61737a73569e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","cotacao"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"576e0db7-0c8d-435f-bb36-61737a73569e"},{"name":"Alterar Item","id":"a79417f6-5cc6-41bb-a467-f9dcebed5126","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de itens da Cotação.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","iten_cotacao"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"a79417f6-5cc6-41bb-a467-f9dcebed5126"},{"name":"Consulta Cotacao","id":"20a8b6ea-15af-4890-8756-868b7af31308","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros da Cotação.
\n","urlObject":{"protocol":"https","path":["v1","cotacao","{codigo_cotacao}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"20a8b6ea-15af-4890-8756-868b7af31308"},{"name":"Consulta Item","id":"6f5e9fa5-3d14-43f5-b4eb-0202ea309936","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de todos os registros dos itens de uma Cotação.
\nPara consultar todos os itens, apenas não preencha o campo item na URL
\n","urlObject":{"protocol":"https","path":["v1","itens_cotacao"," {codigo_cotacao} "," {Item}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f5e9fa5-3d14-43f5-b4eb-0202ea309936"},{"name":"Deletar Cotacao","id":"7be94bee-3ead-4a86-a840-0c0d4ab48e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de uma Cotação.
\nAo Deletar uma Cotação, Todos os itens do mesmo serão apagados automaticamente
\n","urlObject":{"protocol":"https","path":["v1","cotacao","{codigo_cotacao}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"7be94bee-3ead-4a86-a840-0c0d4ab48e71"},{"name":"Deletar Item","id":"9d604ad9-fab5-4362-885e-36963d1b4584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Itens.
\n","urlObject":{"protocol":"https","path":["v1","iten_cotacao"," {codigo_cotacao} "," {item} "],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d604ad9-fab5-4362-885e-36963d1b4584"}],"id":"94d2a8fe-d439-40bd-b499-57eb5d067f9d","description":"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.
codigo_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.
Requisição para a criação de registros de Fornecedor.
\nLimitado em 5.000 (cinco mil) registros.
\n","urlObject":{"protocol":"https","path":["v1","fornecedor"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9410f89-0ddb-439b-b667-09aa4cb419ac"},{"name":"Alterar","id":"2c61b357-a0be-41b2-a94c-17052c6efe54","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Fornecedores.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","fornecedor"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c61b357-a0be-41b2-a94c-17052c6efe54"},{"name":"Consulta","id":"eeca0c55-004b-4eee-a2da-2f129fa328cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Fornecedores.
\n","urlObject":{"protocol":"https","path":["v1","fornecedor","{codigo_fornecedor}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"eeca0c55-004b-4eee-a2da-2f129fa328cd"},{"name":"Deletar","id":"f174e058-e37a-4bd5-b28c-7e2b21fc0702","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Fornecedores.
\n","urlObject":{"protocol":"https","path":["v1","fornecedor","{codigo_fornecedor}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f174e058-e37a-4bd5-b28c-7e2b21fc0702"}],"id":"6119b2c7-918c-48c4-9fac-2c9ad467dcf0","description":"Entidade onde serão cadastrados os Fornecedores do tipo Pessoa Jurídica
\ncodigo_fornecedor: Código único do Fornecedor. Será utilizado posteriormente para as atualizações, pode ser o ID do SISTEMA LEGADO ou o CNPJ somente com números.
\nrazao_social: Razão social do fornecedor.
\nnome_fantasia: Nome fantasia do fornecedor.
\ncnpj: CNPJ da empresa, caso seja MEI também aceitará o CPF.
\ninscricao_estadual: Inscrição estadual do fornecedor.
\ninscricao_municipal: Inscrição municipal do fornecedor.
\ncodigo_cnae: Código CNAE do fornecedor.
\ncodigo_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_fornecedor da respectiva matriz.
\nemail: E-mail principal do fornecedor.
\nemail_alternativo: E-mail alternativo do fornecedor.
\ntelefone_principal: Telefone principal do fornecedor.
\ntelefone_alternativo: Telefone alternativo do fornecedor
\nwhatsapp: Telefone WhatsApp do fornecedor.
\nsite: Website do fornecedor.
\nlogradouro: Logradouro do endereço do fornecedor.
\nnumero: Número do endereço do fornecedor.
\ncomplemento: Complemento do endereço do fornecedor.
\nbairro: Bairro do endereço do fornecedor.
\ncep:: CEP do endereço do fornecedor.
\ncidade: Cidade do endereço do fornecedor.
\nuf: UF do endereço do fornecedor.
\npais:: País do endereço do fornecedor.
\ncampo_complementar: Campo adicional para outras informações relacionadas ao fornecedor
\ncampo_complementar_2: Campo adicional para outras informações relacionadas ao fornecedor
\nRequisição para a criação de registros de Bloqueios.
\n","urlObject":{"protocol":"https","path":["v1","empresa_marca"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"839729e9-faeb-4c02-835b-f04d3074a777"},{"name":"Alterar","id":"f199001b-e9d3-4c9a-8bd8-caaf8ee152ab","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"user","value":"Requisição para a alteração de registros de Bloqueios.
\nLimitado em 1.000 ( mil ) registros.
\n","urlObject":{"protocol":"https","path":["v1","empresa_marca"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f199001b-e9d3-4c9a-8bd8-caaf8ee152ab"},{"name":"Consulta","id":"1831a41c-5a27-4fb8-a0ea-158ec008d0fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user","value":"Requisição para leitura de registros de Bloqueios.
\n","urlObject":{"protocol":"https","path":["v1","empresa_marca"," {codigo_empresa}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1831a41c-5a27-4fb8-a0ea-158ec008d0fb"},{"name":"Deletar","id":"429e3669-9a2d-4050-8b81-fe871d831b5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user","value":"Requisição para exclusão de registros de Bloqueios.
\n","urlObject":{"protocol":"https","path":["v1","empresa_marca"," {codigo_empresa}"],"host":["api-integracao","vocallcontact","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"429e3669-9a2d-4050-8b81-fe871d831b5a"}],"id":"efaf4647-879a-4dd1-a582-c9f7576804c9","description":"Entidade onde e cadastrado os bloqueios de clientes
\n","_postman_id":"efaf4647-879a-4dd1-a582-c9f7576804c9"}]}