Aqui estaremos apresentando os meios de integração com o Web Service nddFrete, descrevendo as funcionalidades, os métodos a serem utilizados, listando informações a serem enviadas e recebidas, e provendo exemplos.
Integrações Disponíveis |
|---|
Embarcador |
|||||
Origem |
Tipo |
Integração |
ProcessCode |
MessageType |
ExchangePattern |
Documentos Originários |
Envio |
Envio de NFe |
6001 |
100 |
7 |
Envio de procNFe |
6002 |
100 |
7 |
||
Envio de procEventoCancNFe |
6003 |
100 |
7 |
||
Consulta do Envio |
Consulta de NFe |
6001 |
100 |
8 |
|
Consulta de procNFe |
6002 |
100 |
8 |
||
Consulta de procEventoCancNFe |
6003 |
100 |
8 |
||
|
|
|
|
|
|
Vínculo de NF-e |
Envio |
Envio de Vínculo de NF-e |
6000 |
100 |
7 |
Consulta |
Consulta de Vínculo de NF-e |
6000 |
100 |
8 |
|
|
|
|
|
||
Documentos do transporte (Via conector NDD) |
Envio |
Envio do procCTe |
2202 |
100 |
7 |
Envio do procEvento |
2203 |
100 |
7 |
||
Consulta do Envio |
Consulta do procCTe |
2202 |
100 |
8 |
|
Consulta do procEvento |
2203 |
100 |
8 |
||
|
|
|
|
||
Documento da Prestação de Serviço |
Consulta |
Consulta Lista de Documento Fiscal do Transporte CT-e |
4300 |
103 |
1 |
Pedido de Download |
Pedido de Download da Lista de Documento Fiscal do Transporte CT-e |
4301 |
103 |
7 |
|
Download |
Download da Lista de Documento Fiscal do Transporte CT-e |
4301 |
103 |
8 |
|
Consulta |
Consulta Lista de Documento Fiscal do Transporte por serviço |
4000 |
103 |
1 |
|
Pedido de Download |
Pedido de Download da Lista de Documento Fiscal do Transporte por serviço |
4001 |
103 |
7 |
|
Download |
Download da Lista de Documento Fiscal do Transporte por serviço |
4001 |
103 |
8 |
|
Consulta |
Consulta Lista de Documento Fiscal do Transporte NFS-e |
4302 |
103 |
1 |
|
Pedido de Download |
Pedido de Download da Lista de Documento Fiscal do Transporte NFS-e |
4303 |
103 |
7 |
|
Download |
Download da Lista de Documento Fiscal do Transporte NFS-e |
4303 |
103 |
8 |
|
Consulta |
Consulta Lista de Nota de Débito |
4304 |
103 |
1 |
|
Pedido de Download |
Pedido de Download de Nota de Débito |
4305 |
103 |
7 |
|
Download |
Download de Nota de Débito |
4305 |
103 |
8 |
|
|
|
|
|
|
|
Faturas e Pagamentos |
Consulta |
Consulta lista de Provisão de Pagamento |
4308 |
103 |
1 |
Pedido de Download |
Pedido de Download Provisão de Pagamento |
4309 |
103 |
7 |
|
Download |
Download de Provisão de Pagamento |
4309 |
103 |
8 |
|
Consulta |
Consulta lista de OVP (Op. Vale Pedágio) |
4310 |
103 |
1 |
|
Pedido de Download |
Pedido de Download de OVP (Op. Vale Pedágio) |
4311 |
103 |
7 |
|
Download |
Download de OVP (Op. Vale Pedágio) |
4311 |
103 |
8 |
|
Consulta |
Consulta lista de RPA (Recibo Pagto Autonomo) |
4312 |
103 |
1 |
|
Pedido de Download |
Pedido de Download de DPA (Recibo Pagto Autonomo) |
4313 |
103 |
7 |
|
Download |
Download de RPA (Recibo Pagto Autonomo) |
4313 |
103 |
8 |
|
Consulta |
Consulta lista de documentos faturados disponíveis |
4314 |
103 |
1 |
|
Pedido de Download |
Pedido de download de documentos faturados disponíveis |
4315 |
103 |
7 |
|
Download |
Download de documentos faturados disponíveis |
4315 |
103 |
8 |
|
Consulta |
Consulta lista de PREFAT |
4318 |
103 |
1 |
|
Pedido de Download |
Pedido de download PREFAT |
4319 |
103 |
7 |
|
Download |
Download de PREFAT |
4319 |
103 |
8 |
|
Consulta |
Consulta Lista de Faturas |
4306 |
103 |
1 |
|
Pedido de Download |
Pedido de Download de Faturas |
4307 |
103 |
7 |
|
Download |
Download de Faturas |
4307 |
103 |
8 |
|
Consulta |
Consulta lista de CONEMB |
4320 |
103 |
1 |
|
Pedido de Download |
Pedido de download CONEMB |
4321 |
103 |
7 |
|
Download |
Download de CONEMB |
4321 |
103 |
8 |
|
Consulta |
Consulta Lista de Valores de Cálculo de Crédito de imposto |
4316 |
103 |
1 |
|
Pedido de Download |
Pedido de Download Valores de Cálculo de Crédito de imposto |
4317 |
103 |
7 |
|
Download |
Download Valores de Cálculo de Crédito |
4317 |
103 |
8 |
|
Envio |
Apontamento de Fatura |
3152 |
100 |
7 |
|
Consulta de Envio |
Consulta Status do Apontamento |
3152 |
100 |
8 |
|
|
|
|
|
|
|
|
|
|
|
|
|
Transportador |
|||||
Origem |
Tipo |
Integração |
ProcessCode |
MessageType |
ExchangePattern |
Documentos Originários |
Consulta |
Consulta Lista de Documentos (XML NF-e) |
4105 |
103 |
1 |
Pedido de Download |
Pedido de Download de Documentos (XML NF-e) |
4106 |
103 |
7 |
|
Download |
Download do Documento (XML NF-e) |
4106 |
103 |
8 |
|
Consulta |
Consulta Lista de PREDOC |
4107 |
103 |
1 |
|
Pedido de Download |
Pedido de Download de PREDOC |
4108 |
103 |
7 |
|
Download |
Download de PREDOC |
4108 |
103 |
8 |
|
|
|
|
|
|
|
Documentos do transporte |
Envio |
Envio do procCTe |
2200 |
100 |
7 |
Envio do procEvento |
2201 |
100 |
7 |
||
Consulta do Envio |
Consulta do procCTe |
2200 |
100 |
8 |
|
Consulta do procEvento |
2201 |
100 |
8 |
||
|
|
|
|
|
|
Faturas e Pagamentos |
Consulta |
Consulta lista de PREFAT |
4109 |
103 |
1 |
Pedido de Download |
Pedido de download PREFAT |
4110 |
103 |
7 |
|
Download |
Download de PREFAT |
4110 |
103 |
8 |
|
Envio |
Envio de Fatura (DOCCOB) |
4111 |
100 |
7 |
|
Consulta |
Consulta de Fatura (DOCCOB) |
4111 |
100 |
8 |
|
Requisitos |
|---|
Ao recepcionar uma requisição o mesmo efetua algumas validações iniciais, sendo elas:
•Schema do Crosstalk Header de envio;
•Autenticação do solicitante consumidor da aplicação;
•Identificador da mensagem.
Métodos |
|---|
O Web Service ExchangeMessage possui dois métodos distintos para envio e disponibilização de documentos, Send e CompressedSend, os quais efetuam validações específicas nas informações enviadas, conforme seguem abaixo:
O método Send é utilizado para envio de arquivos não compactados. No cabeçalho da requisição é informado o Crosstalk Header contendo as informações para processamento do documento. Exemplo:
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>6002</ProcessCode> <MessageType>100</MessageType> <ExchangePattern>7</ExchangePattern> <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId> <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> </CrosstalkHeader> </CrosstalkMessage> |
O conteúdo do arquivo é informado em um rawdata dentro de um grupo de dados de caracteres (CDATA). Ao enviar um documento não compactado, as validações iniciais são realizadas no cabeçalho da requisição.
<ndd:rawdata> <![CDATA[Conteúdo do documento originário]]> </ndd:rawdata> |
Método disponibilizado para envio de arquivos compactados no formato "zip". Assim como no método anterior, no cabeçalho da chamada é enviado o CrosstalkHeader com os dados para processamento. O conteúdo binário do arquivo compactado é informado no rawdata. Para que sejam recepcionados corretamente, o lote enviado deve conter no máximo 2000 documentos. Caso ultrapasse a quantidade de arquivos uma exceção é retornada pelo Web Service.
Todos os arquivos enviados no lote devem conter a mesma extensão e possuírem o mesmo schema (NF-e, CT-e, ProcNF-e, procCT-e), de acordo com o processCode informado na requisição enviada. Caso as validações realizadas no envio da requisição estejam corretas, é retornado pelo Web Service a resposta informando que a mensagem foi processada com sucesso, que define que a chamada foi entendida e enviada para processamento, porém, não garante que todo o conteúdo da mensagem tenha sido processado. Caso exista no lote enviado algum arquivo com extensão diferente das aceitas pela aplicação (".xml" e ".txt") será retornado pelo Web Service uma mensagem informando que o lote foi parcialmente processado.