Importação de documentos via Web Service

Olá! Neste artigo vamos explicar sobre o funcionamento do Web Service disponibilizado para importação de documentos no InvoiCy. O seu ERP deve realizar a integração com o Web Service aimportacao.aspx disponibilizado pelo InvoiCy. Este WS é único, e deve ser utilizado apenas para efetuar a importação de documentos no InvoiCy, independentemente do tipo de documento que se deseja importar.

Porém, é importante destacar que para realizar a importação de documentos através desse Web Service a empresa deve ter ativa a extensão Documentos importados.

Para saber mais sobre essa extensão e como ativá-la leia o artigo Extensão Importação de documentos.

Para realizar a integração com o Web Service siga os passos abaixo.

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.

Para empresas que utilizam o ambiente de homologação, utilizar o link https://uploadhml.invoicy.com.br/aimportacao.aspx?wsdl. Já para empresas que utilizam ambiente de produção, devem utilizar o link https://upload.invoicy.com.br/aimportacao.aspx?wsdl.

Assim é possível visualizar 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 propor segurança à comunicação. Consulte o artigo “Como gerar o código Hash MD5?” para mais informações.

• EmpCNPJ: informar um CNPJ válido, que possui o módulo do documento a ser importado ativo na extensão de Importação de Documentos. Não é obrigatório informar o CNPJ da empresa relacionada no arquivo que será importado. A chave EmpCK deverá ser gerada com a chave de acesso do CNPJ informado neste campo.
• Texto: Uso interno do InvoiCy. Não é necessário o preenchimento.
• Documento: Conteúdo do XML a ser importado para o InvoiCy.
• Parâmetros: Não é necessário o preenchimento.

3. Realize a importação do arquivo XML

Através desse Web Service você usuário poderá importar os arquivos XML de documentos NF-e, CT-e, MDF-e, NFC-e, NFS-e e CF-e, tanto de entrada como de saída.

Você deve enviar toda a estrutura dos arquivos XML emitidos que serão importados para o InvoiCy, dentro da tag ‘Documentos’ convertido para texto, como demonstra a imagem.

Clique aqui para fazer download do XML exibido na imagem.

Após o envio do arquivo será retornado o número e a data do protocolo, que poderá ser utilizado para consultar o documento.

No caso de sucesso na importação do arquivo a mensagem retornada será a seguinte: “100 – Documentos processados”. Caso ocorrer alguma falha a mesma será retornada.

Caso a importação for finalizada com sucesso, ao acessar o InvoiCy já poderá consultar pelo documento que foi importado.

4 . Consulta da situação dos documentos enviados via Web Service de Importação

É possível consultar a situação dos documentos que foram enviados para o Web Service de Importação, permitindo ao usuário ter certeza de quais documentos foram realmente importados para o InvoiCy.

Para isso basta enviar a seguinte estrutura de consulta, conforme demonstra a imagem abaixo, informando o número do protocolo, que é retornado no momento da importação, e o modelo de documento, após efetuar o envio dos documentos para importação. Clique aqui para fazer download do modelo de XML de consulta do protocolo.

Para o respectivo protocolo consultado, será retornada a quantidade de arquivos importados com sucesso e a quantidade de arquivos com falhas de importação, juntamente com a descrição da falha e o XML do documento. A imagem abaixo demonstra essa estrutura de retorno.

Ao realizar a consulta do protocolo para o módulo NFS-e, pode-se obter os documentos no layout único do InvoiCy, basta informar a tag <RetornarDocumentos> preenchida com S. Clique aqui para fazer download do modelo de XML de consulta do protocolo para o módulo NFS-e.

No resultado da consulta será retornado o layout dos documentos importados no respectivo protocolo.  Lembrando que essa funcionalidade está disponível apenas para documentos do módulo NFS-e.