Skip to main content
Atualização de Janeiro de 2026 A versão 3.1 traz uma revisão completa para garantir a compatibilidade com a versão 2 da API do ERP, equiparando funcionalidades, trazendo novos campos, filtros e evoluindo as documentações. Além disso, traz novos recursos como gestão completa do CRM, inclusão de NFC-e (PDV); cancelamento de notas fiscais via XML; detalhamento de impostos a nível de item da nota fiscal (incluindo tributos da Reforma Tributária), entre outras diversas melhorias listadas abaixo.

​
Novos Módulos e Funcionalidades

​
Módulo CRM (Novo)

Foi adicionado um conjunto completo de endpoints para gestão de relacionamento com o cliente:
  • Assuntos: Criação, listagem, detalhamento, atualização, exclusão e arquivamento de assuntos de CRM (/crm/assuntos).
  • Ações: Gestão de atividades vinculadas a assuntos (agendamento, conclusão e histórico) (/crm/assuntos/{idAssunto}/acoes).
  • Anotações: Registro de notas internas em assuntos (/crm/assuntos/{idAssunto}/anotacoes).
  • Estágios do Funil: Cadastro e manutenção de estágios de venda (/crm/estagios).
  • Marcadores: Gestão de etiquetas coloridas para organização de assuntos (/crm/assuntos/{idAssunto}/marcadores).
  • Favoritos: Endpoint para marcar/desmarcar assuntos com “estrela” (/crm/assuntos/{idAssunto}/estrela).

​
Módulo de Usuários (Novo)

  • Listagem de Usuários: Novo endpoint GET /usuarios para listar usuários da conta, permitindo filtrar por nome, ID e tipo (Vendedor, Contador ou Padrão).

​
Alterações em Endpoints Existentes

​
Notas Fiscais

  • Nova Operação de Rastreio: Adicionado PUT /notas/{idNota}/despacho para atualizar informações de rastreamento (código, URL, transportadora, pesos e volumes).
  • Novo Endpoint de Cancelamento: Adicionado POST /notas/xml/cancelar permitindo o cancelamento de uma nota diretamente via envio de XML.
  • Nota fiscal de Consumidor (NFC-e): Adicionado POST /notas/nota-fiscal-consumidor/xml para inclusão de XMLs de Notas Fiscais de Consumidor.
  • Tributação (IBS/CBS): O modelo de dados dos itens da nota (NotaFiscalItemModelResponse) agora inclui campos para a reforma tributária: ibsCbsIs (CST, valor CBS, valor IBS).

​
Pedidos de Venda

  • Gestão de Produção: Adicionado POST /pedidos/{idPedido}/gerar-ordem-producao, permitindo gerar ordens de produção a partir de itens de um pedido de venda.
  • Filtros de Listagem: O endpoint GET /pedidos agora possui o filtro origemPedido (0 = Pedido de Venda, 1 = PDV). Com isso, agora é possível buscar vendas e pré-vendas originadas de PDV através da rota de pedidos.

​
Produtos e Variações

  • Limite de caracteres na descrição complementar: Removida a limitação, permitindo grandes textos na descrição complementar dos produtos.
  • Busca por produto nas listas de preços: O endpoint GET /listas-precos/{idListaDePreco} agora possui filtro por id de produto.
  • Gestão das tags de produtos: O endpoint POST /tags agora permite a gestão completa das tags de produtos, tanto para vínculo quanto criação.

​
Contatos

  • Status CRM: Adicionado PUT /contatos/{idContato}/status-crm para alterar o estágio do contato entre Lead, Prospect, Cliente ou Inativo.
  • Filtros Adicionais: A listagem de contatos agora permite filtrar por idVendedor e statusCrm.

​
Separação

  • Listagem da separação: O endpoint GET /separacao agora traz a origem da separação e a data de emissão do documento.
  • Detalhes da separação: O endpoint GET /separacao/{idSeparacao} agora inclui o usuário que realizou a embalagem, os dados da origem e a descrição da forma de frete utilizada.

​
Atualização nas documentações

Em diversos endpoints, as documentações não traziam clareza sobre quais parâmetros e métodos eram permitidos. Realizamos diversas atualizações para que a referência da API seja clara e condizente com o funcionamento.
  • Validações: Diversos campos em modelos foram marcados como required, tornando mais claro quais atributos são realmente obrigatórios.
  • Exemplos: Adicionados exemplos de datas com seus respectivos formatos (ex yyyy-mm-dd) em quase todos os parâmetros de consulta de data.
  • Paginação: Padronização do objeto paginacao em todas as respostas de listagem que utilizam modelos de paginação.
  • Enums Descritivos: Adicionados enums em vários campos (como situações de pedidos e ordens de serviço) para facilitar a interpretação dos códigos numéricos.