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)
Crosstalk de Envio (parâmetro header) |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4301</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: o4301 Pedido de Download CT-e o4303 Pedido de Download NFS-e o4305 Pedido de Download Nota de Débito |
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>CTE_AUT_35170965849838002577570090005000021005000026</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>4301</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>4301</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 |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4301</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>CTE_AUT_35170965849838002577570090005000021005000026</Id> <Data><cteProc xmlns="http://www.portalfiscal.inf.br/cte" versao="3.00"><CTe xmlns="http://www.portalfiscal.inf.br/cte"><infCte versao="3.00" Id="CTe35170965849838002577570090005000021005000026"><ide><cUF>35</cUF><cCT>00500002</cCT><CFOP>6351</CFOP><natOp>Prestacao de servico de transporte para execucao de servico</natOp><mod>57</mod><serie>9</serie><nCT>500002</nCT><dhEmi>2017-09-05T15:51:12-03:00</dhEmi><tpImp>1</tpImp><tpEmis>1</tpEmis><cDV>6</cDV><tpAmb>2</tpAmb><tpCTe>0</tpCTe><procEmi>0</procEmi><verProc>3.0</verProc><cMunEnv>3509205</cMunEnv><xMunEnv>Cajamar</xMunEnv><UFEnv>SP</UFEnv><modal>01</modal><tpServ>0</tpServ><cMunIni>3550308</cMunIni><xMunIni>Sao Paulo</xMunIni><UFIni>SP</UFIni><cMunFim>4307005</cMunFim><xMunFim>Erechim</xMunFim><UFFim>RS</UFFim><retira>1</retira><indIEToma>1</indIEToma><toma3><toma>0</toma></toma3></ide><compl><xEmi>operador</xEmi><Entrega><comData><tpPer>2</tpPer><dProg>2017-09-05</dProg></comData><semHora><tpHor>0</tpHor></semHora></Entrega><origCalc>SP</origCalc><destCalc>RS</destCalc><ObsCont xCampo="Observacao"><xTexto>ws</xTexto></ObsCont><ObsCont xCampo="Observacao"><xTexto>Transporte Subcontratado</xTexto></ObsCont></compl><emit><CNPJ>65849838002577</CNPJ><IE>241086922119</IE><xNome>Penske Logistic do Brasil LTDA - Cajamar</xNome><xFant>XXLogistics (Cajamar)</xFant><enderEmit><xLgr>Av. Doutor Antonio Joao Abdalla</xLgr><nro>260</nro><xCpl>Parte C e D</xCpl><xBairro>Empresarial Colina</xBairro><cMun>3509205</cMun><xMun>Cajamar</xMun><CEP>07750020</CEP><UF>SP</UF><fone>1137388565</fone></enderEmit></emit><rem><CNPJ>59275792002799</CNPJ><IE>336985979110</IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><fone>08007024200</fone><enderReme><xLgr>Av. Landri Sales,</xLgr><nro>1070</nro><xCpl>Quinhao B</xCpl><xBairro>Cidade Aracilia</xBairro><cMun>4200051</cMun><xMun>Abdon Batista</xMun><CEP>07250130</CEP><UF>SC</UF><cPais>1058</cPais><xPais>BRASIL</xPais></enderReme></rem><exped><CNPJ>59275792002799</CNPJ><IE>336985979110</IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><enderExped><xLgr>Praca Anita Pinacci Goncalves</xLgr><nro>S/N</nro><xCpl>59275792002799</xCpl><xBairro>Parque das Paineiras</xBairro><cMun>3550308</cMun><xMun>Sao Paulo</xMun><CEP>99700000</CEP><UF>SP</UF><cPais>1058</cPais><xPais>BRASIL</xPais></enderExped></exped><receb><CNPJ>00485542000363</CNPJ><IE>0390130893</IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><enderReceb><xLgr>RUA J.B. CABRAL</xLgr><nro>299</nro><xBairro>CENTRO</xBairro><cMun>4307005</cMun><xMun>Erechim</xMun><UF>RS</UF><cPais>1058</cPais><xPais>BRASIL</xPais></enderReceb></receb><dest><CNPJ>00485542000363</CNPJ><IE>0390130893</IE><xNome>CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><fone>05435208800</fone><enderDest><xLgr>RUA J.B. CABRAL</xLgr><nro>299</nro><xBairro>CENTRO</xBairro><cMun>4307005</cMun><xMun>Erechim</xMun><CEP>99700000</CEP><UF>RS</UF><cPais>1058</cPais><xPais>BRASIL</xPais></enderDest></dest><vPrest><vTPrest>178.00</vTPrest><vRec>178.00</vRec><Comp><xNome>frete1</xNome><vComp>178.00</vComp></Comp></vPrest><imp><ICMS><ICMS00><CST>00</CST><vBC>202.27</vBC><pICMS>12.00</pICMS><vICMS>24.27</vICMS></ICMS00></ICMS></imp><infCTeNorm><infCarga><vCarga>641.57</vCarga><proPred>transporte</proPred><xOutCat>CAIXA</xOutCat><infQ><cUnid>01</cUnid><tpMed>PESO REAL</tpMed><qCarga>8.9000</qCarga></infQ><infQ><cUnid>01</cUnid><tpMed>PESO TAXADO</tpMed><qCarga>8.9000</qCarga></infQ><infQ><cUnid>01</cUnid><tpMed>CUBAGEM</tpMed><qCarga>0.0000</qCarga></infQ><infQ><cUnid>03</cUnid><tpMed>VOLUMES</tpMed><qCarga>2.0000</qCarga></infQ></infCarga><infDoc><infNFe><chave>35170659275792002799557630005390771072082545</chave></infNFe></infDoc><infModal versaoModal="3.00"><rodo><RNTRC>05666364</RNTRC></rodo></infModal></infCTeNorm><autXML><CNPJ>04898488000177</CNPJ></autXML><dadosAdic><B2BDirectory>C:\ProcCTe\XXCAJAMAR</B2BDirectory></dadosAdic></infCte></CTe></CTe><protCTe xmlns="http://www.portalfiscal.inf.br/cte" versao="2.00"><infProt><tpAmb>1</tpAmb><verAplic>SP-CTe-23-09-2016</verAplic><chCTe>35170965849838002577570090005000021005000026</chCTe><dhRecbto>2016-09-30T10:40:00</dhRecbto><nProt>135160824340491</nProt><digVal>SFpLXk2MO5+xPZzyN+Z9Xb89CPM=</digVal><cStat>100</cStat><xMotivo>Autorizado o uso do CT-e</xMotivo></infProt></protCTe></cteProc></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 ProcCTe, porém, de acordo com o tipo do documento pesquisado será retornado em um layout, conforme tabela:
Documento |
Tipo |
Manual de Formação |
Exemplo |
|---|---|---|---|
CTe |
Layout ProcCTe Sefaz |
||
NFSe |
Layout NFSe NDD |
||
Nota de Débito |
Layout Nota de Débito NDD |
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. |