Documentos Originários
Anterior
Próximo
Imprimir

Documentos Originários

Chamadas de serviço disponíveis para upload, consulta, download e vínculos de Documentos Originários de acordo aos seguintes tipos de arquivos e regras de estruturas/formatação:

 

 

Tipo

Modelo

Manual de Formação

Exemplo

NF-e

Layout NFe Sefaz

Esquema NF-e SEFAZ

Arquivo NFe.xml

 

hmtoggle_arrow1Upload

 

Este processo consiste no envio de Documentos Originários ao nddFrete para vinculo dos mesmos aos Embarques da Gestão Fiscais.

 

Através deste serviço é possível enviar Documentos Originários dos seguintes tipos:

 

 

 

Tipo do Documento

ProcessCode

NF-e (Nota Fiscal Eletrônica)

6001

Proc NF-e (Nota Fiscal Eletrônica)

6002

NF-e Evt (Cancelamento)

6003

 

 

 

Crosstalk de Envio (parâmetro header)

 

Para enviar um documento, além dos dados do mesmo é necessário informar o código da mensagem, bem como, os dados de identificação do cliente conforme layout detalhado abaixo.

 

 

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

 

 

Detalhamento do Crosstalk

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos:

o6001 Envio de XML de NFe

o6002 Envio de XML de procNFe

o6003 Envio de XML procEventoCancNFe

A01

N

S

-

4

B02

MessageType

Tipo da operação: 100

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem: 7 Envio

A01

N

S

FIXO

6

B04

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

7

B05

Token

Token para autenticação

A01

GUID

S

FIXO

8

B06

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

 

 

Documento de envio (Parametro rawdata - exemplo XML de NFe)

 

 

<nfeProc versao="3.10" xmlns="" xmlns:ds="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="">

 <NFe xmlns="http://www.portalfiscal.inf.br/nfe">

         <infNFe versao="3.10" Id="NFe42150206255692000103550020000522421840554936">

                 <ide>

                         <cUF>42</cUF>

                         <cNF>84055493</cNF>

                         <natOp>VENDASDE MERC.SUBS.TRIBUTA</natOp>

                         <indPag>1</indPag>

                         <mod>55</mod>

                         <serie>2</serie>

                         <nNF>52242</nNF>

                         <dhEmi>2015-02-11T16:36:10-02:00</dhEmi>

                         <dhSaiEnt>2015-02-11T16:36:10-02:00</dhSaiEnt>

                         <tpNF>1</tpNF>

                         <idDest>1</idDest>

                         <cMunFG>4208906</cMunFG>

                         <tpImp>2</tpImp>

                         <tpEmis>1</tpEmis>

                         <cDV>6</cDV>

                         <tpAmb>1</tpAmb>

                         <finNFe>1</finNFe>

                         <indFinal>0</indFinal>

                         <indPres>1</indPres>

                         <procEmi>0</procEmi>

                         <verProc>4.5.0</verProc>

                 </ide>

                 <emit>

                         <CNPJ>06255692000103</CNPJ>

                         <xNome>NDDigital S/A Software</xNome>

                         <xFant>NDDigital</xFant>

                         <enderEmit>

                                 <xLgr>Rua Dr. Walmor Ribeiro</xLgr>

                                 <nro>431</nro>

                                 <xCpl>NDDigital</xCpl>

                                 <xBairro>Coral</xBairro>

                                 <cMun>4209300</cMun>

                                 <xMun>Lages</xMun>

                                 <UF>SC</UF>

                                 <CEP>88523060</CEP>

                                 <cPais>1058</cPais>

                                 <xPais>BRASIL</xPais>

                                 <fone>21075500</fone>

                         </enderEmit>

                         <IE>192837645</IE>

                         <CRT>3</CRT>

                 </emit>

                 <dest>

                         <CNPJ>11581859000158</CNPJ>

                         <xNome>N5 Software LTDA</xNome>

                         <enderDest>

                                 <xLgr>Rua Dr. Walmor Ribeiro</xLgr>

                                 <nro>341</nro>

                                 <xBairro>Coral</xBairro>

                                 <cMun>4209300</cMun>

                                 <xMun>Lages</xMun>

                                 <UF>SC</UF>

                                 <CEP>88523060</CEP>

                                 <cPais>1058</cPais>

                                 <xPais>BRASIL</xPais>

                         </enderDest>

                         <indIEDest>1</indIEDest>

                         <IE>192837645</IE>

                         <email>nddigital@nddigital.com.br</email>

                 </dest>

                 <det nItem="1">

                         <prod>

                                 <cProd>11043</cProd>

                                 <cEAN/>

                                 <xProd>Item 01</xProd>

                                 <NCM>83021022</NCM>

                                 <CFOP>5405</CFOP>

                                 <uCom>PC</uCom>

                                 <qCom>1.0000</qCom>

                                 <vUnCom>37.3838</vUnCom>

                                 <vProd>37.38</vProd>

                                 <cEANTrib/>

                                 <uTrib>PC</uTrib>

                                 <qTrib>1.0000</qTrib>

                                 <vUnTrib>37.3838</vUnTrib>

                                 <indTot>1</indTot>

                                 <xPed>4500155373</xPed>

                                 <nItemPed>10</nItemPed>

                         </prod>

                         <imposto>

                                 <vTotTrib>6.45</vTotTrib>

                                 <ICMS>

                                         <ICMS60>

                                                 <orig>0</orig>

                                                 <CST>60</CST>

                                                 <vBCSTRet>29.52</vBCSTRet>

                                                 <vICMSSTRet>5.02</vICMSSTRet>

                                         </ICMS60>

                                 </ICMS>

                                 <IPI>

                                         <cEnq>999</cEnq>

                                         <IPITrib>

                                                 <CST>50</CST>

                                                 <vBC>37.38</vBC>

                                                 <pIPI>8.00</pIPI>

                                                 <vIPI>2.99</vIPI>

                                         </IPITrib>

                                 </IPI>

                                 <PIS>

                                         <PISAliq>

                                                 <CST>01</CST>

                                                 <vBC>37.38</vBC>

                                                 <pPIS>1.65</pPIS>

                                                 <vPIS>0.62</vPIS>

                                         </PISAliq>

                                 </PIS>

                                 <COFINS>

                                         <COFINSAliq>

                                                 <CST>01</CST>

                                                 <vBC>37.38</vBC>

                                                 <pCOFINS>7.60</pCOFINS>

                                                 <vCOFINS>2.84</vCOFINS>

                                         </COFINSAliq>

                                 </COFINS>

                         </imposto>

                 </det>

                 <total>

                         <ICMSTot>

                                 <vBC>0.00</vBC>

                                 <vICMS>0.00</vICMS>

                                 <vICMSDeson>0.00</vICMSDeson>

                                 <vBCST>0.00</vBCST>

                                 <vST>0.00</vST>

                                 <vProd>37.38</vProd>

                                 <vFrete>0.00</vFrete>

                                 <vSeg>0.00</vSeg>

                                 <vDesc>0.00</vDesc>

                                 <vII>0.00</vII>

                                 <vIPI>2.99</vIPI>

                                 <vPIS>0.62</vPIS>

                                 <vCOFINS>2.84</vCOFINS>

                                 <vOutro>0.00</vOutro>

                                 <vNF>40.37</vNF>

                                 <vTotTrib>6.45</vTotTrib>

                         </ICMSTot>

                 </total>

                 <transp>

                         <modFrete>0</modFrete>

                         <transporta>

                                 <CNPJ>42158571000107</CNPJ>

                                 <xNome>Transportes ABC</xNome>

                                 <IE>983214756</IE>

                                 <xEnder>Rua Dr. Walmor Ribeiro, 450</xEnder>

                                 <xMun>Lages</xMun>

                                 <UF>SC</UF>

                         </transporta>

                 </transp>

                 <cobr>

                         <fat>

                                 <nFat>252242</nFat>

                                 <vOrig>40.37</vOrig>

                                 <vLiq>40.37</vLiq>

                         </fat>

                         <dup>

                                 <nDup>2522421</nDup>

                                 <dVenc>2015-03-18</dVenc>

                                 <vDup>40.37</vDup>

                         </dup>

                 </cobr>

         </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="#NFe42150206255692000103550020000522421840554936">

                                 <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>H3pJ8tl7EFIz2np8cRMccv11lV4=</DigestValue>

                         </Reference>

                 </SignedInfo>

                 <SignatureValue/>

                 <KeyInfo>

                         <X509Data>

                                 <X509Certificate/>

                         </X509Data>

                 </KeyInfo>

         </Signature>

 </NFe>

 <protNFe versao="3.10">

         <infProt>

                 <tpAmb>1</tpAmb>

                 <verAplic>SVRS201501210950</verAplic>

                 <chNFe>42150206255692000103550020000522421840554936</chNFe>

                 <dhRecbto>2015-02-11T16:34:49-02:00</dhRecbto>

                 <nProt>342150016393567</nProt>

                 <digVal>H3pJ8tl7EFIz2np8cRMccv11lV4=</digVal>

                 <cStat>100</cStat>

                 <xMotivo>Autorizado o uso da NF-e</xMotivo>

         </infProt>

 </protNFe>

</nfeProc>

 

 

 

 

 

 

 

Realize a vinculo/validação automática dos Documentos Originários do tipo NF-e aos Embarques através de informações preenchidas no arquivo do documento.

 

*Solicite ao emitente o devido preenchimento das mesmas.

 

1 - Informações da NF-e: Informações de relação que poderão serem preenchidas no arquivo XML da NF-e para uso de vinculo de Embarque, com as seguintes possibilidades:

 

 

•Numero da Ordem: Efetuará a validação/vinculo da NF-e junto a Ordem através do Número da Ordem. Na NF-e deverá ser informada a seguinte expressão para utilização deste recurso:

 

 

<infAdic>

 <infCpl>IDOR|DOMINIO.ORDEM|IDOR</infCpl>

</infAdic>

 

 

*Caso a Ordem informada exista em mais que um embarque, será vinculada com todos estes Embarques.

*Caso seja necessário informar mais Ordens no documento, separe-as usando pipe "|". Exemplo:

 

 

<infAdic>

 <infCpl>IDOR|DOMINIO.ORDEM01|DOMINIO.ORDEM02IDOR</infCpl>

</infAdic>

 

 

•Número da Ordem do Embarque: Efetuará a validação/vinculo da NF-e junto a Ordem através do Número da Ordem e do Embarque específico onde a mesma se encontra, pois a Ordem pode estar em mais de um embarque e, se o embarque não for informado, a nota será vinculada com todos os embarques relacionados.  Na NF-e deverá ser informada a seguinte expressão para utilização deste recurso:

 

 

 

<infAdic>

 <infCpl>IDOR|DOMINIO.ORDEM01.DOMINIO.EMBARQUE01IDOR</infCpl>

</infAdic>

 

 

 

<infAdic>

 <infCpl>IDOR|DOMINIO.ORDEM01.DOMINIO.EMBARQUE1|DOMINIO.ORDEM02.DOMINIO.EMBARQUE02IDOR</infCpl>

</infAdic>

 

 

 

 

<infAdic>

 <infCpl>IDOR|DOMINIO.ORDEM01|DOMINIO.ORDEM02.DOMINIO.EMBARQUE02IDOR</infCpl>

</infAdic>

 

 

 

 

#

CAMPO

DESCRIÇÃO

TIPO

OCORRÊNCIA

OBS.

1

IDOR

Campo identificador da Order Release

C

1-1

FIXO

2

|

Pipeline separador

-

1-N

FIXO

3

Domínio

Domínio do OTM Release

C

1-N

-

4

Ordem

XID da Ordem

C

1-N

-

5

Domínio

Domínio do OTM Shipment

C

1-N

-

6

Embarque

XID do Embarque

C

1-N

-

 

 

•Número do pedido: Efetuará a validação/vinculo da NF-e junto a Ordem utilizando a informações do Número do Pedido informados no mesmo.

 

 

<infNFe>

 <compra>

         <xPed>NUMERODAPO</xPed>

 </compra>

</infNFe>

 

 

 

 

 

 

 

Retorno da solicitação

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>6002</ProcessCode>

         <MessageType>100</MessageType>

         <ExchangePattern>7</ExchangePattern>

         <Guid>97abcd76-f358-4e76-bc0d-8bbb92aef272</Guid>

         <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId>

         <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

         <ResponseCode>200</ResponseCode>

         <ResponseMessage>A mensagem foi recebida e está sendo processada.</ResponseMessage>

         <CustomId>01234567890</CustomId>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos informada no envio

A01

N

S

-

4

B02

MessageType

Tipo da operação informada no envio

A01

N

S

-

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

-

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação

A01

GUID

S

FIXO

9

B07

ContentEnconding

Codificação da mensagem enviada: UTF-8

A01

C

S

FIXO

10

B08

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

11

B09

ResponseCode

Código de resposta do processamento

A01

N

S

-

12

B10

ResponseMessage

Mensagem referente ao ResponseCode

A01

C

S

-

13

B11

CustomId

Identificador da Mensagem

A01

C

S

-

 

O retorno obtido através do Web Service informa se o envio da requisição foi processado com sucesso. Caso a mensagem enviada não possua as tags obrigatórias será retornado falha de schema. Se algum dos campos obrigatórios não estiver no formato correto, a mensagem de retorno criticará o mesmo.

 

 

Códigos de Retorno da Solicitação de Processamento

 

Código

Mensagem

Situação

203

A mensagem foi rejeitada por causa de falha na validação do esquema do documento. Faça as correções necessárias como erros de esquema e envie a mensagem para processamento

Estrutura do xml de envio incorreta.

200

A mensagem foi recebida e está sendo processada.

Solicitação de envio do documento processada com sucesso.

206

A mensagem foi rejeitada porque o cliente não está cadastrado. O cliente não foi encontrado através do EnterpriseId e Token.

O EnterpriseId e o Token informado não existem na aplicação nddFrete.

207

A mensagem foi rejeitada porque a mensagem já existe na base de dados.

O GUID da mensagem já existir na aplicação nddFrete.

210

ProcessCode e MessageType inválido

O ProcessCode ou o MessageType informados não existem na aplicação nddFrete.

218

A filial não foi encontrada através do EnterpriseId e Token.

Filial não foi encontrada com os dados informados na chamada.

999

Ocorreu um erro inesperado.

Erro não catalogado.

 

Consulta do Processamento

 

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>6002</ProcessCode>

         <MessageType>100</MessageType>

         <ExchangePattern>8</ExchangePattern>

         <Guid>97abcd76-f358-4e76-bc0d-8bbb92aef272</Guid>

         <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId>

         <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

 

A consulta com o ExchangePattern 8 retorna se a solicitação foi processada ou ainda está em processamento.

 

Detalhamento do Crosstalk

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos:

o6001 Envio de NFe

o6002 Envio de procNFe

o6003 Envio de procEventoCancNFe

A01

N

S

-

4

B02

MessageType

Tipo da operação: 100

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem: 8

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

Informar Guid  do Retorno do processamento

7

B05

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação

A01

GUID

S

FIXO

9

B07

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

 

Retorno do Processamento

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>6002</ProcessCode>

         <MessageType>100</MessageType>

         <ExchangePattern>8</ExchangePattern>

         <Guid>97abcd76-f358-4e76-bc0d-8bbb92aef272</Guid>

         <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId>

         <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

         <ResponseCode>205</ResponseCode>

         <ResponseMessage>A mensagem foi processada com sucesso.</ResponseMessage>

         <CustomId>01234567890</CustomId>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

Detalhamento do Header:

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos informada no envio

A01

N

S

-

4

B02

MessageType

Tipo da operação informada no envio

A01

N

S

-

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

-

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador do transportador ou operador logístico informado no envio

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação do cliente ou operador logístico informado no envio

A01

GUID

S

FIXO

9

B07

ContentEnconding

Codificação da mensagem enviada: UTF-8

A01

C

S

FIXO

10

B08

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

11

B09

ResponseCode

Código de resposta do processamento

A01

N

S

-

12

B10

ResponseMessage

Mensagem referente ao ResponseCode

A01

C

S

-

13

B11

CustomId

Identificador da Mensagem

A01

C

S

-

 

Detalhamento do Rawdata:

 

 

<DataInputResponse Version="1.0">

 <InputBlock>

         <ResponseCode>410</ResponseCode>

         <ResponseMessage>Processamento realizado com sucesso.</ResponseMessage>

 </InputBlock>

 <Document>

         <Id>42170506255692000103552220000000501000000001</Id>

         <ResponseCode>410</ResponseCode>

         <ResponseMessage>Processamento realizado com sucesso.</ResponseMessage>

 </Document>

</DataInputResponse>

 

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

DataInputResponse

Cabeçalho

-

-

S

FIXO

2

A01

InputBlock

Grupo do Bloco de Retorno

RAIZ

-

S

FIXO

3

B01

ResponseCode

Código de resposta do processamento

A01

N

S

-

4

B02

ResponseMessage

Mensagem referente ao ResponseCode

A01

C

S

-

5

A02

Document

Grupo com informações do documento processado

RAIZ

C

S

-

6

B03

Id

Chave do Documento

A02

N

S

-

7

B04

ResponseCode

Código de resposta do processamento

A02

N

S

FIXO

8

B05

ResponseMessage

Mensagem referente ao ResponseCode

A02

GUID

S

FIXO

 

Códigos Retorno do Cabeçalho da Mensagem

 

Código

Mensagem

Situação

203

A mensagem foi rejeitada por causa de falha na validação do esquema do documento.

A estrutura do xml de envio estiver incorreta.

205

A mensagem foi processada com sucesso.

O processo de retorno do status do documento foi executado com sucesso.

206

A mensagem foi rejeitada porque o cliente não está cadastrado. O cliente não foi encontrado através do EnterpriseId e Token.

O enterpriseId informado não está cadastrado no sistema nddFrete.

210

ProcessCode e MessageType inválido.

O ProcessCode ou o MessageType informados não existem na aplicação nddFrete.

999

Ocorreu um erro inesperado no processamento da mensagem.

Um erro inesperado, que não foi tratado pelo sistema.

 

Códigos Retorno do Corpo da Mensagem

 

Código

Mensagem

Situação

410

Processamento realizado com sucesso.

Cliente e ponto de operação encontrados, documento está bem formado e executou as regras de mapeamento com sucesso.

- Documento Disponível

411

Erro ao realizar o processamento. Ocorreu um erro inesperado no processamento do conteúdo.

Valor de entrada não condiz com o esperado.

Documento mal formado ou mapeamento não encontrado.

- Documento Não Conforme

412

Processamento realizado com inconsistência. Cliente não informado. Ponto de Operação não está vinculado ao Cliente informado! ou Ponto de Operação não encontrado

Cliente não encontrado através do CNPJ do emitente.

Ou Ponto de operação não encontrado através do DestinationId.

- Documento Inconsistente



 

 

hmtoggle_arrow1Consulta

 

A consulta da lista do XML dos documentos vinculados aos embarques disponibilizados ao transportador passa a ser um facilitador/orientador para a emissão dos documentos fiscais do transporte.

 

Os documentos disponíveis para consulta são:

 

 

Tipo do Documento

ProcessCode

NF-e: Nota Fiscal Eletrônica

4105

 

 

 

Crosstalk de Envio (parâmetro header)

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>4105</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>1</ExchangePattern>

         <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId>

         <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

Detalhamento do Crosstalk

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos:

o4105 Consulta Lista NF-e

A01

N

S

-

4

B02

MessageType

Tipo da operação: 103

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem: 1 Envio

A01

N

S

FIXO

6

B04

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

7

B05

Token

Token para autenticação

A01

GUID

S

FIXO

8

B06

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

 

O retorno obtido através do Web Service informa se o envio da requisição foi processado com sucesso. Caso a mensagem enviada não possua as tags obrigatórias é retornado falha de schema. Se algum dos campos obrigatórios não estiver no formato correto, a mensagem de retorno critica o mesmo. Sendo processada com sucesso, no corpo da mensagem apresenta a lista de identificadores para o participante que fez a solicitação.

 

 

Retorno da solicitação

 

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>4105</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>1</ExchangePattern>

         <Guid>5c67e24c-0a8b-444d-9fed-267ccaf49b9c</Guid>

         <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId>

         <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

         <ResponseCode>205</ResponseCode>

         <ResponseMessage>A mensagem foi processada com sucesso.</ResponseMessage>

 </CrosstalkHeader>

 <CrosstalkBody>

         <RawData><![CDATA[<ListResponse Version="1.0">

<Id>NFE_42150206255692000103550020000522421840554936</Id>>

</ListResponse>]]></RawData>

 </CrosstalkBody>

</CrosstalkMessage>

 

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos informada no envio

A01

N

S

-

4

B02

MessageType

Tipo da operação informada no envio

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador do transportador ou operador logístico informado no envio

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação do cliente ou operador logístico informado no envio

A01

GUID

S

FIXO

9

B07

ContentEnconding

Codificação da mensagem enviada: UTF-8

A01

C

S

FIXO

10

B08

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

11

B09

ResponseCode

Código de resposta do processamento

A01

N

S

-

12

B10

ResponseMessage

Mensagem referente ao ResponseCode

A01

C

S

-

13

B11

CustomId

Identificador da Mensagem

A01

C

S

-

14

C01

RawData

Código dos documentos disponíveis

-

C

N

-

 

 

Códigos de Retorno da Solicitação de Processamento

 

Código

Mensagem

Situação

203

A mensagem foi rejeitada por causa de falha na validação do esquema do documento. Faça as correções necessárias como erros de esquema e envie a mensagem para processamento

Estrutura do xml de envio incorreta.

205

A mensagem foi processada com sucesso.

Solicitação de envio do documento processada com sucesso.

206

A mensagem foi rejeitada porque o cliente não está cadastrado. O cliente não foi encontrado através do EnterpriseId e Token.

O EnterpriseId e o Token informado não existem na aplicação nddFrete.

207

A mensagem foi rejeitada porque a mensagem já existe na base de dados.

O GUID da mensagem já existir na aplicação nddFrete.

210

ProcessCode e MessageType inválido

O ProcessCode ou o MessageType informados não existem na aplicação nddFrete.

999

Ocorreu um erro inesperado.

Erro não catalogado.

 

 

 

 

hmtoggle_arrow1Download

 

A integração disponibilizada para busca de documentos é um processo assíncrono, a captura de um documento específico solicitado no momento da requisição ao serviço de integração do nddFrete. Para isso, é necessário informar na chamada de solicitação do documento o identificador do documento que se deseja obter. Este identificador deve ter sido retornado previamente através da consulta da lista de documentos.

 

Ao receber a lista de identificadores, a aplicação nddFrete localiza em sua base de dados os documentos relacionados à cada pacote, processa-os, monta a mensagem de reposta e marca os documentos como consumidos. Os documentos processados são retornados na busca da resposta da primeira requisição.

 

A primeira chamada é o Pedido de Download, que deve receber dois parametros: O Crosstalk de Envio e a Lista de identificadores)

 

Tipo do Documento

ProcessCode

NF-e: Nota Fiscal Eletrônica

4106

 

 

 

Crosstalk de Envio (parâmetro header)

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>4106</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>7</ExchangePattern>

         <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId>

         <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

Detalhamento do Crosstalk

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos:

o4106 Pedido de Download NF-e

A01

N

S

-

4

B02

MessageType

Tipo da operação: 103

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem: 1 Envio

A01

N

S

FIXO

6

B04

EnterpriseId

Identificador do transportador ou operador logístico

A01

GUID

S

FIXO

7

B05

Token

Token para autenticação do cliente ou operador logístico

A01

GUID

S

FIXO

8

B06

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

 

Solicitação de Pacote - Lista de identificadores (parâmetro rawdata)

 

 

<DataRequest Version="1.0">

 <Id>Embarque_NFE_42150206255692000103550020000522421840554936</Id>

</DataRequest>

 

 

Detalhamento da Consulta

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

DataRequest

Tag raiz da mensagem

-

-

S

FIXO

2

A01

Id

Identificador do Pacote

RAIZ

-

S

FIXO

 

 

Retorno da solicitação

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>4106</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>7</ExchangePattern>

         <Guid>f4ae253f-7ff8-411a-adb4-3a2d5ec09545</Guid>

         <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId>

         <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

         <ResponseCode>200</ResponseCode>

         <ResponseMessage>A mensagem foi recebida e está sendo processada.</ResponseMessage>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos informada no envio

A01

N

S

-

4

B02

MessageType

Tipo da operação informada no envio

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação

A01

GUID

S

FIXO

9

B07

ContentEnconding

Codificação da mensagem enviada: UTF-8

A01

C

S

FIXO

10

B08

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

11

B09

ResponseCode

Código de resposta do processamento

A01

N

S

-

12

B10

ResponseMessage

Mensagem referente ao ResponseCode

A01

C

S

-

 

O retorno obtido na primeira requisição do processo assíncrono, informa se a mensagem foi processada com sucesso. Caso a mensagem enviada não possua as tags obrigatórias será retornado falha de schema. Se algum dos campos obrigatórios não estiver no formato correto, a mensagem de retorno criticará o mesmo.

 

 

Consulta do Processamento (parâmetro header)

 

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>4106</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>8</ExchangePattern>

         <Guid>f4ae253f-7ff8-411a-adb4-3a2d5ec09545</Guid>

         <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId>

         <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

 </CrosstalkHeader>

</CrosstalkMessage>

 

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos informada no envio

A01

N

S

-

4

B02

MessageType

Tipo da operação informada no envio

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação

A01

GUID

S

FIXO

9

B07

ContentEnconding

Codificação da mensagem enviada: UTF-8

A01

C

S

FIXO

10

B08

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

 

A consulta com o ExchangePattern 8 retorna se a solicitação foi processada ou ainda está em processamento.

 

Retorno do Processamento - conteúdo do download

 

Exemplo de retorno com NF-e:

 

 

<CrosstalkMessage>

 <CrosstalkHeader>

         <ProcessCode>4106</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>8</ExchangePattern>

         <Guid>f4ae253f-7ff8-411a-adb4-3a2d5ec09545</Guid>

         <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId>

         <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token>

         <ContentEncoding>UTF-8</ContentEncoding>

         <ContentType>txt/xml</ContentType>

         <ResponseCode>205</ResponseCode>

         <ResponseMessage>A mensagem foi processada com sucesso.</ResponseMessage>

 </CrosstalkHeader>

 <CrosstalkBody>

         <RawData><![CDATA[<DataResponse Version="1.0">

<Element>

<Id>NFE_42150206255692000103550020000522421840554936</Id>

<Data><nfeProc versao="3.10" xmlns="" xmlns:ds="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="">

 <NFe xmlns="http://www.portalfiscal.inf.br/nfe">

         <infNFe versao="3.10" Id="NFe42150206255692000103550020000522421840554936">

                 <ide>

                         <cUF>42</cUF>

                         <cNF>84055493</cNF>

                         <natOp>VENDASDE MERC.SUBS.TRIBUTA</natOp>

                         <indPag>1</indPag>

                         <mod>55</mod>

                         <serie>2</serie>

                         <nNF>52242</nNF>

                         <dhEmi>2015-02-11T16:36:10-02:00</dhEmi>

                         <dhSaiEnt>2015-02-11T16:36:10-02:00</dhSaiEnt>

                         <tpNF>1</tpNF>

                         <idDest>1</idDest>

                         <cMunFG>4208906</cMunFG>

                         <tpImp>2</tpImp>

                         <tpEmis>1</tpEmis>

                         <cDV>6</cDV>

                         <tpAmb>1</tpAmb>

                         <finNFe>1</finNFe>

                         <indFinal>0</indFinal>

                         <indPres>1</indPres>

                         <procEmi>0</procEmi>

                         <verProc>4.5.0</verProc>

                 </ide>

                 <emit>

                         <CNPJ>06255692000103</CNPJ>

                         <xNome>NDDigital S/A Software</xNome>

                         <xFant>NDDigital</xFant>

                         <enderEmit>

                                 <xLgr>Rua Dr. Walmor Ribeiro</xLgr>

                                 <nro>431</nro>

                                 <xCpl>NDDigital</xCpl>

                                 <xBairro>Coral</xBairro>

                                 <cMun>4209300</cMun>

                                 <xMun>Lages</xMun>

                                 <UF>SC</UF>

                                 <CEP>88523060</CEP>

                                 <cPais>1058</cPais>

                                 <xPais>BRASIL</xPais>

                                 <fone>21075500</fone>

                         </enderEmit>

                         <IE>192837645</IE>

                         <CRT>3</CRT>

                 </emit>

                 <dest>

                         <CNPJ>11581859000158</CNPJ>

                         <xNome>N5 Software LTDA</xNome>

                         <enderDest>

                                 <xLgr>Rua Dr. Walmor Ribeiro</xLgr>

                                 <nro>341</nro>

                                 <xBairro>Coral</xBairro>

                                 <cMun>4209300</cMun>

                                 <xMun>Lages</xMun>

                                 <UF>SC</UF>

                                 <CEP>88523060</CEP>

                                 <cPais>1058</cPais>

                                 <xPais>BRASIL</xPais>

                         </enderDest>

                         <indIEDest>1</indIEDest>

                         <IE>192837645</IE>

                         <email>nddigital@nddigital.com.br</email>

                 </dest>

                 <det nItem="1">

                         <prod>

                                 <cProd>11043</cProd>

                                 <cEAN/>

                                 <xProd>Item 01</xProd>

                                 <NCM>83021022</NCM>

                                 <CFOP>5405</CFOP>

                                 <uCom>PC</uCom>

                                 <qCom>1.0000</qCom>

                                 <vUnCom>37.3838</vUnCom>

                                 <vProd>37.38</vProd>

                                 <cEANTrib/>

                                 <uTrib>PC</uTrib>

                                 <qTrib>1.0000</qTrib>

                                 <vUnTrib>37.3838</vUnTrib>

                                 <indTot>1</indTot>

                                 <xPed>4500155373</xPed>

                                 <nItemPed>10</nItemPed>

                         </prod>

                         <imposto>

                                 <vTotTrib>6.45</vTotTrib>

                                 <ICMS>

                                         <ICMS60>

                                                 <orig>0</orig>

                                                 <CST>60</CST>

                                                 <vBCSTRet>29.52</vBCSTRet>

                                                 <vICMSSTRet>5.02</vICMSSTRet>

                                         </ICMS60>

                                 </ICMS>

                                 <IPI>

                                         <cEnq>999</cEnq>

                                         <IPITrib>

                                                 <CST>50</CST>

                                                 <vBC>37.38</vBC>

                                                 <pIPI>8.00</pIPI>

                                                 <vIPI>2.99</vIPI>

                                         </IPITrib>

                                 </IPI>

                                 <PIS>

                                         <PISAliq>

                                                 <CST>01</CST>

                                                 <vBC>37.38</vBC>

                                                 <pPIS>1.65</pPIS>

                                                 <vPIS>0.62</vPIS>

                                         </PISAliq>

                                 </PIS>

                                 <COFINS>

                                         <COFINSAliq>

                                                 <CST>01</CST>

                                                 <vBC>37.38</vBC>

                                                 <pCOFINS>7.60</pCOFINS>

                                                 <vCOFINS>2.84</vCOFINS>

                                         </COFINSAliq>

                                 </COFINS>

                         </imposto>

                 </det>

                 <total>

                         <ICMSTot>

                                 <vBC>0.00</vBC>

                                 <vICMS>0.00</vICMS>

                                 <vICMSDeson>0.00</vICMSDeson>

                                 <vBCST>0.00</vBCST>

                                 <vST>0.00</vST>

                                 <vProd>37.38</vProd>

                                 <vFrete>0.00</vFrete>

                                 <vSeg>0.00</vSeg>

                                 <vDesc>0.00</vDesc>

                                 <vII>0.00</vII>

                                 <vIPI>2.99</vIPI>

                                 <vPIS>0.62</vPIS>

                                 <vCOFINS>2.84</vCOFINS>

                                 <vOutro>0.00</vOutro>

                                 <vNF>40.37</vNF>

                                 <vTotTrib>6.45</vTotTrib>

                         </ICMSTot>

                 </total>

                 <transp>

                         <modFrete>0</modFrete>

                         <transporta>

                                 <CNPJ>42158571000107</CNPJ>

                                 <xNome>Transportes ABC</xNome>

                                 <IE>983214756</IE>

                                 <xEnder>Rua Dr. Walmor Ribeiro, 450</xEnder>

                                 <xMun>Lages</xMun>

                                 <UF>SC</UF>

                         </transporta>

                 </transp>

                 <cobr>

                         <fat>

                                 <nFat>252242</nFat>

                                 <vOrig>40.37</vOrig>

                                 <vLiq>40.37</vLiq>

                         </fat>

                         <dup>

                                 <nDup>2522421</nDup>

                                 <dVenc>2015-03-18</dVenc>

                                 <vDup>40.37</vDup>

                         </dup>

                 </cobr>

         </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="#NFe42150206255692000103550020000522421840554936">

                                 <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>H3pJ8tl7EFIz2np8cRMccv11lV4=</DigestValue>

                         </Reference>

                 </SignedInfo>

                 <SignatureValue/>

                 <KeyInfo>

                         <X509Data>

                                 <X509Certificate/>

                         </X509Data>

                 </KeyInfo>

         </Signature>

 </NFe>

 <protNFe versao="3.10">

         <infProt>

                 <tpAmb>1</tpAmb>

                 <verAplic>SVRS201501210950</verAplic>

                 <chNFe>42150206255692000103550020000522421840554936</chNFe>

                 <dhRecbto>2015-02-11T16:34:49-02:00</dhRecbto>

                 <nProt>342150016393567</nProt>

                 <digVal>H3pJ8tl7EFIz2np8cRMccv11lV4=</digVal>

                 <cStat>100</cStat>

                 <xMotivo>Autorizado o uso da NF-e</xMotivo>

         </infProt>

 </protNFe>

</nfeProc></Data></Element></DataResponse>]]></RawData>

 </CrosstalkBody>

</CrosstalkMessage>

 

 

 

 

 

#

ID

CAMPO

DESCRIÇÃO

PAI

TIPO

OBR.

OBS.

1

RAIZ

CrossTalk_Message

Tag raiz da mensagem

-

-

S

FIXO

2

A01

CrossTalk_Header

Cabeçalho

RAIZ

-

S

FIXO

3

B01

ProcessCode

Código da mensagem da recepção de documentos informada no envio

A01

N

S

-

4

B02

MessageType

Tipo da operação informada no envio

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador para autenticação

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação

A01

GUID

S

FIXO

9

B07

ContentEnconding

Codificação da mensagem enviada: UTF-8

A01

C

S

FIXO

10

B08

ContentType

Formato da mensagem enviada: text/xml

A01

C

S

FIXO

11

B09

ResponseCode

Código de resposta do processamento

A01

N

S

-

12

B10

ResponseMessage

Mensagem referente ao ResponseCode

A01

C

S

-

13

C01

RawData

Documento Solicitado

-

C

N

-

 

Quando processada, vai retornar o conteúdo do documento dentro da tag Element. O exemplo apresentado é de um ProcNFe apresentado no ínicio deste tópico.

 

 

 

Códigos de Retorno da Solicitação de Processamento

 

Código

Mensagem

Situação

203

A mensagem foi rejeitada por causa de falha na validação do esquema do documento. Faça as correções necessárias como erros de esquema e envie a mensagem para processamento

Estrutura do xml de envio incorreta.

205

A mensagem foi processada com sucesso.

Solicitação de envio do documento processada com sucesso.

206

A mensagem foi rejeitada porque o cliente não está cadastrado. O cliente não foi encontrado através do EnterpriseId e Token.

O EnterpriseId e o Token informado não existem na aplicação nddFrete.

207

A mensagem foi rejeitada porque a mensagem já existe na base de dados.

O GUID da mensagem já existir na aplicação nddFrete.

210

ProcessCode e MessageType inválido

O ProcessCode ou o MessageType informados não existem na aplicação nddFrete.

999

Ocorreu um erro inesperado.

Erro não catalogado.

 

Códigos Retorno do Corpo da Mensagem

 

Código

Mensagem

Situação

404

Identificador não encontrado

Identificador informado na mensagem não existe na base de dados ou solicitante não possui permissão para consumir o pacote.

405

Erro na execução do mapeamento: [xxx].

Possíveis erros retornados da transformação do documento.