Pular para conteúdo

Novo Web Service para Consultas de Documentos

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.

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. Esta 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 visualizar a estrutura WSDL do Web Service, basta copiar e colar o link do Web Service em seu navegador de internet.

As empresas que utilizam o ambiente de homologação, devem utilizar o link: https://consultahomolog.invoicy.com.br/aconsultadocumentos.aspx?wsdl.

Já as empresas que fazem uso do ambiente de produção, devem utilizar: https://consulta.invoicy.com.br/aconsultadocumentos.aspx?wsdl.

Realize o consumo do Web Service para efetuar a integração. Ao consumir o WS, você deverá informar os parâmetros. O conteúdo das tags "Documento" e "Parametros" deve ser convertido para texto, como demonstrado abaixo:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="InvoiCy">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:recepcao.Execute>
         <inv:Invoicyrecepcao>
            <inv:Cabecalho>
               <inv:EmpPK>ABCabcCBAcbaA+CabcCBAc==</inv:EmpPK>
               <inv:EmpCK>91715df5ee0669f117b27b5cbb6ca16d</inv:EmpCK>
               <inv:EmpCO></inv:EmpCO>
            </inv:Cabecalho>
            <inv:Informacoes>
               <inv:Texto></inv:Texto>
            </inv:Informacoes>
            <inv:Dados>
               <inv:DadosItem>
                  <inv:Documento><!-- (1) --></inv:Documento>
                  <inv:Parametros><!-- (2) --></inv:Parametros>
               </inv:DadosItem>
            </inv:Dados>
         </inv:Invoicyrecepcao>
      </inv:recepcao.Execute>
   </soapenv:Body>
</soapenv:Envelope>
  1. Neste campo, informe o XML de envio. Para visualizar um exemplo de envio, clique aqui.
  2. Para visualizar um exemplo de parâmetros de consulta, clique aqui.

Segue abaixo, uma breve descrição sobre como preencher cada um dos campos obrigatórios no envio desta requisi:

  • EmpPK: Chave de Parceiro disponibilizada pela Migrate para cada cliente. 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. Utilizado para validar a comunicação e proporcionar segurança à comunicação. Consulte o artigo 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.

  • Parametros: 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.

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, clicando aqui.

Atente-se as datas de implementação do novo Web Service:

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