Pular para conteúdo

Importação de Documentos

Inicialmente, o seu ERP deve realizar a integração com o Web Service aimportacao.aspx, disponibilizado pelo InvoiCy. Este Web Service é único, e deve ser utilizado apenas para efetuar a importação de documentos no InvoiCy, independentemente do tipo de documento que pretende importar.

É importante destacar, que para realizar a importação de documentos através deste Web Service, a empresa precisa ter a extensão Importação de Documentos ativa, além de estabelecer uma comunicação com o Web Service apropriado. Primeiramente, visualize a estrutura WSDL do mesmo:

Em seguida, será necessário realizar o consumo do Web Service para efetuar a integração.

Exemplo de Envio

Através deste Web Service, o usuário poderá realizar a importação de qualquer modelo de documento, tanto emitido como recebido. Além disso, para realizar esta importação, toda a estrutura XML deve ser inserida dentro da tag <inv:Documento>, em formato linearizado e convertida para texto, conforme o exemplo 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>dcbaf97f1455862e5d4924c7d1b79bdb</inv:EmpCK>
               <inv:EmpCNPJ>99999999999999</inv:EmpCNPJ>
            </inv:Cabecalho>
            <inv:Informacoes>
               <inv:Texto></inv:Texto>
            </inv:Informacoes>
            <inv:Dados>
               <inv:DadosItem>
                  <inv:Documento><!-- (1) --></inv:Documento>
                  <inv:Parametros></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.

Ressaltando que, para cada importação, será necessário inserir o documento fiscal que pretende importar para o InvoiCy no XML de envio. Também, é possível importar múltiplos documentos em uma única requisição, basta incluí-los na estrutura do XML de envio.

Exemplo de Retorno

Com o envio da requisição, é necessário realizar a leitura de retorno do processamento. O retorno recebido segue a seguinte estrutura SOAP:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body>
      <Importacao.ExecuteResponse xmlns="InvoiCy">
         <Importacaoretorno>
            <NumeroProtocolo>345521385073861</NumeroProtocolo>
            <DataProtocolo>2025-12-22T14:30:23</DataProtocolo>
            <Mensagem>
               <MensagemItem>
                  <Codigo>100</Codigo>
                  <Descricao>Documentos processados</Descricao>
               </MensagemItem>
            </Mensagem>
         </Importacaoretorno>
      </Importacao.ExecuteResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

No caso de sucesso na importação, serão retornados o número e a data do protocolo do documento, juntamente com o código de retorno "100" e a mensagem "Documentos processados". No entanto, se ocorrer alguma falha na importação, a mesma será retornada e poderá ser corrigida.

Consulta por Protocolo

É possível consultar a situação dos documentos importados ao acessar o InvoiCy ou através de uma consulta de documentos via Web Service.

Para realizar a consulta por protocolo via Web Service, é necessário informar no XML de envio o número do protocolo e o modelo de documento, que podem ser obtidos no retorno da importação de documentos. Além disso, para realizar esta consulta, toda a estrutura XML deve ser inserida dentro da tag <inv:Documento>, em formato linearizado e convertida para texto, conforme o exemplo 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>6a0f88d24517d959f02fe8bdb6b503d1</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></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.

No retorno do protocolo consultado, será informada 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.

Destacando que, 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". No resultado desta consulta será retornado o layout dos documentos importados no respectivo protocolo.