WS002 - Enviar documento para Comprovei

Objetivo

Enviar um documento para a Comprovei.  Permite o envio de apenas 1 documento por chamada.
Uma documento é caracterizado por:
  • Chave da Danfe (chave)
  • Tipo e numero do documento
  • Emissor do documento
  • Cliente destinatário
  • Transportadora
  • Itens do documento

Características
  • As chamadas serão realizadas via "SOAP" sobre HTTP;
  • A origem do chamado do web service será o sistema do cliente;

Autenticação

  • As chamadas terão autenticação a nível de transporte (Basic Authentication);
  • Solicite o user / password ao administrador da conta
POST http://soap.comprovei.com.br/WebServicePOD/server.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#sendDocsToPOD"
Authorization: Basic {* user/password codificado em BASE64}
Content-Length: 117
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Descrição do método
 Método    ImportDocsToPOD
 Endereço de acesso  http://soap.comprovei.com.br/WebServicePOD/server.php?wsdl
 Versão atual  2.2 (30/04/2016)
 3.0 (07/07/2016)

Histórico das versões
 Data Responsável Histórico
 30/04/2016 rmiura Alteração da url de conexão
 07/07/2016 rmiura Inclusão da tag <cliente><codigointerno>
 18/11/2016     paulok  Inclusão das tags Peso | Cubagem | ONU

Parâmetros de entrada
 Atributo  Tipo  Descrição
 conteudoArquivo  MIME Base64  conteúdo do arquivo {nome_do_arquivo.xml} codificado em MIME Base64    
 nomeArquivo  conjunto de caracteres  {nome_do_arquivo.xml} para identificação no servidor

Parâmetros de saída

 Atributo  Tipo  Descrição
 status  conjunto de caracteres  mensagem de retorno informando se o upload e a importação dos dados foram realizados com sucesso.  

Estrutura do arquivo {nome_do_arquivo.xml}

 Atributo  Tipo  Obrigatório  Descrição
+Documentos    sim  Indicador de inicio e fim do arquivo .xml
    +Documento    sim  Indicador de inicio da estrutura de um documento.  
        Tipo  string  sim  Tipo do documento NFS, OS, REQ, etc. O sistema não valida esta informação, apenas exibe para melhor orientação.
        TipoParada  string  sim  E = Documento de entrega | C = Documento de coleta
        Modelo
 string  não  Modelo fiscal do documento (verificar junto a SEFAZ os modelos disponíveis)
        Numero
 string  sim
 Número do documento. somente números sem caracteres especiais ou espaços
        Valor
 decimal  não  Valor total do documento. Números decimais podem ter como separador "." ou ","
        Serie  integer  sim  Série do documento, se não tiver enviar o valor = 0
        Emissao
 string  sim  Data de emissão do documento. Obrigatório o formato YYYYMMDD
        Atualizacao
 string  não  Data de envio do documento à transportadora. Obrigatório o formato YYYYMMDD
        Chave  string  sim  chave do documento. Normalmente é a chave do documento fiscal (barcode)
        cnpj
 string  sim  cnpj (ou cpf) do destinatário do documento. SOMENTE NUMEROS, NÃO COLOCAR ".", "-","/"
        cnpjEmissor
 string  sim  Cnpj do emitente do documento e/ou do embarcador. SOMENTE NUMEROS, NÃO COLOCAR ".", "-","/"
        cnpjTransportador
 string  sim  Cnpj do transportador. SOMENTE NUMEROS, NÃO COLOCAR ".", "-","/"
        Remessa string não Número da remessa do documento. 
        Pedido string não Número do pedido do documento.
        Placa string não Placa do veículo associado ao documento.
        Filial
 string não Filial associada ao documento.
        Peso
 string não Peso total da carga do documento. 
        Cubagem string não Volume total da carga do documento.
        ONU string não Código de periculosidade da carga do documento.
        +Janela   
             DataHoraIni string não Horário de inicio da janela de entrega/coleta. Obrigatório utilizar o formato 
 YYYYMMDD HHMM
             DataHoraFim string não Horário de fim da janela de entrega/coleta. Obrigatório utilizar o formato 
 YYYYMMDD HHMM
    +Cliente
     Indicador do inicio da estrutura do cliente destinatário do documento (cliente final)
        Codigo
 integer  sim  Código do cliente (ou cnpj). Esse código é estritamente numérico
        codigointerno string não Código interno do cliente. Esse código pode ser alfanumérico
        Contato
 string  sim  Nome do contato do cliente destinatário
        Telefone
 string  não  Celular (para envio de sms) do contato do cliente destinatário
        Email
 string  não  Email (para envio de emails) do contato do cliente destinatário
        Razao
 string  sim  Razão social ou nome fantasia do cliente destinatário
        Endereco
 string  sim  Endereço de entrega do cliente destinatário. somente rua e número, sem complementos
        Bairro
 string  não  Bairro
        Cidade
 string  sim  Cidade
        Estado
 string  sim  Estado
        Pais
 string  sim  Pais
        CEP
 string  sim  Zipcode do endereço de entrega
        Regiao
 string  não  Região ou filial ou rota do endereço de entrega
        TipoCliente
 string  não  Tipo do cliente
        Mensagem
 string  não  Mensagem a ser exibida no dispositivo do motorista durante a entrega/coleta
    +SKUs
 
 Indicador do inicio da estrutura dos itens. Um documento pode ter vários itens
        +SKU
 
 Indicador do inicio da estrutura do primeiro item
            *codigo 
 string  sim  Código do item
            PesoBruto
 string  não  Peso bruto total deste item. Números decimais podem ter como separador "." ou ","
            PesoLiquido
 string  não  Peso líquido total deste item. Números decimais podem ter como separador "." ou ","
            Volumes
 string  sim  Quantidade total de volumes deste item
            Descricao
 string  sim  Descrição deste item
            Qde
 string  sim  Qde total deste item
            Uom
 string  sim  Unidade de medida deste item
            Barcode
     Código de barras deste item para conferência
* Campos marcados com asterisco são atributos da TAG.

Exemplo de arquivo xml
<?xml version="1.0" encoding="UTF-8"?>
<Documentos>
<Documento>
<Tipo>NFS</Tipo>
<TipoParada>E</TipoParada>
<Modelo>EFS</Modelo>
<Numero>244552</Numero>
<Valor>1101.53</Valor>
<Serie>0</Serie>
<Emissao>20150727</Emissao>
<Atualizacao>20150727</Atualizacao>
<Chave>3514001615500700028557518898261</Chave>
<cnpj>59221328000132</cnpj>
<cnpjEmissor>60331056000122</cnpjEmissor>
<cnpjTransportador>90667239000112</cnpjTransportador>
</Documento>
<Cliente>
<Codigo>35231360002</Codigo>
<Contato>RICARDO MIURA</Contato>
<Telefone>11967922044</Telefone>
<Email>rmiura@comprovei.com.br</Email>
<Razao>COMPROVEI</Razao>
<Endereco>RUA COSTA BARROS, 2050</Endereco>
<Bairro>SITIO PINHEIRINHO</Bairro>
<Cidade>SAO PAULO</Cidade>
<Estado>SP</Estado>
<Pais>BRASIL</Pais>
<CEP>03210001</CEP>
<Regiao>0 - S J R PRETO</Regiao> 
<TipoCliente>0 - Normal</TipoCliente> 
<Mensagem>Não recebe aos sábados</Mensagem>
</Cliente>
<SKUs>
<SKU codigo="21000510">
<PesoBruto>40</PesoBruto>
<PesoLiquido>36</PesoLiquido>
<Volumes>4</Volumes>
<Descricao>Produto 1</Descricao>
<Qde>4</Qde>
<Uom>CX</Uom>
<Barcode>1234</Barcode>
</SKU>
<SKU codigo="21000520">
<PesoBruto>40</PesoBruto>
<PesoLiquido>36</PesoLiquido>
<Volumes>2</Volumes>
<Descricao>Produto 2</Descricao>
<Qde>2</Qde>
<Uom>CX</Uom>
<Barcode>4321</Barcode>
</SKU>
</SKUs>
</Documentos>