Primeiros passos com a Plataforma InvoiCy

Última atualização em: 16 de abril, 2021

Olá! Neste artigo lhe daremos uma base inicial para darmos os primeiros passos com a Plataforma InvoiCy, desde a liberação do ambiente de homologação até a passagem para o ambiente de Produção. Ao final deste artigo, você deve estar apto a dar início a sua integração e iniciar as emissões em Produção.

1. Liberação dos Ambientes de Homologação e Produção

Após o término da negociação entre sua empresa e a Migrate, será liberado o ambiente de homologação para seu acesso. Este é o início de tudo. O ambiente de homologação será o seu primeiro contato com a Plataforma InvoiCy, e é nele onde serão realizados todos os testes de sua integração.

Já o ambiente de Produção, só será liberado quando for assinado o contrato entre sua empresa e a Migrate. Enquanto isso não ocorre, somente o ambiente de homologação ficará disponível. O ambiente de homologação, inclusive, não possui prazo de expiração e você poderá utilizá-lo para testes por todo o período de parceria. Como você já deve ter percebido, os ambientes de homologação e produção são separados, sendo que um não interfere na emissão do outro, podendo ser utilizados simultaneamente.

A liberação dos ambientes de homologação e produção será realizada pela Migrate, sendo que você receberá os dados para acesso em seu e-mail, contendo o link para acesso a Plataforma, usuário e senha. Também receberá uma chave de Parceiro, que será utilizada na integração e lhe identificará como Parceiro da Migrate.

2. Acessando a Plataforma InvoiCy – Cadastro de Empresa

Ao acessar a Plataforma InvoiCy você irá se deparar com um Wizard de cadastro de nova empresa. Este será o seu primeiro passo, e você deverá efetuar o cadastro de um cliente seu para emissão dos documentos fiscais, que podem ser NF-e, NFC-e, NFS-e, CT-e e MDF-e. Você não precisa cadastrar a sua empresa, a menos que você deseje efetuar emissões de algum documento com ela.

Está com dúvidas no processo de cadastro? Consulte o artigo “Cadastrar uma Empresa via Interface Web”.

Ao término do cadastro perceba que é apresentada uma chave: A Chave de Acesso. Guarde-a, pois você precisará dela no processo de emissão. Esta chave, juntamente com a chave de parceiro recebida no e-mail, será utilizada no processo de integração que explicaremos mais adiante.

O processo de cadastro de uma empresa também poderá ser realizado diretamente via Integração entre seu ERP e o InvoiCy, através do Web Service do InvoiCy. Com isso, não será necessário acessar a plataforma para efetuar o cadastro manual. Quer saber como? Leia o artigo “Cadastrar uma Empresa via Web Services”.

Este procedimento de cadastro será o mesmo, indiferente de ambiente. Tanto em homologação como em produção, este será sempre o seu primeiro passo ao acessar a Plataforma InvoiCy.

3. Licenciamento para emissão de Documentos

Para uso da Plataforma InvoiCy, se faz necessário o licenciamento dos módulos que serão utilizados. Porém, este licenciamento só será necessário no ambiente de Produção. Em homologação, os módulos constarão como “Não licenciados”, até que seja realizada a emissão do primeiro documento para o módulo. Após esta primeira emissão, o módulo será licenciado de forma automática.

Quando em produção, o processo de licenciamento deverá ser realizado conforme demonstra o artigo “Licenciamento das Empresas”.

4. Desenvolvimento da Integração entre seu ERP e InvoiCy

Chegamos num dos momentos mais importantes. A integração entre seu ERP e o InvoiCy.

A integração com a plataforma InvoiCy pode ocorrer de diversas formas. A forma pela qual você fará a integração dependerá muito de como seu negócio está estruturado e de qual módulo você irá integrar. Vamos aos detalhes:

Integração via Web Service: Esta é a integração mais comumente utilizada. Ela é caracterizada pela comunicação direta entre seu software ERP e o InvoiCy, através de uma comunicação única com o Web Service do InvoiCy. Em ambiente de homologação, o Web Service que deverá ser utilizado para emissão dos documentos será o https://homolog.invoicy.com.br/arecepcao.aspx?WSDL. Já em Produção, o Web Service a ser utilizado é https://web.invoicy.com.br/arecepcao.aspx?WSDL. A integração via Web Service pode ser utilizada para emissão de qualquer módulo disponibilizado pelo InvoiCy. Quer saber como emitir um documento via Web Service? Consulte os artigos abaixo, de acordo com o módulo desejado:

• Como emitir uma NF-e / NFC-e
• Como emitir uma NFS-e
• Como emitir um CT-e
• Como emitir um MDF-e

Integração via InvoiCy Conector: O InvoiCy Conector é uma alternativa à integração via Web Service. Nessa forma de integração, não há necessidade de conexão de seu ERP com um Web Service, pois a emissão irá ocorrer por meio de um aplicativo instalado em seu computador. O InvoiCy Conector é mais comumente utilizado para integrações com Softwares ERP que não possuem tecnologia de comunicação via Web Service, entre outras limitações. Através desta integração tudo que o ERP precisa fazer é gerar o arquivo XML do documento a ser emitido em uma pasta. O restante será por conta do Conector, que fará a leitura deste XML e enviar ao InvoiCy, devolvendo um retorno, também em XML, em outra pasta do computador. Quer saber como funciona o aplicativo em detalhes? Consulte o artigo “Como funciona o InvoiCy Conector”.

Durante o processo de integração, é comum surgirem dúvidas. Para isso, temos um canal de comunicação e atendimento. Envie um e-mail para integracao@migrate.info com suas dúvidas e/ou problemas. Estaremos dispostos a lhe auxiliar.

Também é importante destacar que toda a documentação de todos os módulos está disponível em nosso Portal dos Desenvolvedores: desenvolvedores.migrate.info

5. Passando uma empresa para Produção:

Como mencionado no item 1 deste artigo, o ambiente de Produção do InvoiCy só será liberado após assinatura do contrato com a Migrate. Quando isso ocorrer, você receberá os dados de acesso ao ambiente em seu e-mail.

De posse do acesso ao ambiente de produção, devemos tomar algumas medidas, as quais listamos no artigo “Alterações necessárias para entrada em Produção”.

Dúvidas? Não deixe de analisar toda nossa documentação em nosso Portal dos Desenvolvedores.

Padrão SIAPPA

Última atualização em: 08 de abril, 2021

O Padrão SIAPPA não segue o padrão ABRASF. Segue abaixo as particularidades deste novo padrão:

1. O sistema não permite:

• Informar o Intermediário do serviço;
• Substituição de RPS;
• Efetivar uma nota sem Tomador;
• Tomador do exterior.

2. Usuário e senha

Ao efetuar o cadastro de sua empresa deve-se inserir o usuário de autenticação que será sua inscrição sequencial na prefeitura, bem como a senha que pode ser encontrada na Consulta e manutenção de blocos de pré-NFSe, sendo identificada como Senha de acesso para Web Service.

3. Número e Série do RPS

O número da série é único para cada bloco de pré-NFSe. Para permitir a emissão de NFS-e, deve ser solicitada junto a prefeitura a liberação para o envio de NFS-e por meio de Web Service e a liberação de um bloco de pré-NFSe, onde o mesmo possuirá a série fixa e a faixa RPS. No portal da prefeitura no sistema da SIAPPA estão disponíveis no menu de acesso ao sistema a consulta/manutenção de blocos para Pré-NFSe para utilização do número, série e o código de validação para o envio do RPS por meio do Web Service.

Conceito para nomenclatura utilizada:

• Pré-NFSe: RPS
• Bloco de pré-NFSe: Lote
• Sequência do grupo: Série
• Sequência de NFS-e provisória: Sequência da numeração do RPS

Pode-se efetuar a Consulta do Bloco de Pré-NFSe onde encontra o número da série e o número do RPS e o código de verificação próprio para cada contribuinte durante o processo de emissão, bem como pode-se efetuar a exportação da estrutura de informações comentadas acima por meio de arquivo XML.

A lista de pré-NFSe do Bloco possui a série, apresentada ao lado do número do RPS e o código de validação que devem ser informados no envio do RPS para a validação e efetivação correta da nota.

4. Cancelamento

A data do cancelamento pode ser realizada até a data anterior ao fechamento de pendências contábeis do mês.

5. Natureza da Operação

A natureza da operação possui suas particularidades, como por exemplo caso atividade for sem retenção deverá ser informado o valor do ISS vazio bem como o campo da natureza vazia também para efetivar uma nota sem retenção como segue a descrição e os valores.

6. Cadastro de alíquota para prestador Optante pelo Simples Nacional

Quando o prestador for optante pelo Simples Nacional, deve realizar no portal da prefeitura do seu município o cadastro da alíquota relativa ao valor mensal de serviço ao iniciar sua primeira emissão, não sendo necessário emitir uma nota apenas realizar o cadastro. Ao efetuar o acesso ao sistema tem-se a primeira opção de lançamento de Nota Fiscal de Serviços Eletrônica (NFS-e), clique na opção e observe que trará a página com a mesma relação da imagem a seguir, com a informações do contribuinte para o cadastro.

7. Impressão

Possui a opção de impressão com o modelo da prefeitura.

8. Exemplo XML

Para visualizar um exemplo do XML de envio clique aqui.

Release Notes – InvoiCy Conector Versão 4.2.0.0

Versão 4.2.0.0 – 16/03/2017

Instalação do InvoiCy Conector

Nesta versão do InvoiCy Conector a forma de download e instalação foi remodelado, a partir de agora é necessário acessar o InvoiCy Conector com usuário do tipo parceiro, adicionar um novo conector e em seguida realizar o download, para posterior instalação na máquina/servidor do cliente. Para conhecimento do processo, clique aqui.

Também foi modificado a forma de emissão em homologação e produção. Agora será necessário utilizar dois conectores diferentes, um de homologação e outro de produção. Ou seja, para emissão ou importação em homologação deverá realizar o cadastro e o download do conector através do ambiente homolog.invoicy.com.br. Já para emissões e importações de documentos em modo de produção é necessário realizar o cadastro e download do conector pelo ambiente web.invoicy.com.br. Na máquina/servidor os conectores serão instalados em diretórios diferentes, podendo utilizar ambos sem problemas.

Gerenciamento do InvoiCy Conector via tela da Plataforma InvoiCy

Na versão 1.21.0.0 do InvoiCy foi liberada uma nova tela para gerenciamento do InvoiCy Conector, que poderá ser acessada com usuário do tipo parceiro, podendo adicionar conectores para realizar emissão e importação de documentos. Também é possível gerenciar os conectores do cliente, permitindo a inativação, ativação e bloqueio de um conector ou instância específica, como também, a adição de CNPJ habilitados para a importação de documentos. Mais informações sobre esta nova forma de gerenciar os conectores, clique aqui.

Atualização automática do InvoiCy Conector

O InvoiCy Conector a partir desta versão será atualizado de forma automática através da Plataforma de Soluções InvoiCy, não necessitando mais realizar emissões para receber a atualização. Assim que for liberado no painel do InvoiCy o novo pacote de atualização, o Conector, independente do que estará realizando (emissão, importação ou nenhuma ação), será atualizado automaticamente com as melhorias.

Para mais informações acesse a página do InvoiCy Conector versão 4.0 ou superior, clicando aqui.

O que é o InvoiCy Conector 5.0?

Última atualização em: 17 de novembro, 2017

Olá! Este artigo tem como objetivo demonstrar o funcionamento do aplicativo InvoiCy Conector.

O InvoiCy Conector é um aplicativo desenvolvido pela Migrate, com o intuito de facilitar a integração com o InvoiCy – Plataforma de Soluções Fiscais. O aplicativo poderá ser utilizado por empresas que não dispõem de tecnologia para realizar consumo de Web Services, tornando o processo mais simples.

De uma forma geral o desenvolvedor não precisa consumir o Web Service, e este serviço fica a cargo do Conector InvoiCy, que fará todo o trabalho de envio dos Documentos Fiscais à Plataforma.

Na nova versão do aplicativo foram implementadas algumas melhorias em relação à versão anterior. Agora é possível configurar várias instâncias do conector que funcionarão em paralelo, sendo possível por exemplo, monitorar 2 diretórios diferentes.

Porém, se você usuário desejar enviar documentos para ambientes diferentes, homologação e produção, deverá configurar uma instalação separada do Conector para cada ambiente, ou seja, não é possível enviar documentos para ambientes distintos através de uma mesma instalação do Conector.

Também foi implementada uma nova configuração para NFS-e, o Diretório de Arquivos para Prefeitura, a impressão automática para os documentos efetivados, e a possibilidade de utilizar o certificado digital A3 para a assinatura de documentos NF-e, CT-e e MDF-e, além de melhorias em todo o layout do aplicativo.

O InvoiCy Conector também permite a emissão de NFC-e com certificado A3, porém é importante destacar que não permite a emissão de NFC-e em Contingência Offline se o conector não tiver conexão com a internet ou com o InvoiCy.

A assinatura dos documentos com certificado digital A3 não está disponível para o módulo NFS-e.

É importante destacar que ao utilizar o certificado digital A3 no InvoiCy Conector não será possível fazer uso do processo de DistribuicaoDFe (Distribuição de Documento Fiscal Eletrônico), para consulta dos documentos de entrada. Já com o certificado digital A1 esse processo funciona corretamente.

Veja abaixo o fluxo do InvoiCy Conector:

Simples, não é mesmo? Agora vamos ao próximo passo. Vamos saber como funciona o InvoiCy Conector?

• Como funciona o InvoiCy Conector?

Como funciona o InvoiCy Conector 5.0

Última atualização em: 16 de abril, 2021

Olá! Neste artigo vamos demonstrar de forma resumida a estrutura do InvoiCy Conector, e o funcionamento do mesmo. Nos próximos artigos iremos descrever de forma detalhada cada processo citado no presente artigo.

Primeiramente deve-se instalar o InvoiCy Conector na sua máquina conforme apresentado no artigo Instalação do InvoiCy Conector.

Ao iniciar o InvoiCy Conector será estabelecida uma conexão à internet, caso o conector não consiga efetuar sua inicialização normal devido a uma falha de conexão, por existir na estrutura de rede configurações de proxy, o conector vai solicitar ao usuário que seja informado os dados de proxy, para que assim o mesmo faça a autenticação e inicie seu serviço.

Não obtendo sucesso na tentativa de conexão à internet, será apresentada a tela a seguir, para informar as configurações de proxy da rede da empresa. Acesse a opção de “Configurar proxy”.

Informe ao InvoiCy Conector se ele precisará utilizar o proxy – marcando o checkbox “Usar Proxy”, e informe então os dados de “Host”, “Porta”, e ainda se o proxy necessitar a autenticação de usuário informe também o “Usuário” e a “Senha” e salve os dados informados.

Ao salvar as configurações de proxy, utilize a opção “Tentar novamente” para que assim o InvoiCy Conector faça uma nova tentativa de conexão e possa ter sucesso e iniciar o seu serviço.

Após concluída a instalação e a configuração do proxy será aberta a tela de instâncias do InvoiCy Conector, conforme demonstra a imagem a seguir, porém sem as instâncias estarem criadas.

Nessa tela serão listadas todas as instâncias que estão cadastradas, onde cada instância é responsável por monitorar um determinado diretório. Dessa forma, não é possível colocar duas ou mais instâncias para monitorar o mesmo diretório de entrada. É necessário que cada instância monitore um diretório diferente.

Através da tela inicial do Conector é possível acessar o menu “Opções” e utilizar a opção de ‘Configurações Gerais.

Através do menu “Opções” do Conector ainda pode-se acessar o item ‘Serviços’ podendo assim gerenciar os serviços que estão sendo executados no conector instalado em seu computador.

Na tela ‘Serviços’ é possível iniciar/parar o serviço de emissão, de assinatura do certificado digital A3 e a importação de documentos emitidos NF-e e NFC-e e SAT. Quando clicar sobre o botão de ‘Iniciar’ e o processo demorar para iniciar ficará a mensagem ‘Iniciando’ e em seguida o botão de ‘Iniciar’ ficará inativo, podendo apenas clicar no botão ‘Parar’, onde, caso demorar para encerrar o serviço poderá aparecer a mensagem ‘Parando’. Quando o serviço estiver iniciado o status estará como ‘Ativo’, do mesmo modo, se o serviço estiver parado o status será ‘Inativo’.

Na tela inicial do conector, ao clicar duas vezes sobre a linha da instância, ou clicando no botão ‘Nova Instância’, a tela de edição/inserção irá aparecer.

Ao acessar as informações da instância, será possível ajustar as configurações de emissão, configurações de conexão, configurações de impressão e ainda configurar a assinatura com certificado A3. A imagem abaixo representa a tela de configurações do Conector dividido em abas.

No campo “Nome da instância”, podemos inserir uma descrição que será a identificação da instância.

Na aba “Diretórios para emissão” temos a possibilidade de configurar diretórios de Envio, Retorno, Arquivos XML e PDF, e Arquivos TXT para Prefeitura. Caso seja necessário, é possível configurar o diretório de saída igual em todas as instâncias. O InvoiCy Conector não executa nenhum monitoramento sobre esses diretórios. Para mais informações sobre as configurações dessa tela, acesse o artigo Configurações de emissão.

Na aba “Conexão”, temos as configurações de proxy que podem ser adicionadas ao conector, bem como o timeout. Na aba Leitura de Arquivos possui as configurações do modo de leitura e envio dos arquivos. Para entender melhor as configurações de conexão do Conector acesso o artigo.

Na aba “Assinatura A3” é possível configurar um certificado A3 para efetuar a emissão dos documentos. Entenda mais sobre essa funcionalidade lendo o artigo Configuração de Assinatura A3, clique aqui.

Na aba “Impressão” pode-se adicionar e configurar as impressoras desejadas para realizar a impressão dos documentos emitidos. Para saber como funciona a impressão automática dos documentos acesse o artigo Configurações de impressão.

E por fim, na aba “Importação” é possível configurar um diretório de entrada e de erros para realizar a importação de documentos SAT, NF-e e NFC-e emitidos para armazenar no InvoiCy. Para saber como funciona todo o processo de importação de documentos emitidos acesse o artigo Importação de Documentos Emitidos.

Após preencher todas as configurações desejadas, clique em “Salvar” para que as informações sejam armazenadas. Ao clicar sobre o botão “Fechar” o aplicativo não será encerrado, mas ficará em execução nos serviços do Windows em segundo plano.

NOTA:

Para que os processos sejam executados com sucesso é necessário configurar nos serviços do Windows para os serviços abaixo serem inicializados com o usuário que utiliza o Conector no servidor/máquina, ou seja, o usuário que inicializa a máquina com permissões de administrador e realiza as interações com o InvoiCy Conector, como a emissão e importação de documentos.

InvoiCyConectorServicoEmissaoHomologacao                        InvoiCyConectorServicoImportacaoHomologacao        InvoiCyConectorServicoMaestroHomologacao

Para isso basta abrir os serviços do Windows e pesquisar pelos serviços acima, em seguida com o botão direito clicar em ‘Propriedades’, nesta tela acessar a aba “Logon” e escolher a opção “Esta conta” e informar os dados de login. Realizar o processo para os três serviços e reiniciar a máquina, ou então, reiniciar os serviços do Windows.

Agora que você já tem o embasamento de como funciona o InvoiCy Conector vamos partir para a integração? Seu próximo passo é cadastrar uma empresa no InvoiCy, para mais detalhes acesse o artigo Cadastro de empresa via InvoiCy Conector.

Configurações de Emissão – versão 5.0

Última atualização em: 16 de abril, 2021

Olá! Neste artigo vamos descrever de forma mais detalhada como efetuar as configurações para emissão de documentos no InvoiCy Conector, e o funcionamento desse processo.

Vamos dar início? Siga os passos abaixo:

Com o InvoiCy Conector já instalado na sua máquina execute o aplicativo. Se ainda não tiver instalado o Conector acesse o artigo Instalação do InvoiCy Conector.

Caso seja a primeira execução aparecerá uma tela carregando as informações de conexão com o InvoiCy, basta aguardar a tela se fechar e ter acesso a tela de instâncias do Conector, conforme demonstra a imagem abaixo.

Conforme já foi mencionado, nessa tela serão listadas todas as instâncias que estão cadastradas. Caso você já tenha uma instância cadastrada, basta clicar duas vezes sobre a linha correspondente à instância para abrir a tela de edição. Ou se preferir clique no botão ‘Editar instância’ localizado abaixo da tela.

Se você ainda não possui nenhuma instância cadastrada clique no botão ‘Nova instância’ para abrir a tela de cadastro e configurações, como representa a imagem acima.

Informe no campo ‘Nome da instância’, localizado na parte superior da tela, uma descrição para identificar a nova instância cadastrada, ou se deseja alterar o nome de uma instância já existente. E clique na aba ‘Diretórios para emissão’ para prosseguir com as configurações. A imagem abaixo demonstra a tela de configurações de emissão.

Nessa tela temos a possibilidade de configurar o diretório de envio, retorno, armazenamento dos arquivos XML e PDF e arquivos para padrões TXT de NFS-e. Ainda pode-se escolher se deseja armazenar os arquivos processados separando-os por modelo do documento ou data.

Confira a seguir uma explicação sobre cada uma dessas configurações:

Ativar emissão de documentos: Ao selecionar essa opção, o processo de envio de documentos para o InvoiCy estará ativo para a instância. Caso não habilitar esta opção o Conector não permitirá configurar os diretórios para emissão. Esta opção é desativada pelo parceiro nos casos em que o Conector não deverá processar os arquivos da instância por algum incidente.

Diretório de Envio: Neste campo você deve informar o diretório de destino onde serão salvos os arquivos XML que devem ser enviados ao InvoiCy pelo Conector.

Diretório de Retorno: Neste campo você deve informar o diretório de destino onde serão gravados os arquivos de retorno do InvoiCy. A cada envio de um novo documento será gravado um retorno no formato XML, que pode ser lido pelo ERP, a fim de obter o status da emissão do documento.

Nomenclatura dos arquivos de retorno no padrão InvoiCy: Para padronizar a nomenclatura dos arquivos de retornos salvos em seu diretório, é possível selecionar esta opção e assim seus arquivos estarão salvos no padrão do InvoiCy para todos os módulos contratados. 

ATENÇÃO! Porém é importante observar que para utilizar esta opção seu sistema de integração deverá estar preparado para ler a nova estrutura criada para a nomenclatura dos arquivos de retorno. Caso não necessitar utilizar a nova forma de armazenar os arquivos, esta opção não deverá ser selecionada, e o Conector continuará a armazenar seus documentos da forma atual.

Abaixo são apresentados alguns dos exemplos de arquivo de retorno utilizando a nova Nomenclatura dos arquivos de retorno no padrão InvoiCy:

Módulo NFS-e:

• NFSE015630000000000091850000S.xml

Módulo NF-e:

• 35170418115979000109553210000000611000000614-NFe;
• 35170418115979000109553210000001071000001077-procNFe;
• Evento NF-e 35170418115979000109553210000001051000001056-1115001-procEve.

Módulo NFC-e:

• 43170406354976000149653210000001011000000438-procNFCe;
• 43170635497600014965321000000102000000102_102-procInutNFe.

Módulo CT-e:

• 43170406354976000149575180000000021004561323-procCTe.

Módulo MDF-e:

• 43170406354976000149585180000000031000000034-procMDFe;
• 43170406354976000149585180000000041000000040-1101121-procEvento.

OBSERVAÇÃO: não existe nenhuma regra quanto a nomenclatura dos arquivos enviados ao Conector, ficando a critério do usuário definir a nomenclatura que desejar para seus arquivos. Por exemplo: cte1.xml, NFe.xml, EnvioNFCe.xml. Indiferente da nomenclatura, os arquivos serão lidos e processados pelo InvoiCy Conector.

Salvar arquivos XML e PDF no diretório: Caso marcar a opção ‘Salvar arquivos XML e PDF no diretório’ deve informar o diretório de destino onde serão armazenados os arquivos XML e PDF do documento emitido. A cada envio de um novo documento, se o mesmo for efetivado, será gerado um arquivo XML e um PDF correspondente ao documento enviado, e armazenado no diretório configurado de acordo com as configurações contidas no InvoiCy.

Diretório de Arquivos para padrões TXT de NFS-e: Neste campo você deve informar o diretório de destino onde serão salvos os arquivos de texto que deverão ser enviados para a prefeitura. Esta é uma configuração especial para NFS-e, e se aplica somente para as empresas que emitem NFS-e em prefeituras com Padrões TXT.

Separar arquivos por data: Ao optar pela opção ‘Separar arquivos por data’ os arquivos processados serão salvos no diretório especificado com a seguinte estrutura:

Diretório de saída\ano\mês\dia\arquivo.xml

Diretório de saída\2017\03\09\arquivo.xml

Separar arquivos por modelo: Já ao selecionar a opção ‘Separar arquivos por modelo’, os arquivos processados serão armazenados no diretório especificado na seguinte estrutura:

Diretório de saída\modelo\arquivo.xml

Diretório de saída\NFe\arquivo.xml

Também é possível optar pelas duas formas, onde ao marcar as opções ‘Separar arquivos por data’ e ‘Separar arquivos por modelo’ os arquivos processados serão armazenados no diretório escolhido seguindo a estrutura:

Diretório de saída\modelo\ano\mês\dia\arquivo.xml

Diretório de saída\NFe\2017\03\09\arquivo.xml

Após finalizar todas as configurações clique em ‘Salvar’. Agora que você já tem todas as configurações de emissão finalizadas pode iniciar o serviço de emissão de documentos.

Então novamente na tela inicial do Conector clique no Menu – Opções – Serviços e na próxima tela no botão “Iniciar” no serviço de Emissão para iniciar o serviço de emissão dos documentos, como demonstra a imagem a seguir.

É importante destacar que ao clicar nessa opção irá iniciar o serviço para todas as instâncias cadastradas e que estejam ativadas, as instâncias que estiverem com a opção “Ativar emissão de documentos” desmarcada não terão os documentos processados. Para parar o serviço de emissão basta clicar em ‘Parar”.

Para ter acesso aos modelos de documentos de XML, XSD e layout em XLS acesse a página de downloads, clicando aqui.

Como próximo passo você pode efetuar as configurações de conexão. Leia o artigo para obter informações mais detalhadas sobre esse procedimento.

Observação – Emissão de documentos em contingência EPEC:

Ao enviar documentos em contingência com o InvoiCy Conector, o aplicativo não irá respeitar a ordem de contingência configurada para o módulo no Painel de Controle da Plataforma InvoiCy. O InvoiCy Conector utilizará como padrão sempre a primeira opção de contingência configurada, e se por algum motivo esta não funcionar, não será executada uma nova tentativa para a próxima opção da lista, e o envio do documento será suspenso e o mesmo ficará com status Rejeitado.

Para os emissores que utilizam o certificado A3, ao enviar um documento em contingência EPEC será gerado dois arquivos de retorno, um referente a situação do evento, e outro que se refere a situação do documento. Para entender melhor como esse processo irá funcionar, veja um exemplo de retorno para o evento e um exemplo para o retorno do documento.

Já para emissores que utilizam o certificado A1 o processo continua o mesmo, gerando apenas um arquivo de retorno.

Configurações de Conexão – versão 5.0

Última atualização em: 27 de setembro, 2017

Olá! Neste artigo vamos descrever de forma mais detalhada como efetuar as configurações de conexão para envio de documentos no InvoiCy Conector, e o funcionamento desse processo.

A partir de agora assumimos que você já tenha o Conector instalado na sua máquina, e uma instância cadastrada. Caso ainda não tenha realizado esses passos leia o artigo ‘Configurações de emissão’ para mais informações.

Execute o Conector e na tela de instâncias edite a instância desejada, clicando duas vezes na linha correspondente. Na tela de edição da instância clique na aba ‘Conexão’, como demonstra a imagem abaixo.

Nestas abas selecionadas na imagem é possível efetuar as configurações de conexão, e a forma de leitura e envio dos documentos. Primeiramente vamos definir nossas configurações de conexão.

No campo ‘Timeout em Segundos’ deve-se definir o tempo de retorno do InvoiCy ao processar os documentos. Caso deixe o valor como zero será considerado como 2 minutos.

E se a empresa utiliza algum proxy de rede para se conectar à internet deve selecionar a opção ‘Usar Proxy’, e preencher as demais configurações como Host, Porta, Usuário e Senha.

Após todas as informações preenchidas clique em “Salvar” para que as informações sejam armazenadas.

Se deseja alterar as configurações de leitura e envio de documentos clique na aba ao lado ‘Leitura de Arquivos’, conforme demonstra a imagem abaixo.

Nessa tela pode-se definir a forma como o Conector irá efetuar a leitura dos arquivos do diretório de envio e enviar ao InvoiCy. O modo de envio pode ser ‘Paralelo’ ou ‘Sequencial’.

No modo de envio paralelo, o Conector irá enviar os arquivos conforme o valor configurado na opção ‘Envios paralelos’, que apresenta os valores de 1 a 8.

Ao selecionar o valor 2, por exemplo, o Conector irá ler 2 arquivos do diretório de entrada, e enviar os 2 ao mesmo tempo para o InvoiCy. A imagem abaixo representa a configuração dessa opção.

Já ao optar pelo envio sequencial não é possível definir a quantidade de arquivos que serão enviados, mas sim a forma como os mesmos serão enviados, através da opção ‘Ordem de Leitura’.

Pode-se configurar a leitura dos arquivos em ordem Crescente ou Decrescente, de acordo com a sua Data de Criação, Nome do Arquivo ou Indefinido, ou seja, sem uma ordem específica.

É importante destacar que para empresas que emitem NFS-e recomenda-se utilizar a forma de leitura e envio sequencial, pois existem algumas prefeituras que esperam receber os documentos em ordem.

Após o término das configurações clique em ‘Salvar’, para que as informações sejam armazenadas.

Agora que você já finalizou suas configurações de emissão e de conexão, você pode iniciar a emissão dos seus documentos. Leia o artigo ‘Como Integrar com o InvoiCy Conector’ para maiores informações.

Configurações de Assinatura – versão 5.0

Última atualização em: 27 de setembro, 2017

O InvoiCy Conector também permite utilizar certificado A3 para os módulos NF-e, NFC-e, CT-e e MDF-e para realizar a emissão dos documentos. Nesse artigo iremos detalhar as configurações necessárias para utilizar o certificado A3, e como proceder com a emissão dos documentos. 

A partir desse momento assumimos que você já cadastrou sua empresa e efetuou todas as configurações necessárias, mas caso ainda estiver com dúvidas, leia o artigo ‘Como funciona o InvoiCy Conector’ para mais informações.

Execute o Conector e na tela de instâncias edite a instância desejada, clicando duas vezes na linha correspondente. Na tela de edição da instância clique na aba “Assinatura A3”, como demonstra a imagem abaixo.

Ao configurar pela primeira vez aparecerá uma mensagem em tela solicitando a inicialização do serviço de assinatura, se o mesmo ainda não estiver iniciado. Confirme a mensagem para prosseguir.

Na tela que abrirá a seguir você deve ativar a assinatura A3, e através do botão destacado na imagem abaixo buscar o certificado A3 que está conectado em sua máquina.

Ao clicar no botão ‘Exibir opções avançadas de busca’ é possível detalhar mais a busca do certificado, fazendo uso dos filtros ‘Local’ e ‘Nome’, como demonstra a imagem a seguir. Para ocultar novamente os filtros clique em ‘Esconder opções avançadas de busca’.

Após definir o certificado A3 corretamente clique em ‘Salvar’ para armazenar as configurações. Ao concluir essas configurações o serviço de assinatura do certificado A3 será iniciado automaticamente.

Se desejar cancelar a emissão com o certificado A3, basta acessar essa mesma tela de configurações de assinatura e desativar a configuração. E na tela inicial do Conector parar o serviço de emissão com certificado A3, como destaca a imagem abaixo.

Lembrando que ao parar esse serviço, todas as instâncias configuradas para emitir com certificado A3 ficarão impossibilitadas de prosseguir com a emissão.

 

É importante destacar que, como um requisito mínimo para que a emissão com o certificado A3 funcione corretamente é necessário que você possua os drivers do certificado instalados, na mesma máquina onde o Conector também está instalado e devidamente configurado para executar o processo de emissão.

Para as empresas que emitem no módulo NFS-e não será possível fazer uso do certificado A3. E para as empresas que emitem em mais de um módulo a configuração do certificado digital será geral, ou seja, não será possível emitir para o módulo NF-e com certificado A1 e para o módulo CT-e com certificado A3, por exemplo.

Observação: Quando rodar o processo de atualização automática do InvoiCy Conector, para os emissores que fazem uso do certificado A3, ao emitir o primeiro documento após finalizada a atualização será solicitada novamente a senha do certificado A3. Já para os emissores que utilizam certificado A1 o processo não sofrerá nenhum impacto.

Configurações de Impressão – versão 5.0

Última atualização em: 12 de maio, 2021

O InvoiCy Conector também conta com uma funcionalidade de impressão automática dos documentos emitidos e efetivados.

Neste artigo vamos descrever de forma mais detalhada como efetuar as configurações de impressão automática de documentos no Conector, e o funcionamento desse processo.

Após instalado o Conector, cadastrada a instância e finalizada as configurações de emissão, o primeiro passo é abrir a tela de edição da instância e clicar na aba “Impressão”, como destaca a imagem abaixo.

Primeiramente deve-se ativar a funcionalidade de impressão, selecionando a opção ‘Ativar impressão de documentos’, como demonstrado na imagem acima.

Habilitará então um combobox para você escolher a impressora padrão que deseja imprimir seus documentos e poderá optar pela quantidade de cópias que deseja imprimir os documentos, sendo possível configurar a impressão de 1 até 5 cópias cada documento. Selecione sua opção e salve suas configurações, conforme imagem a seguir:

Você também pode adicionar novas impressoras, através do botão ‘Adicionar impressora’, localizado no rodapé da tela.

Para adicionar uma impressora você deve escolher no combobox a impressora desejada, e atribuir um apelido para ela, para sua identificação. A imagem abaixo representa a tela de cadastro e edição de impressoras. Após definidas as configurações clique em ‘Salvar’ para armazenar as informações.

Você pode adicionar quantas impressoras desejar, também editá-las e removê-las, e todas elas serão exibidas na lista de impressoras, como na imagem abaixo.

Ao realizar a a impressão de documentos com impressoras remotas, e ocorrer alguma falha devido as permissões do usuário, deverá selecionar a opção, ‘Utilizar AcroWrap (necessário instalar)’, como demonstra a imagem abaixo.

Essa opção faz com que a impressão seja feita por outro processo, corrigindo algumas situações de falta de permissão de usuários. Mas atenção! Para que esse processo funcione é necessário ter o Adobe Reader instalado no computador.

Disponibilizamos aqui o link para fazer download do Adobe Reader.

Observação: por enquanto essa opção é utilizada apenas no processo de emissão normal de documentos, ou seja, que não foram emitidos em contingência.

Para o InvoiCy Conector identificar que precisa mandar o documento para a impressora após a emissão, você deve acrescentar duas tags novas no layout de envio dos documentos, como demonstra a imagem a seguir.

A tag deve ser preenchida com ‘S’, quando você deseja imprimir o documento, ou ‘N’ para não imprimir. E na tag você pode definir a impressora que irá imprimir o documento, informando o apelido da impressora que está cadastrada no Conector.

Se a tag estiver como ‘S’, e a tag não for informada, o Conector irá imprimir o documento na impressora padrão que está configurada.

Caso desejar cancelar a impressão automática dos documentos, basta acessar a tela de configurações de impressão, e desativar a funcionalidade.

ATENÇÃO! Caso ocorra algum problema no momento da impressão automática do documento ou seja necessário uma segunda via do documento, você poderá enviar uma consulta ao documento preenchendo os campos <Imprimir> e <ApelidoImpressora>, desta forma será realizada a reimpressão do documento. Veja o exemplo abaixo:

É importante destacar que as margens dos documentos impressos devem ser configuradas na própria impressora do usuário, isso não depende do InvoiCy Conector ou da Plataforma InvoiCy.

Caso a impressora não estiver na rede interna da empresa será necessário realizar um ajuste no serviço de emissão. O procedimento é simples: Abrir o Serviço do Windows -> serviço InvoiCyConectorServicoMaestroHomologacao, abrir as Propriedades e na aba Logon inserir o usuário administrador da máquina e confirmar as alterações. Em seguida, deverá reiniciar a máquina para que as modificações sejam aplicadas.

NOTA: Para que a impressão ocorra de forma satisfatória pelo Conector é necessário que a empresa tenha configurado o retorno dos arquivos na Plataforma InvoiCy, através do Painel de Controle – Configurações para Emissão do respectivo módulo, onde o retorno dos arquivos XML e PDF deve estar como ‘Base64’. Caso a empresa marque para retornar apenas o ‘Link para Download’ a impressão não irá ocorrer pelo Conector, pois o mesmo não consegue gerar os arquivos sem o Base64.

Como Integrar com o InvoiCy Conector – versão 5.0

Última atualização em: 16 de abril, 2021

Olá! Neste artigo iremos exemplificar o processo de integração com o InvoiCy utilizando o aplicativo InvoiCy Conector. Mostraremos um exemplo prático de envio de um documento fazendo uso desse aplicativo. Vamos lá!

A partir deste momento assumimos que você já leu o artigo “Como funciona o InvoiCy Conector” e “Cadastro de empresas via interface web”. Caso ainda não tenha lido tais artigos por favor volte um passo, antes de iniciar a leitura deste documento.

1. Inicialmente, configure o InvoiCy Conector de acordo com a sua preferência de diretórios. Exemplo:

2. Após o aplicativo devidamente configurado e as informações salvas, vamos agora gerar um documento de integração que posteriormente será salvo no diretório de Entrada para ser enviado ao InvoiCy. Neste artigo, estaremos gerando um documento NF-e como exemplo, porém você poderá gerar o documento de sua preferência.

Clique aqui para ver um exemplo de documento XML de uma NF-e.

3. Os arquivos XML de cada documento devem ser gerados a partir dos layouts abaixo:

NF-e / NFC-e layout 4.00: download

CT-e layout 3.0: download

CT-e Eventos: download

NFS-e: download

NFS-e Cancelamento: download

NFS-e Consulta: download

MDF-e 3.0: download

Eventos MDF-e: download

Consulta de Status de Documentos: download

4. Depois de gerado o documento o mesmo deverá ser salvo dentro do diretório de “Envio” configurado no InvoiCy Conector. No momento que o arquivo for salvo no diretório o aplicativo fará a sua leitura e processamento, enviando o mesmo para o InvoiCy, que por sua vez fará o envio para a SEFAZ e devolverá um retorno no diretório de Retorno configurado no InvoiCy Conector.

Clique aqui para obter um exemplo de retorno do Conector InvoiCy.

O arquivo de retorno conterá a seguinte estrutura em sua nomenclatura:

CNPJ: 14 posições (ex: 88128984000224)

Numero: 9 posições (ex: 000000123)

Serie: 5 posições (ex: 00451)

Evento: 6 posições (ex: 110111)

Sequencial do evento: 2 posições (ex: 01)

Ex: 881289840002240000001230045100000000-ret.xml (Exemplo de retorno do envio de uma nota)

Ex: 881289840002240000001230045111011101-ret.xml (Exemplo de retorno do envio de um evento de cancelamento)

5. Após o envio do documento pelo aplicativo, serão salvos no diretório Arquivos, configurado no InvoiCy Conector, os arquivos XML e PDF do documento enviado, caso o mesmo for efetivado. O arquivo XML é o arquivo protocolado pela SEFAZ. Já o PDF será o DANFE para o caso de NF-e/NFC-e, DACTE para o caso de CT-e, DAMDFE para o caso de MDF-e e Espelho de RPS para o caso de NFS-e.

Estes são os processos básicos de envio e retorno de documentos através do InvoiCy Conector. Em nosso próximo artigo estaremos disponibilizando exemplos de envio e retorno para cada documento que pode ser emitido através do InvoiCy.