Novo Web Service para Consulta de Documentos

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

A Plataforma InvoiCy disponibiliza um novo Web Service para efetuar a consulta de documentos, com o objetivo de oferecer mais performance e estabilidade, com a nova infraestrutura dedicada exclusivamente às consultas, você terá acesso mais rápido e confiável aos seus documentos.

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 aconsultadocumentos.aspx. Este Web Service é único, e deve ser utilizado apenas para efetuar a consulta de documentos no InvoiCy. Abaixo, detalhamos o processo de integração com esse Web Service.

Para realizar a integração, realize os seguintes passos:

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, para empresas que utilizam o ambiente de homologação, utilizar o link: https://consultahomolog.invoicy.com.br/aconsultadocumentos.aspx?wsdl.

Já para empresas que fazem uso do ambiente de produção, o link utilizado deve ser o seguinte: https://consulta.invoicy.com.br/aconsultadocumentos.aspx?wsdl.

Assim podemos visualizar toda a estrutura do WSDL, conforme demonstra a imagem abaixo:

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.

• 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 na consulta dos documentos. Seu preenchimento é obrigatório para efetuar a 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 XML exibido na imagem.

Gere a estrutura do arquivo XML de consulta

Após o consumo do Web Service realizado, o próximo passo é gerar a estrutura do arquivo XML de consulta. O passo a passo pode ser encontrado no artigo “Consultando um Documento (NF-e, NFC-e, MDF-e ou CT-e)” 

ATENÇÃO!  Atente-se as datas de implementação do novo Web Service.

Homologação: 11/08/2025
Produção: 15/09/2025