Skip to content

WS015 - Send NF-e to Comprovai

Objective

This integration aims to allow the sending of an NF-e to be tracked by Comprovei©.

Important

By default, an NF-e sent to Comprovai will be treated as a Document. However, through a parameter, It is possible to configure the NF-e to be treated as a DANFE, being necessary to import a CT-e to finalize the link and create a Document.

Method description
Método uploadNFe
WSDL principal https://soap.comprovei.com.br/importQueue/index.php?wsdl
WSDL de contingencia https://soapcontingencia.comprovei.com.br/importQueue/index.php?wsdl

Important

  1. The connection to our service must be made to our main server, however we strongly suggest that a connection to our contingency server is also made available, as a guarantee of the availability of our services. The contingency server is only turned on in situations where our main server is unavailable. Making the connection url parameterizable is also a good practice;
  2. Our connections are secure using the SSL protocol. For security reasons, our certificates are constantly changed without prior notice. Therefore, it is recommended that you do not develop integrations based on a fixed certificate.
  3. We constantly (and without prior notice) add new fields and structures to both requests and responses from our web services. Anyone who uses our webservices must implement it in such a way that the programs that consume these webservices do not stop working when the mentioned field changes occur.

Features

  • Calls will be made via SOAP over HTTPS;
  • The origin of the Web Service call will be the client's system;

Important

The user of this Web Service must store the protocol generated in the response. Support tickets regarding this integration will require this protocol.

Authentication

  • Calls will have transport-level authentication (Basic Authentication);
  • Request user / password from the account administrator.

Example HTTP header with authentication

POST https://soap.comprovei.com.br/importQueue/index.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#uploadNFe"
Authorization: Basic BASE64(user:password)
Content-Length: {quantidade de bytes enviados}
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Request

The request for our Web Service is composed as follows:

TAG Type Description
conteudoArquivo string Contents of the NF-e file encoded in Base64.
nomeArquivo string Name of the sent file, with the extension. Example: nfe33170833000167008862550070002582311450123456.xml

Request Example

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:uploadNFe soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <conteudoArquivo xsi:type="xsd:string"><?xml version="1.0" encoding="UTF-8"?>
<nfeProc xmlns="http://www.portalfiscal.inf.br/nfe" versao="3.10">
   <NFe>
      <infNFe versao="3.10" Id="NFe33170833000167008862550070002582311450123456">
         <ide>
            <cUF>33</cUF>
            <cNF>45042298</cNF>
            <natOp>Venda Contra Entrega (Produto Quotado)</natOp>
            <indPag>1</indPag>
            <mod>55</mod>
            <serie>7</serie>
            <nNF>1234567</nNF>
            <dhEmi>2019-01-07T18:22:00-03:00</dhEmi>
            <dhSaiEnt>2019-01-07T18:22:00-03:00</dhSaiEnt>
            <tpNF>1</tpNF>
            <idDest>2</idDest>
            <cMunFG>CodigoMunicipio</cMunFG>
            <tpImp>1</tpImp>
            <tpEmis>1</tpEmis>
            <cDV>2</cDV>
            <tpAmb>1</tpAmb>
            <finNFe>1</finNFe>
            <indFinal>0</indFinal>
            <indPres>9</indPres>
            <procEmi>0</procEmi>
            <verProc>6.0</verProc>
         </ide>
         <emit>
            <CNPJ>12345678901234</CNPJ>
            <xNome>NomeEmissor</xNome>
            <xFant>FantasiaEmissor</xFant>
            <enderEmit>
               <xLgr>LogradouroEmissor</xLgr>
               <nro>NumeroEmissor</nro>
               <xCpl>ComplementoEmissor</xCpl>
               <xBairro>BairroEmissor</xBairro>
               <cMun>CodigoMunicipioEmissor</cMun>
               <xMun>MunicipioEmissor</xMun>
               <UF>UFEmissor</UF>
               <CEP>CEPEmissor</CEP>
               <cPais>CodigoPaisEmissor</cPais>
               <xPais>Brasil</xPais>
            </enderEmit>
            <IE>12345678</IE>
            <IEST>1234567890123</IEST>
            <CRT>3</CRT>
         </emit>
         <dest>
            <CNPJ>12345678901234</CNPJ>
            <xNome>NomeDestinatario</xNome>
            <enderDest>
               <xLgr>LogradouroDestinatario</xLgr>
               <nro>NumeroDestinatario</nro>
               <xBairro>BairroDestinatario</xBairro>
               <cMun>CodigoMunicipioDestinatario</cMun>
               <xMun>MunicipiDestinatario</xMun>
               <UF>UFDestinatario</UF>
               <CEP>CEPDestinatario</CEP>
               <cPais>CodigoPaisDestinatario</cPais>
               <xPais>Brasil</xPais>
            </enderDest>
            <indIEDest>1</indIEDest>
            <IE>1234567890123</IE>
         </dest>
         <det nItem="1">
            <prod>
               <cProd>CodigoProd</cProd>
               <cEAN/>
               <xProd>DescProduto</xProd>
               <NCM>27101931</NCM>
               <CEST>0600700</CEST>
               <CFOP>6651</CFOP>
               <uCom>L</uCom>
               <qCom>30000.0000</qCom>
               <vUnCom>2.3962386667</vUnCom>
               <vProd>71887.16</vProd>
               <cEANTrib />
               <uTrib>M3</uTrib>
               <qTrib>30.0000</qTrib>
               <vUnTrib>2396.2386666667</vUnTrib>
               <indTot>1</indTot>
               <xPed>11551271</xPed>
               <comb>
                  <cProdANP>610101002</cProdANP>
                  <qTemp>31377.0000</qTemp>
                  <UFCons>MG</UFCons>
                  <CIDE>
                     <qBCProd>0.0000</qBCProd>
                     <vAliqProd>0.0000</vAliqProd>
                     <vCIDE>0.00</vCIDE>
                  </CIDE>
               </comb>
            </prod>
            <imposto>
               <ICMS>
                  <ICMS40>
                     <orig>0</orig>
                     <CST>41</CST>
                  </ICMS40>
               </ICMS>
               <IPI>
                  <cEnq>004</cEnq>
                  <IPINT>
                     <CST>54</CST>
                  </IPINT>
               </IPI>
               <PIS>
                  <PISAliq>
                     <CST>01</CST>
                     <vBC>71887.16</vBC>
                     <pPIS>1.6500</pPIS>
                     <vPIS>1186.14</vPIS>
                  </PISAliq>
               </PIS>
               <COFINS>
                  <COFINSAliq>
                     <CST>01</CST>
                     <vBC>71887.16</vBC>
                     <pCOFINS>7.6000</pCOFINS>
                     <vCOFINS>5463.42</vCOFINS>
                  </COFINSAliq>
               </COFINS>
            </imposto>
            <infAdProd></infAdProd>
         </det>
         <total>
            <ICMSTot>
               <vBC>0.00</vBC>
               <vICMS>0.00</vICMS>
               <vICMSDeson>0.00</vICMSDeson>
               <vBCST>0.00</vBCST>
               <vST>0.00</vST>
               <vProd>71887.16</vProd>
               <vFrete>0.00</vFrete>
               <vSeg>0.00</vSeg>
               <vDesc>0.00</vDesc>
               <vII>0.00</vII>
               <vIPI>0.00</vIPI>
               <vPIS>1186.14</vPIS>
               <vCOFINS>5463.42</vCOFINS>
               <vOutro>0.00</vOutro>
               <vNF>71887.16</vNF>
            </ICMSTot>
         </total>
         <transp>
            <modFrete>1</modFrete>
            <transporta>
               <CNPJ>12345678901234</CNPJ>
               <xNome>NomeTransportadora</xNome>
               <IE>84089478</IE>
               <xEnder>EnderecoTransportadora</xEnder>
               <xMun>MunicipioTransportadora</xMun>
               <UF>UFTransportadora</UF>
            </transporta>
            <veicTransp>
               <placa>CYR2522</placa>
               <UF>SP</UF>
            </veicTransp>
            <vol>
               <qVol>0</qVol>
               <esp>GRANEL</esp>
               <pesoL>26130.000</pesoL>
               <pesoB>26130.000</pesoB>
            </vol>
         </transp>
         <cobr>
            <fat>
               <nFat>0906116993</nFat>
               <vOrig>71887.16</vOrig>
               <vLiq>71887.16</vLiq>
            </fat>
            <dup>
               <nDup>0000000000</nDup>
               <dVenc>2017-09-10</dVenc>
               <vDup>71887.16</vDup>
            </dup>
         </cobr>
         <infAdic>
            <infCpl></infCpl>
            <obsCont xCampo="CANALCLIENTE">
               <xTexto>C.Transp.: Rodoviario</xTexto>
            </obsCont>
         </infAdic>
      </infNFe>
      <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
         <SignedInfo>
            <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
            <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
            <Reference URI="#NFe33170833000167008862550070002582311450123456">
               <Transforms>
                  <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
                  <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
               </Transforms>
               <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
               <DigestValue>ewAO6ER0kFnvDv878deDk4FJJgo=</DigestValue>
            </Reference>
         </SignedInfo>
         <SignatureValue>POPteobaoeKrVIrdENZJY+uwgKdpzrHxQrGNcFcXWF7kYB8yhetv5EBfdESpm3GmpaERqace81X6&amp;#xA;C/XnTxN+ctO3OZ7zeYJmFIMbfShamE+73C7eW98PrEt2B2UJpjhv8QoHwRL0bPU8iXWRcAzDNR+E&amp;#xA;rlcbTMBleqZc7ddNrEQIQpthWJKLDQmlJYCuepzySFystVtN6lCjZ8bdqU7YmVddFGwLTvLWUuoX&amp;#xA;+ZU+HdJWrwmcQl3myuKyox/nJDE6vvacwNg55yizjSDjIWuBGieYnG67ANPouS5uccvHpCdFiMF5&amp;#xA;8NlQepoNKrwkk2SYHCkLJjt4Bfev86JaXrf46Q==</SignatureValue>
         <KeyInfo>
            <X509Data>
               <X509Certificate>MIIH+zCCBeOgAwIBAgIQWazJnbpV8tE2p2sXcBqGUjANBgkqhkiG9w0BAQsFADB0MQswCQYDVQQG&amp;#xA;EwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDEtMCsGA1UECxMkQ2VydGlzaWduIENlcnRpZmljYWRv&amp;#xA;cmEgRGlnaXRhbCBTLkEuMSEwHwYDVQQDExhBQyBDZXJ0aXNpZ24gTXVsdGlwbGEgRzcwHhcNMTcw&amp;#xA;MzE2MTQyMzQ2WhcNMTgwMzE2MTQyMzQ2WjCBvzELMAkGA1UEBhMCQlIxEzARBgNVBAoMCklDUC1C&amp;#xA;cmFzaWwxJTAjBgNVBAsMHEF1dGVudGljYWRvIHBvciBBUiBjZXJ0aXNpZ24xGzAZBgNVBAsMEkFz&amp;#xA;c2luYXR1cmEgVGlwbyBBMTEqMCgGA1UEAwwhUEVUUk9MRU8gQlJBU0lMRUlSTyBTIEEgUEVUUk9C&amp;#xA;UkFTMSswKQYJKoZIhvcNAQkBFhxhY2F2YWxjYW50aUBwZXRyb2JyYXMuY29tLmJyMIIBIjANBgkq&amp;#xA;hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAooJsGaePt3b77JO5hqTKGTgYnZQCgBu7U1kBLsAyywys&amp;#xA;B2weZJUYw6iufmU4mKbL+5jqDIn7vFdFE7rj/+tbBk2zUh855R59hmeVOhfvhxUky2wzh8PaD8rd&amp;#xA;/TnW3ttKCiEteecDueeOvWBSCJ6SIwCJn7yrqahEHnM1pUGQPxLnTlPdflRMl3DSierfoViDFQCN&amp;#xA;hZB4MJczljJT3ic7aWO9R0lZRATCgaoqXh1lFrbnOpmcN6A3pRhTp+87guBb+pmby5qjqSbBnYxy&amp;#xA;StFUB3D11yrbKyKm56mrdwug7rKdPfY1yV943uILu2GcpC/2Wzs60GnmhEJLaTgKfbMlDwIDAQAB&amp;#xA;o4IDOzCCAzcwgckGA1UdEQSBwTCBvqA9BgVgTAEDBKA0BDIxMjAzMTk3Nzg3ODc0NzY4NTE1MDAw&amp;#xA;MDAwMDAwMDAwMDAwMDA1OTk0MzU5OTJTU1BCQaArBgVgTAEDAqAiBCBBbmRlcnNvbiBGYWduZXIg&amp;#xA;U291emEgQ2F2YWxjYW50aaAZBgVgTAEDA6AQBA4zMzAwMDE2NzAwMDEwMaAXBgVgTAEDB6AOBAww&amp;#xA;MDAwMDAwMDAwMDCBHGFjYXZhbGNhbnRpQHBldHJvYnJhcy5jb20uYnIwCQYDVR0TBAIwADAfBgNV&amp;#xA;HSMEGDAWgBRdcgy/M9K744am6EwGcX5VXAeg1jCBiwYDVR0gBIGDMIGAMH4GBmBMAQIBCzB0MHIG&amp;#xA;CCsGAQUFBwIBFmZodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3JlcG9zaXRvcmlv&amp;#xA;L2RwYy9BQ19DZXJ0aXNpZ25fTXVsdGlwbGEvRFBDX0FDX0NlcnRpU2lnbl9NdWx0aXBsYS5wZGYw&amp;#xA;gcYGA1UdHwSBvjCBuzBcoFqgWIZWaHR0cDovL2ljcC1icmFzaWwuY2VydGlzaWduLmNvbS5ici9y&amp;#xA;ZXBvc2l0b3Jpby9sY3IvQUNDZXJ0aXNpZ25NdWx0aXBsYUc3L0xhdGVzdENSTC5jcmwwW6BZoFeG&amp;#xA;VWh0dHA6Ly9pY3AtYnJhc2lsLm91dHJhbGNyLmNvbS5ici9yZXBvc2l0b3Jpby9sY3IvQUNDZXJ0&amp;#xA;aXNpZ25NdWx0aXBsYUc3L0xhdGVzdENSTC5jcmwwDgYDVR0PAQH/BAQDAgXgMB0GA1UdJQQWMBQG&amp;#xA;CCsGAQUFBwMCBggrBgEFBQcDBDCBtgYIKwYBBQUHAQEEgakwgaYwZAYIKwYBBQUHMAKGWGh0dHA6&amp;#xA;Ly9pY3AtYnJhc2lsLmNlcnRpc2lnbi5jb20uYnIvcmVwb3NpdG9yaW8vY2VydGlmaWNhZG9zL0FD&amp;#xA;X0NlcnRpc2lnbl9NdWx0aXBsYV9HNy5wN2MwPgYIKwYBBQUHMAGGMmh0dHA6Ly9vY3NwLWFjLWNl&amp;#xA;cnRpc2lnbi1tdWx0aXBsYS5jZXJ0aXNpZ24uY29tLmJyMA0GCSqGSIb3DQEBCwUAA4ICAQA3pAH1&amp;#xA;4FeqYDexwnCTAc9ADvKaiL5o4mAVezwCdTGwu3KO9D8AekMMiAQoPn7FdddZw7WkyxShRjtTkTwI&amp;#xA;uFwo45N22+JCtuYyUNGpAEvWWMVrL5npUAV9ONZxbpxZToFbQivT2ezxtPxQKAWGd9Ju1J6jqD48&amp;#xA;FUULP2u8cpIM19XUTFQ3w6r61YGqlRkayj6AWALDTxe9RQYsxDTuKGh5dmFIpZ/pC5oBd5YegnMT&amp;#xA;xcN3Fg9MkGqCD4lCONkkvhnv5ruaYXrEQFpljBiL8mAg8r9zGEzwqCGeTiIQrUOWCurmeKIX36Mh&amp;#xA;JRTmvFn+RJdRsgu5G5nzCH5G86fu8mIxtsrJ+XogA+JOtT4gOr1wiRbmWnorZQ5+DDbYEa0ZLCpd&amp;#xA;bXcno+wa8l1QzEA7BKIqIclAuo7+5JmbRcZl2kh8UdLEu9kta9CPVitaZyv72/aCzIaObHE/7qJG&amp;#xA;FVnrYYutP6AWnsv1/aMLa3wr2KC47L4a05n+9ySmx6D0z3SUW2kLidxHiLeO0m4SNFoWcs9vxyTM&amp;#xA;jGOXNgXjG8Nib9uuNgRrI0jYb/eX7RlSZX4AqK/JoJ21Jzv0cA+XIdG+EGVjGU13glqIszGsbD6m&amp;#xA;+w0e6FKM1+SZFENH4XLcnvpeIlL3pyKDwT8+BKIAbpiDTlbsoKKx3/+I0DvtfGVlJzIlrw==</X509Certificate>
            </X509Data>
         </KeyInfo>
      </Signature>
   </NFe>
   <protNFe versao="3.10">
      <infProt>
         <tpAmb>1</tpAmb>
         <verAplic>SVRS201706281116</verAplic>
         <chNFe>33170833000167008862550070002582311450123456</chNFe>
         <dhRecbto>2019-01-0718:23:42-03:00</dhRecbto>
         <nProt>123456789012345</nProt>
         <digVal>ewAO6ER0kFnvDv878deDk4FJJgo=</digVal>
         <cStat>100</cStat>
         <xMotivo>Autorizado o uso da NF-e</xMotivo>
      </infProt>
   </protNFe>
</nfeProc></conteudoArquivo>
         <nomeArquivo xsi:type="xsd:string">nfe33170833000167008862550070002582311450123456.xml</nomeArquivo>
      </urn:uploadNFe>
   </soapenv:Body>
</soapenv:Envelope>

Important

The NF-e in the example is no longer valid before the Revenue because its content has been mischaracterized and, therefore, its cryptographic signature is incorrect.

Response

Our Web Service responds to you as follows:

TAG Type Description
status string Success or error message for the method call.
protocolo string Protocol for checking the progress of the import request.

Protocol

When a file is accepted into our system, a protocol is generated so that the import process can be monitored. This can be done using the WS501 method.

NF-e mapping

The tables below describe the results of the mapping of our Web Service WS015 in relation to WS013.

WS015 WS013
TAG ID, FIELD
TAG ID FIELD DESCRIPTION Standard Value
Tipo - NFe Document type (NFE, OS, CTE, etc.). There is no validation for this information and is for reference only. NFe
TipoParada B06 mod Stop type: for 20 the value defined is 'C' (Collection) and the others are 'E' (Delivery). 'C' or 'E'
Modelo B06 mod Tax model of the document (check with SEFAZ for available models). -
Numero B08 nNF Document number. Only numbers without special characters or spaces. -
Valor W16 vNF Total value of the document. -
Serie B07 series Document series (in the case of NFe). If not, send value 0. 0
Emissao B09 dhEmi Date of issue of the document. The format YYYYMMDD is mandatory. -
Atualização B10 dhSaiEnt Document update date. The format YYYYMMDD is mandatory. -
Chave A03 Id Document key. Normally it is the tax document key (barcode). This field is mandatory and its content must be unique for different documents. -
cnpj E02/EO3 CNPJ/CPF CNPJ (or CPF) of the recipient of the document. (numbers only). -
cnpjEmissor B17/C02 CNPJ/CNPJ CNPJ of the document issuer and/or shipper. (numbers only). -
cnpjTransportador X04 CNPJ CNPJ of the transporter. (numbers only). -
cnpjConsignatario - - CNPJ of the Consignee. (numbers only). -
Romaneio - - Document mailing number. -
Remessa - - Document shipping number. -
Pedido - - Document order number. -
Placa - - Vehicle plate associated with the document. -
Filial - - Branch associated with the document. -
Peso X32 weightB Gross loading weight of the document. -
Cubagem - - Total document load volume. -
ONU - - Document load hazard code. -
Agendamento - - Document scheduling date. -
PesoLíquido X31 weightL Net weight of the document load. -
Volume X27 qVol Number of document volumes. -
Route:
  • Name
  • Date

  • Driver

-
-

-

-
-

-
  • Name
  • Date of the route, in YYYYMMDD format.
  • Code of the driver responsible for the route.

-
-

-
Window
  • StartTime
  • EndTime

-
-

-
-		 Delivery Window
  • Start date and time.
  • End date and time

-
-
Tipo de Material - - Document material type. -
Fornecimento - - Document supply code. -
TipoFrete - - Type of freight contracted for the document. -
Modal
  • Sla
    • DiasUte
    -
    -
    Mode of transport contracted for the document.
    -
    Cliente
  • Codigo
    		•  E02/E03 CNPJ/CPF CNPJ (or CPF) of the recipient of the document. (numbers only). -
  • internal code
    		•  - - Internal or alternative customer code. -
  • Contact
    		•  E04 xName Corporate name or name of recipient. -
  • Telephone
    		•  E16 phone Telephone. -
  • Email
    		•  E19 email Email. -
  • Reason
    		•  E04 xName Corporate name or name of recipient. -
  • Address
    		•  E06, E07, E08 xLgr, nro, xCpl xLgr (Street), nro(Number) and xCpl(Complement). -
  • Neighborhood
    		•  E09 xBairro Neighborhood. -
  • City
    		•  E11 xMun Name of the municipality. -
  • State
    		•  E12 UF UF acronym. -
  • Country
    		•  E15 xCountry Country Name. -
  • CEP
    		•  E13 CEP CEP Code. -
  • Region
    		•  - - Region or branch or route of the delivery address. -
  • ClientType
    		•  - - Free field to differentiate, in the system, whether the client in question is special or common. -
  • Message
    		•  - - Informative text for the driver about the customer. Ex. Deliver NO 2nd. Room 21 -
  • gerentecodigo
    		•  - - Account manager code. -
  • managername
    		•  - - Name of account manager. -
  • emailmanager
    		•  - - Email account of the account manager. -
  • mobile manager
    		•  - - Account manager's cell phone in the format DDDNNNNNNNNN. -
  • supervidorcodigo
    		•  - - Account supervisor code. -
  • supervisorname
    		•  - - Name of account supervisor. -
  • supervisoremail
    		•  - - Email account of the account supervisor. -
  • supervisorcellphone
    		•  - - Account supervisor's cellphone in the format DDDNNNNNNNNN. -
  • codigoIBGE
    		•  E10 cMun Municipality code. -
    Danfes
  • danfe
    		•
        • serieDanfe
    		 - - NF-e series. -
        • chavedanfe
    		 - - NF-e key. -
        • dataemissaodanfe
    		 - - Date of issue of this NF-e, in the format DDDNNNNNNNNN. -
    SKUs
  • Sku
    		•
        • Gross Weight
    		 - - Gross Weight. 0
        • Net Weight
    		 - - Net Weight. 0
        • Volumes
    		 - - Volumes. 1
        • Description
    		 I04 xProd Description of the product or service. -
        • Qde
    		 I10 qCom Commercial Quantity. -
        • Uom
    		 I09 uCom Commercial Unit. -
        • Barcode
    		 I12 cENTrib GTIN (Global Trade Item Number) of the taxable unit, former EAN code or barcode. -

    Important

    The tags referring to the TAG field in the table above are descendants of the parent Documents tag and the child Document tag in WS015.

    Response Example

    <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:uploadNFeResponse>
         <status xsi:type="xsd:string">Arquivo adicionado para a fila de importação!</status>
         <protocolo xsi:type="xsd:string">2017022258add9af06990</protocolo>
      </ns1:uploadNFeResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>