Pular para conteúdo

WS015 - Enviar NF-e para Comprovei

Objetivo

Esta integração tem por objetivo permitir o envio de uma NF-e para que seja rastreada pela Comprovei©.

Importante

Por padrão, uma NF-e enviada para a Comprovei será tratada como um Documento. Porém, através de um parâmetro, é possível configurar que a NF-e seja tratada como uma DANFE, sendo necessário importar um CT-e para finalizar o vínculo e criar um Documento.

Descrição do método

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

Importante

  1. A conexão ao nosso serviço deve ser feito ao nosso servidor principal, porém sugerimos fortemente que também seja disponibilizada uma conexão ao nosso servidor de contingência, como garantia de disponibilidade dos nossos serviços. O servidor de contingência só é ligado em situações de indisponibilidade do nosso servidor principal. Tornar parametrizável a url de conexão também é uma boa prática;
  2. Nossas conexões são seguras utilizando o protocolo SSL. Por questão de segurança nossos certificados são alterados constantemente e sem aviso prévio. Portanto é recomendável que não desenvolvam as integrações baseadas em um certificado fixo.
  3. Constantemente (e sem aviso prévio) adicionamos novos campos e estruturas tanto nas requisições quanto nas respostas dos nossos webservices. Quem for utilizar nossos webservices deve implementar de tal maneira que os programas que consomem estes webservices não deixem de funcionar quando houver as alterações de campos mencionadas.

Características

  • As chamadas serão realizadas via SOAP sobre HTTPS;
  • A origem do chamado do Web Service será o sistema do cliente;

Importante

O usuário deste Web Service deve armazenar o protocolo gerado na resposta. Chamados de suporte referentes a esta integração irão necessitar deste protocolo.

Autenticação

  • As chamadas terão autenticação a nível de transporte (Basic Authentication);
  • Solicite o user / password ao administrador da conta.

Exemplo cabeçalho HTTP com a autenticação

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

A requisição para o nosso Web Service é composta da seguinte forma:

TAG Tipo Descrição
conteudoArquivo string Conteúdo do arquivo NF-e codificado em Base64.
nomeArquivo string Nome do arquivo enviado, com a extensão. Exemplo: nfe33170833000167008862550070002582311450123456.xml

Exemplo de Request

<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>

Importante

A NF-e do exemplo não é mais válida perante a Receita pois seu conteúdo foi descaracterizado e, portanto, sua assinatura criptográfica está incorreta.

Response

Nosso Web Service responde para você da seguinte forma:

TAG Tipo Descrição
status string Mensagem de sucesso ou de erro para a chamada do método.
protocolo string Protocolo para consultar a evolução do pedido de importação.

Protocolo

Quando um arquivo é aceito no nosso sistema, um protocolo é gerado para que o processo de importação seja acompanhado. Isso pode ser feito utilizando o método WS501.

Mapeamento NF-e

Nas Tabelas abaixos são descritas os resultados do mapeamento do nosso Web Service WS015 em relação ao WS013.

WS015 WS013
TAG ID, CAMPO
TAG ID CAMPO DESCRIÇÃO Valor Padrão
Tipo - NFe Tipo do documento (NFE, OS, CTE, etc). Não existe validação para esta informação e serve apenas para referência. NFe
TipoParada B06 mod Tipo da parada: para 20 o valor definido fica em 'C' (Coleta) e os demais fica com 'E' (Entrega). 'C' ou 'E'
Modelo B06 mod Modelo fiscal do documento (verificar junto a SEFAZ os modelos disponíveis). -
Numero B08 nNF Número do documento. Somente números sem caracteres especiais ou espaços. -
Valor W16 vNF Valor total do documento. -
Serie B07 serie Série do documento (no caso de NFe). Se não tiver, enviar valor 0. 0
Emissao B09 dhEmi Data de emissão do documento. Obrigatório o formato YYYYMMDD. -
Atualização B10 dhSaiEnt Data de atualização do documento. Obrigatório o formato YYYYMMDD. -
Chave A03 Id Chave do documento. Normalmente é a chave do documento fiscal (barcode). Este campo é obrigatório e seu conteúdo deve ser único para documentos diferentes. -
cnpj E02/EO3 CNPJ/CPF CNPJ (ou CPF) do destinatário do documento. (somente números). -
cnpjEmissor B17/C02 CNPJ/CNPJ CNPJ do emitente do documento e/ou do embarcador. (somente números). -
cnpjTransportador X04 CNPJ CNPJ do transportador. (somente números). -
cnpjConsignatario - - CNPJ do Consignatario. (somente números). -
Romaneio - - Número do romaneio do documento. -
Remessa - - Número de remessa do documento. -
Pedido - - Número do pedido do documento. -
Placa - - Placa de veículo associado ao documento. -
Filial - - Filial associada ao documento. -
Peso X32 pesoB Peso bruto de carga do documento. -
Cubagem - - Volume total da carga do documento. -
ONU - - Código de periculosidade da carga do documento. -
Agendamento - - Data de agendamento do documento. -
PesoLíquido X31 pesoL Peso líquido da carga do documento. -
Volume X27 qVol Quantidade de volumes do documentos. -
Rota:
  • Nome
  • Data

  • Motorista


-
-

-


-
-

-

  • Nome
  • Data da rota, no formato YYYYMMDD.
  • Código do motorista responsável pela rota.


-
-

-
Janela
  • DataHoraIni
  • DataHoraFim


-
-


-
-
Janela de Entrega
  • Data e Hora de início.
  • Data e Hora do Fim


-
-
Tipo de Material - - Tipo de material do documento. -
Fornecimento - - Código de fornecimento do documento. -
TipoFrete - - Tipo de frete contratado para o documento. -
Modal
  • Sla
    • DiasUte

    -

    -

    Modal de transporte contratado para o documento.

    -
    Cliente
  • Codigo
  • E02/E03 CNPJ/CPF CNPJ (ou CPF) do destinatário do documento. (somente números). -
  • codigointerno
  • - - Código interno ou alternativo do cliente. -
  • Contato
  • E04 xNome Razão Social ou nome do destinatário. -
  • Telefone
  • E16 fone Telefone. -
  • Email
  • E19 email Email. -
  • Razao
  • E04 xNome Razão Social ou nome do destinatário. -
  • Endereço
  • E06, E07, E08 xLgr, nro, xCpl xLgr (Logradouro), nro(Número) e xCpl(Complemento). -
  • Bairro
  • E09 xBairro Bairro. -
  • Cidade
  • E11 xMun Nome do município. -
  • Estado
  • E12 UF Sigla da UF. -
  • Pais
  • E15 xPais Nome do País. -
  • CEP
  • E13 CEP Código do CEP. -
  • Região
  • - - Região ou filial ou rota do endereço de entrega. -
  • TipoCliente
  • - - Campo livre para diferenciar, no sistema, se o cliente em questão é especial ou comum. -
  • Mensagem
  • - - Texto informativo para motorista sobre o cliente. Ex. Entregar NO 2and. Sala 21 -
  • gerentecodigo
  • - - Código do gerente da conta. -
  • gerentenome
  • - - Nome do gerente da conta. -
  • gerenteemail
  • - - Conta de email do gerente da conta. -
  • gerentecelular
  • - - Celular do gerente da conta no formato DDDNNNNNNNNN. -
  • supervidorcodigo
  • - - Código do supervisor da conta. -
  • supervisornome
  • - - Nome do supervisor da conta. -
  • supervisoremail
  • - - Conta de email do supervisor da conta. -
  • supervisorcelular
  • - - Celular do supervisor da conta no formato DDDNNNNNNNNN. -
  • codigoIBGE
  • E10 cMun Código do município. -
    Danfes
  • danfe
        • serieDanfe
    - - Série da NF-e. -
        • chavedanfe
    - - Chave da NF-e. -
        • dataemissaodanfe
    - - Data de emissão desta NF-e, no formato DDDNNNNNNNNN. -
    SKUs
  • Sku
        • PesoBruto
    - - Peso Bruto. 0
        • PesoLiquido
    - - Peso Líquido. 0
        • Volumes
    - - Volumes. 1
        • Descricao
    I04 xProd Descrição do produto ou serviço. -
        • Qde
    I10 qCom Quantidade Comercial. -
        • Uom
    I09 uCom Unidade Comercial. -
        • Barcode
    I12 cENTrib GTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras. -

    Importante

    As tags referentes ao campo TAG na tabela acima são descendentes da tag pai Documentos e da tag filha Documento no WS015.

    Exemplo de Response

    <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>