Como enviar XMLs para o Onvio no Fiscal.io Monitor (Integração via Domínio: Onvio API)

Este artigo apresenta o procedimento revisado para configurar e utilizar o envio de XMLs do Fiscal.io Monitor para a plataforma Onvio por meio da integração via Domínio: Onvio API.

Para quem se aplica

• Objetivo: Enviar arquivos XML de documentos fiscais para a plataforma Onvio.
• Perfis: Fiscal, Administrativo, Implantação/Onboarding ou perfis equivalentes com acesso a integrações.
• Permissões: Acesso ao módulo Integrações e permissão para configurar canais/rotinas.
• Execução: A rotina é executada na máquina definida no campo local.

Pré-requisitos

• Chave/Token da API do Onvio: Deve existir para cada empresa participante, conforme a configuração do Onvio.
• Internet para o Domínio/Onvio: A máquina definida em local precisa conseguir se comunicar com as APIs necessárias.
• Acesso á API da Fiscal.io: A máquina também precisa conseguir se comunicar com a API da Fiscal.io, utilizando o token da integração quando aplicável.
• Recurso contratado: O recurso Domínio: Onvio API precisa estar liberado no plano/contrato utilizado.
• Canal de saída: Deve estar configurado para trabalhar com XML de documentos fiscais.

Quando o envio é executado

O envio segue o fluxo do canal de saída: a frequência configurada e o processamento da fila/tarefas determinam quando os arquivos serão processados. Além disso, existe a possibilidade de realizar o envio manualmente pelo menu Integrar. Contudo, não considere o recebimento do XML pelo Fiscal.io como um gatilho de envio necessariamente imediato.

Caminho de acesso

1. No Fiscal.io Monitor, acesse no menu a opção Integrar.
2. Clique em Gerenciar Canais de Integração.
3. No campo Objetivo, selecione enviar arquivos XML.
4. No campo Meio, selecione Integração via Domínio : Onvio API.
5. Atalho: Quando disponível, também é possível utilizar o atalho +Domínio para acessar a configuração.

Como utilizar (passo a passo)

1) Acessar o gerenciador de canais

No menu superior da aplicação, clique em integrar e, em seguida clique sobre Gerenciar Canais de Integração.

2) Ajustar o Objetivo e o Meio de Comunicação

Na janela de configuração do canal:

• No campo Objetivo, abra o menu suspenso e escolha a opção Enviar arquivos XML.
• No campo Meio, abra o menu suspenso e escolha a opção Integração via Domínio : Onvio API.
• No campo Local, selecione o computador/servidor responsável por executar a rotina.
  

3) Cadastrar as Chaves da API do Onvio

Na aba Domínio : Onvio API, preencha a tabela de habilitação por empresa.

Filial (CNPJ/CPF): A filial/empresa já é carregada automaticamente a partir das empresas configuradas no canal. Não é necessário inserir ou selecionar o CNPJ/CPF nessa tabela.

Chave: Cole a chave/token da API do Onvio correspondente á respectiva empresa, gerada previamente no painel do Onvio em API > Chaves.

4) Configurar opções adicionais e finalizar

Abaixo da tabela de chaves, configure as opções específicas conforme a necessidade do seu escritório:

• Confirmar entrega:
  • Marcado: O envio é realizado em duas etapas (1º envia o arquivo e obtém um ID de rastreio; 2º confirma o processamento do lote pelo Onvio na etapa seguinte).
  • Desmarcado: Realiza apenas o envio inicial (Etapa 1).
• Enviar cópia para BOX-e:
  • Marque esta opção somente se a empresa/escritório possuir licença ativa do produto BOX-e (Ferramenta da Domínio/Thomson Reuters para armazenamento de documentos fiscais por 5 anos).

Após preencher as chaves e marcar as opções desejadas, clique no botão Salvar no canto superior direito da janela para concluir a integração.

Cadastrar as chaves da API do Onvio

Na aba Domínio: Onvio API, a grade de empresas/Filiais é formada a partir das empresas já vinculadas ao canal.

Filial: a filial/empresa já vem das empresas coniguradas no canal. Não é necessário inserir ou selecionar o CNPJ/CPF nessa tabela.

Chave: Cole na linha correspondente a chave/token da API do Onvio da respectiva empresa.

Atenção: A chave deve corresponder á empresa/filial indicada na linha. Uma chave de outra empresa pode causar falha de autenticação ou rejeição.

Filtros de conteúdo

Os filtros do canal determinam quais documentos entram na fila de envio. Para esta integração, considere especialmente:

• Tomador: É contemplado no padrão do canal de saída.
• Terceiros: Somente devem entrar quando essa opção estiver habilitada/marcada no canal.
• Emitidos pela empresa / emitidos por terceiros: quando esses filtros estiverem disponíveis no canal, configure-os conforme a regra de negócio desejada.
• Eventos: Não fazem parte desta integração.

Testar Conexão

Após preencher as chaves e marcar as opções desejadas, clique no botão Testar Conexão para validar a comunidação e a autenticação da integração antes do processamento dos arquivos.

Após o teste, clique no botão Salvar, no canto superior direito da janela, para concluir a integração.

Regras e validações

• Chaves válidas: O token cadastrado no campo Chave deve obrigatoriamente pertencer ao CNPJ/CPF da filial correspondente na plataforma Onvio.
• Execução do envio: O envio segue a frequência e o processamento da fila/tarefas configurados no canal e também pode ser realizado manualmente pelo menu Integrar.
• Apenas XML: Nesta integração, o envio é realizado para XML de documento. Eventos, PDF e EDI não entram nesse meio de integração.

Exemplos práticos

Exemplo 1 — XML entrando na fila do canal

Um XML de documento fiscal é recebido e processado pelo Fiscal.io. Se ele atender aos filtros do canal (por exemplo, Tomador; Terceiros somente quando habilitado), o arquivo entra na fila/tarefas de saída. Eventos não entram nessa integração. O envio ocorrerá conforme a frequência e o processamento configurados para o canal.

Exemplo 2 - Envio manual

Quando necessário, o usuário pode utilizar o menu Integrar para realizar o envio manualmente, sem depender da interpretação de que o envio acontece imediatamente após o recebimento.

Exemplo 3 - Armazenamento duplo no BOX-e:

Se o escritório possuir o produto e a opção estiver habilitada, o XML poderá ser enviado para o Onvio e também para o BOX-e, conforme a configuração do canal.

Mensagens e inconsistências comuns (e como resolver)

1) Falha de comunicação ou chave Inválida

Causa: O token copiado do Onvio está incorreto, expirado ou pertence a outro CNPJ.

Como resolver: Acesse o painel Onvio (Menu API > Chaves), gere um novo token para o CNPJ correto e atualize a tabela no monitor.

2) O XML não é enviado para o Onvio

Causa: O computador/servidor definido no campo Local está desligado ou sem acesso á internet.

Como resolver: Certifique-se de que a máquina responsável está ativa e com conexão estável á internet.

3) Inconsistência de licença ao marcar BOX-e

Causa: Opção marcando o envio para o BOX-e sem que haja contrato ativo do produto.

Como resolver: Desmarque a caixa Enviar cópia para BOX-e ou verifique a licença do produto junto ao Domínio.

4) Falha de autenticação / Unauthorized

Causa: Falha de autenticação na integração.

Como resolver: Verifique a autenticação, as credenciais/token da integração e a comunicação com a API. A solução não deve ser tratada simplesmente como troca da chave do cliente.

5) Rejeição E2 - "Não é um XML" / Invalid File Format

Causa: O arquivo foi rejeitado pela integração por não ser reconhecido como um XML válido para esse meio.

Como resolver: Abra o caso com o suporte para análise da rejeição.

Perguntas frequentes (FAQ)

1) Quando o envio do XML para o Onvio é executado?

O envio segue a execução do canal, considerando a frequência e a fila/tarefas configuradas. Também pode ser realizado manualmente pelo menu de integrações. Portanto, não é correto tratar o processo como um envio necessariamente imediato logo após o recebimento do XML.

2) Onde consigo a chave de API do Onvio?

A chave deve ser gerada diretamente no painel web da plataforma Onvio, acessando o menu API > Chaves na empresa desejada.

3) Posso usar o envio para o BOX-e sem ter o produto contratado?

Não. A opção enviar cópia para BOX-e deve ser utilizada apenas se o escritório/empresa possuir a licença desse serviço de armazenamento da Domínio.