Retorno de eventos pendentes no InvoiCy

Última atualização em: 20 de janeiro, 2017

 

A Plataforma InvoiCy está em constante evolução para atender as necessidades de seus usuários, dessa forma, desenvolveu-se um processo para armazenar os eventos enviados ao InvoiCy, e que por algum motivo ficaram com status pendente na SEFAZ.

Ao enviar um evento, como um cancelamento ou carta de correção, por exemplo, e por algum motivo ocorrer alguma falha de comunicação com a SEFAZ, o evento ficará pendente perante a SEFAZ, mas mesmo assim será vinculado ao respectivo documento no InvoiCy.

O cliente receberá como retorno no Web Service o código “105 – Evento pendente”. Para visualizar o exemplo completo do retorno do evento clique aqui.

Mesmo estando pendente, esse evento será vinculado ao documento no InvoiCy, e ao acessar a tela de detalhes do documento, na aba Eventos, o mesmo estará disponível, onde o usuário poderá fazer download do seu XML. A imagem abaixo demonstra o evento pendente vinculado ao documento no InvoiCy.

Ao fazer uma consulta para o documento que possui evento pendente, será retornado o status 105 para o evento, o que representa que o mesmo está pendente. Veja um exemplo de retorno de uma consulta clicando aqui.

Destacando que ao efetuar a consulta, nos parâmetros da consulta deve-se enviar a tag como S, para retornar as informações do evento. Para mais informações sobre o processo de consulta de documentos leia o artigo Consultando um documento.

Após voltar a comunicação com a SEFAZ o evento será processado pelo InvoiCy e enviado para a SEFAZ, e caso tudo esteja correto o usuário poderá efetuar download do XML, e em alguns casos também do PDF do evento.

Ao consultar novamente o documento, retornará o status do evento após o envio para a SEFAZ. Isso possibilita ao usuário efetuar um acompanhamento do processamento dos eventos.

Release Notes – Versão 1.19.0.0

Versão 1.19.0.0 – 17/01/2017

Novo Web Service para consultar a quantidade de documentos emitidos pela empresa

A Plataforma InvoiCy disponibiliza de um novo Web Service para consultar a quantidade de documentos emitidos pela sua empresa, dentro de um determinado período de tempo. Para mais informações sobre essa nova funcionalidade leia o artigo “Consultar quantidade de documentos emitidos via Web Service”.

Criptografar a senha do certificado digital ao cadastrar empresa via Web Service

Buscando garantir maior tranquilidade e segurança para o usuário Parceiro, a Plataforma InvoiCy permite que o Parceiro envie a senha do seu certificado digital de forma criptografada, no momento de efetuar o cadastro de uma empresa via Web Service. Para mais informações sobre essa funcionalidade leia o artigo “Criptografia da senha do certificado ao cadastrar empresa via WS”.

Impressão do DANFE Simplificado

A partir dessa versão o InvoiCy disponibiliza uma nova orientação de impressão para o DANFE, o DANFE Simplificado, que poderá ser utilizado em impressoras portáteis, para impressões fora do estabelecimento por exemplo. Para saber mais sobre essa nova forma de impressão leia o artigo “Configurações do DANFE”.

Licenciamento de PDV/SAT

A tela de licenciamento de PDV/SAT sofreu melhorias para facilitar o acompanhamento das cobranças mensais por parte dos usuários Parceiros. Através da nova tela será possível acompanhar o volume das emissões diárias dos documentos NFC-e e CF-e SAT para cada dia do mês, bem como os PDVs que serão cobrados ou não no mês. Para mais informações leia o artigo “Tela de licenciamento de PDV/SAT”.

Detalhamento da versão

Para conhecer todas as modificações e melhorias realizadas nessa versão, clique aqui.

Versão 1.19.0.0 – mais detalhes

Confira todas as alterações e melhorias realizadas na versão 1.19.0.0 do InvoiCy:

Código da solicitação – Descrição

6267 – Web Service para consultar a quantidade de documentos emitidos pela empresa
6268 – Criptografia da senha do certificado digital no cadastro de empresa via Web Service
3615 – Informar ao usuário qual o tamanho ideal para a logomarca da empresa
6656 – Vincular eventos pendentes ao documento
4378 – Retornar Digest Value e Fuso Horário na consulta do documento
4872 – Retornar Data e Hora de Autorização na consulta do documento
5259 – Importação de documentos recebidos – tratar campos do XML com Cdata
6586 – Geração do protocolo de consulta do documento

Solicitações do Módulo NF-e:

5919 – Impressão de DANFE Simplificado
5247 – Incluir paginação na tela de visualização de logs da NF-e

Solicitações do Módulo NFC-e / CF-e SAT:

4759 – Melhorias na tela de cobrança de PDVs
6623 – Impressão de CF-e SAT com filtros diferenciados na tela inicial

Tela de licenciamento de PDV/SAT

Última atualização em: 08 de agosto, 2017

 

A tela de licenciamento de PDV/SAT sofreu alguns ajustes para facilitar o acompanhamento das cobranças mensais por parte dos usuários Parceiros.

Para acessar a nova tela vá até o Painel de Controle, e no grupo Empresas clique na opção ‘Módulos contratados’, como demonstra a imagem a seguir.

Estando na tela de módulos contratados, clique no ícone do ‘olho’ para acessar a tela de PDV/SAT, como demonstra a imagem abaixo.

A imagem abaixo demonstra a estrutura da nova tela de licenciamento de PDV/SAT.

Através da nova tela, será possível acompanhar o volume das emissões diárias dos documentos NFC-e e CF-e SAT para cada dia do mês, bem como os PDVs que serão cobrados ou não no mês.

O usuário poderá fazer pesquisas aplicando filtros pelo modelo do documento, período mensal do ano, e ainda informando uma série específica.

Se o modelo utilizado pela empresa for bilhetagem, a quantidade de PDVs não impactará na cobrança e sim qualquer emissão de NFC-e/SAT ou eventos computará a cobrança do mês.

Já se o modelo utilizado for manutenção mensal, temos controles por MAC da placa de rede do PDV (somente NFC-e) ou controle por série do documento (para NFC-e /SAT). A cada novo MAC ou nova série dos documentos emitidos no mês, gerará um novo PDV. Este novo PDV poderá ser ou não cobrado, dependendo da situação.

Por exemplo: a necessidade de substituição do PDV por outro, o PDV antigo não terá mais emissões no mês, caracterizando que houve uma manutenção do PDV. Então não será cobrado o PDV antigo, somente o PDV atual.

Para a identificação destas situações, foram incluídos novos controles e a nova tela de Licenciamento de PDV/SAT.

É importante destacar que emissões de testes em ambiente de produção poderão ser cobradas, pois os testes devem ser realizados em ambiente de homologação. Caso ocorram algumas emissões iniciais de testes em ambiente de produção, entende-se que o PDV foi ativado e (após os testes) seguirá emitindo as vendas do estabelecimento, portanto caracteriza como um PDV utilizado no mês.

 

Criptografia da senha do certificado ao cadastrar empresa via WS

Última atualização em: 04 de janeiro, 2017

 

Para garantir maior tranquilidade e segurança ao usuário Parceiro a Plataforma InvoiCy faz uso de comunicação via HTTPS, e além disso permite que o Parceiro envie a senha do seu certificado digital de forma criptografada, no momento de efetuar o cadastro de uma empresa via Web Service.

Para isso basta enviar o cadastro da empresa, seguindo o layout padrão do InvoiCy disponível no artigo Cadastrar empresa via Web Service, porém sem enviar os dados do certificado digital.

Para maiores informações visualize a estrutura do layout de integração para cadastro de empresa clicando aqui.

A empresa será cadastrada com sucesso, e no retorno do Web Service o usuário receberá na tag <ChaveCriptografia> uma chave de 32 caracteres, única por empresa. Esta é a chave que deverá ser utilizada pelo Parceiro para efetuar a criptografia da senha do seu certificado digital, usando o método AES.

O método AES trata-se de um Padrão de Criptografia Avançada. Para obter mais informações sobre esse método de criptografia acesse o link https://pt.wikipedia.org/wiki/Advanced_Encryption_Standard.

O próximo passo é criptografar a senha do seu certificado digital, fazendo uso da chave de criptografia obtida no retorno do cadastro da empresa, por meio do método AES, e efetuar a atualização do cadastro da empresa enviando as informações do certificado, juntamente com a senha criptografada.

Ao efetuar a atualização do cadastro da empresa, não é necessário informar todos os dados novamente, basta enviar o CNPJ da empresa juntamente com os dados do certificado, e a nova tag <MetodoCriptografiaSenha>, que deverá ser preenchida com o método utilizado para criptografia da senha, neste caso o método AES. A imagem abaixo demonstra a estrutura que deverá ser enviada para cadastrar o certificado com a senha criptografada.

É importante destacar que esta opção está disponível apenas para o cadastro de empresas via WS, e que enviar o certificado com a senha criptografada é uma escolha do usuário Parceiro, não é uma obrigatoriedade. O cadastro da empresa continuará sendo executado normalmente caso o usuário Parceiro decida enviar o certificado sem criptografar a senha do mesmo, lembrando que mesmo sem criptografar a senha o cadastro será executado com segurança, devido a utilização de comunicação via HTTPS.

Consultar quantidade de documentos emitidos via Web Service

Última atualização em: 09 de janeiro, 2017

 

Olá! Neste artigo vamos lhe auxiliar a realizar a integração do seu ERP com o novo Web Service disponibilizado para consultar a quantidade de documentos emitidos pela sua empresa no InvoiCy. Pronto para iniciar? Então vamos lá!

A Plataforma InvoiCy disponibiliza de um novo Web Service para efetuar a consulta da quantidade de documentos emitidos pela sua empresa, dentro de um determinado período. Essa funcionalidade pode ser utilizada sem a necessidade de interação com a interface da Plataforma InvoiCy, pois todo o processo funciona via Web Service.

O seu ERP deve realizar a integração com o novo Web Service disponibilizado pelo InvoiCy. Trata-se do WS aconsultabilhetagem.aspx. Este Web Service é único e deve ser utilizado apenas para efetuar a consulta da quantidade de documentos emitidos por sua empresa no InvoiCy, independente do tipo de documento que se deseja consultar. Abaixo, detalhamos o processo de integração com esse Web Service.

Para realizar a integração siga os seguintes passos:

1. Visualize a estrutura WSDL do Web Service

Para visualizar a estrutura WSDL do Web Service basta copiar e colar o link do Web Service em seu navegador de internet, por exemplo, https://homolog.invoicy.com.br/aconsultabilhetagem.aspx. Assim podemos visualizar toda a estrutura do WSDL, conforme demonstra a imagem abaixo:

2. Realize o consumo do Web Service

Você deverá realizar o consumo do Web Service para efetuar a integração. Ao consumir o WS você deverá informar os seguintes parâmetros:

EmpPK: Chave de Parceiro disponibilizada pela Migrate para cada cliente.

Exemplo: PYcEsFuKroDBojfiFEl+Ms==

A chave de parceiro é gerada por nosso Sistema de Gestão no momento que a sua empresa é cadastrada como nosso parceiro. A mesma será enviada por e-mail e utilizada para controlar as empresas de clientes finais que utilizarão licenças adquiridas pela sua empresa.

EmpCK: Código HASH gerado em formato MD5 de acordo com os dados enviados.

Exemplo: 213f3b55d679e790258fd811cc86d309

Utilizado para validar a comunicação e proporcionar segurança à comunicação. Consulte o artigo “Como gerar o código Hash MD5?” para mais informações.

Por questões de segurança, ao invés de utilizar a chave de acesso para gerar a chave de comunicação deverá ser utilizada a Chave de acesso do parceiro, que estará disponível na tela de Módulos contratados, apenas para usuários Administrador ou Parceiro. A imagem a seguir demonstra a localização dessa nova chave.

EmpCO: Identificador do PDV.

Texto: Uso interno do InvoiCy. Não é necessário o preenchimento.

Documento: Conteúdo do XML com os parâmetros da consulta a ser enviada para o InvoiCy.

Parâmetros: Neste campo podem ser informados alguns parâmetros, como por exemplo, quais dados deseja que retorne ao executar uma consulta de documentos. Seu preenchimento é obrigatório para efetuar uma consulta, mas especificamente para esse tipo de consulta da quantidade de documentos não é obrigatório.

Dentro da TAG <inv:Documento>, você deverá informar o conteúdo XML da consulta. O conteúdo das tags “Documento” e “Parametros” deve ser convertido para texto, como demonstra a imagem abaixo:

Clique aqui para fazer download do exemplo SOAP exibido na imagem.

3. Gere a estrutura do arquivo XML de consulta

Para efetuar a consulta da quantidade de documentos emitidos pela empresa, deve-se informar os seguintes parâmetros na estrutura do XML:

– Modelo do documento: NF-e, NFC-e, CT-e, MDF-e, CF-e SAT, NFS-e

– Tipo do ambiente: 1 – Produção; 2 – Homologação

– Tipo da consulta: 1 – Acumulado: ao informar esse tipo de consulta será necessário definir se deseja obter os documentos acumulados apenas do dia anterior ou os documentos acumulados do mês, até o dia anterior; 2 – Período: será necessário informar o período desejado para a consulta, respeitando o limite de 3 meses.

– Acumulado: Ao optar pelo tipo de consulta 1 – Acumulado, deverá escolher a forma da consulta, 1 – Do dia anterior: a consulta irá retornar apenas os documentos acumulados do dia anterior; 2 – Do mês: a consulta irá retornar os documentos acumulados do mês, até o dia anterior.

É importante destacar que ao realizar uma consulta acumulada do mês (até o dia anterior) no dia 01/11, por exemplo, irá retornar os documentos do mês anterior, ou seja, do mês de outubro.

Se a consulta for acumulada do dia anterior, no dia 01/12, por exemplo, irá retornar apenas os documentos do dia 30/11.

Já ao executar uma consulta acumulada do dia anterior, ou acumulada do mês (até o dia anterior) no dia 02/12, irá retornar apenas os documentos do dia 01/12.

Data de Inclusão Inicial: quando o tipo de consulta for por Período deverá informar a data inicial da consulta.

Data de Inclusão Final: quando o tipo de consulta for por Período deverá informar a data final da consulta, que deverá ser menor que a data atual e o período não poderá ultrapassar o limite de 3 meses.

CNPJ do Emissor: ao efetuar a consulta o usuário poderá obter o retorno dos documentos de uma empresa específica, então deverá informar o CNPJ dessa empresa. É possível também efetuar a consulta para mais de uma empresa ao mesmo tempo, basta informar os CNPJ correspondentes a cada empresa. Caso nenhum CNPJ seja informado a consulta será realizada para todas as empresas do Parceiro, que possuem licença ativa para o módulo consultado.

A imagem a seguir demonstra a estrutura do layout XML de envio para consulta.

Layout consulta Bilhetagem

Clique aqui para visualizar um exemplo do XML com os parâmetros para consulta.

Para facilitar seu entendimento disponibilizamos um exemplo do layout de envio em Excel, clique aqui para fazer o download.

4. Realize a leitura do retorno do envio

Após o envio da consulta de quantidade dos documentos, precisamos realizar a leitura do retorno do processamento dessa requisição. O retorno recebido segue a seguinte estrutura SOAP.

Para fazer download do arquivo SOAP exibido na imagem clique aqui. A estrutura SOAP acima demonstra o retorno da consulta de documentos de apenas uma única empresa.

Abaixo demonstramos a estrutura do XML de retorno da consulta.

Retorno consulta Bilhetagem

OBSERVAÇÃO: O InvoiCy conta com um controle das requisições recebidas, onde ao receber várias vezes a mesma requisição de consulta, dentro de um determinado período de tempo, irá bloquear essa requisição para prevenir que o ERP do cliente não entre em loop e cause lentidão no sistema.