Documentos do Transporte
Anterior
Próximo
Imprimir

Documentos do Transporte

Chamadas de serviço disponiveis para upload, consulta e download de Documentos do Transporte a solução, de acordo aos seguintes tipos de arquivos e regras de estruturas/formatação:

 

 

Tipo

Modelo

Manual de Formação

Exemplo

NFS-e

Layout NFSe NDD

Esquema NFS-e NDD

Arquivo NFSe.xml

 

 

hmtoggle_arrow1Consulta

 

A consulta lista do XML de NFS-es dos documentos disponíveis do nddFrete conciliados e não vinculados a eventos e ao faturamento, visa relacionar ao responsável pela requisição da mesma os identificadores dos pacotes ainda não consumidos pelo solicitante.

 

Os documentos disponíveis para consulta são:

 

Tipo do Documento

ProcessCode

Nota Fiscal de Serviço (NFS-e)

4302

 

 

 

 

Crosstalk de Envio (parâmetro header)

 

 

<CrosstalkMessage>

            <CrosstalkHeader>

                        <ProcessCode>4302</ProcessCode>

                        <MessageType>103</MessageType>

                        <ExchangePattern>1</ExchangePattern>

                        <EnterpriseId>FB7BB156-4370-4DE5-AEA8-5BA1C93EC4B5</EnterpriseId>

                        <Token>A4C3E8D4-E855-4AAF-BC77-CE7ACEA990C6</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:

o4300 Consulta Lista de CT-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>4302</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>1</ExchangePattern>

         <Guid>7a6fb015-1e7f-469a-9321-ba8166d12e8f</Guid>

         <EnterpriseId>fb7bb156-4370-4de5-aea8-5ba1c93ec4b5</EnterpriseId>

         <Token>4cd76c7c-e492-4959-bfdf-c8c1d3c2df17</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>NFSe_1000000000000123111111110001114209300</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 informado no envio

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação do cliente 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

-

 

 

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.

210

ProcessCode e MessageType inválido

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

214

A mensagem foi rejeitada porque o embarcador não foi informado ou não está cadastrado.

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

215

A consulta não retornou nenhum resultado.

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

999

Ocorreu um erro inesperado no processamento da mensagem.

Erro não catalogado.

 

 

 

 

 

 

hmtoggle_arrow1Download

 

Pedido de download de documento

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

NFS-e (Nota Fiscal de Serviço)

4303

 

 

Crosstalk de Envio (parâmetro header)

 

 

<CrosstalkMessage>

            <CrosstalkHeader>

                        <ProcessCode>4303</ProcessCode>

                        <MessageType>103</MessageType>

                        <ExchangePattern>7</ExchangePattern>

                        <EnterpriseId>FB7BB156-4370-4DE5-AEA8-5BA1C93EC4B5</EnterpriseId>

                        <Token>A4C3E8D4-E855-4AAF-BC77-CE7ACEA990C6</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:

o4303 Pedido de Download de NFS-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>NFSe_1000000000000123111111110001114209300</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>4303</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>7</ExchangePattern>

         <Guid>c7f6be98-359c-4ddf-a2f9-d3bc3149a7a1</Guid>

         <EnterpriseId>fb7bb156-4370-4de5-aea8-5ba1c93ec4b5</EnterpriseId>

         <Token>a4c3e8d4-e855-4aaf-bc77-ce7acea990c6</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>4303</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>8</ExchangePattern>

         <Guid>c7f6be98-359c-4ddf-a2f9-d3bc3149a7a1</Guid>

         <EnterpriseId>fb7bb156-4370-4de5-aea8-5ba1c93ec4b5</EnterpriseId>

         <Token>a4c3e8d4-e855-4aaf-bc77-ce7acea990c6</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

 

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>4303</ProcessCode>

         <MessageType>103</MessageType>

         <ExchangePattern>8</ExchangePattern>

         <Guid>c7f6be98-359c-4ddf-a2f9-d3bc3149a7a1</Guid>

         <EnterpriseId>fb7bb156-4370-4de5-aea8-5ba1c93ec4b5</EnterpriseId>

         <Token>4cd76c7c-e492-4959-bfdf-c8c1d3c2df17</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>NFSe_10000000000001231111111100011142093000803105</Id>

         <Data>

                 <NFSe>

                 <InfRps>

                         <Competencia>10-06-2020 00:00:00</Competencia>

                         <DataEmissao>10-06-2020 00:00:00</DataEmissao>

                         <NaturezaOperacao>52</NaturezaOperacao>

                         <TributarMunicipio>2</TributarMunicipio>

                         <TributarPrestador>2</TributarPrestador>

                         <Servicos>

                                 <ItemListaServico>04.30</ItemListaServico>

                                 <CodigoTributacaoMunicipio>88889999</CodigoTributacaoMunicipio>

                                 <IssRetido>2</IssRetido>

                                 <DadosComplementaresServico>

                                         <TipoRecolhimento>1</TipoRecolhimento>

                                             <MunicipioPrestacaoDescricao>LAGES/SC</MunicipioPrestacaoDescricao>

                                         <DiscriminacaoServico>04.30</DiscriminacaoServico>

                                 </DadosComplementaresServico>

                         </Servicos>

                         <Prestador>

                                 <Cnpj>81993445000111</Cnpj>

                                 <InscricaoMunicipal>11223</InscricaoMunicipal>

                                 <EnderecoPrestador>

                                         <Endereco>DR WALMOR RIBEIRO 514</Endereco>

                                         <Bairro>CORAL</Bairro>

                                         <Uf>SC</Uf>

                                         <Cep>88508310</Cep>

                                 </EnderecoPrestador>

                                 <DadosComplementaresPrestador>

                                         <Telefone>4932250199</Telefone>

                                         <RazaoSocial>NDD</RazaoSocial>

                                         <NomeFantasia>NDD</NomeFantasia>

                                 </DadosComplementaresPrestador>

                         </Prestador>

                         <Tomador>

                                 <RazaoSocial>NDD - FILIAL</RazaoSocial>

                                 <IdentificacaoTomador>

                                         <Cnpj>86024957000193</Cnpj>

                                         <InscricaoMunicipal>112233</InscricaoMunicipal>

                                 </IdentificacaoTomador>

                                 <EnderecoTomador>

                                         <Endereco>DR WALMOR RIBEIRO</Endereco>

                                         <Numero>514</Numero>

                                         <Bairro>CORAL</Bairro>

                                         <CodigoMunicipio>4209300</CodigoMunicipio>

                                         <Uf>SC</Uf>

                                 </EnderecoTomador>

                         </Tomador>

                 </InfRps>

                 <InfNfse>

                         <Numero>22233</Numero>

                         <DataEmissao>10-06-2020 00:00:00</DataEmissao>

                         <ValoresServico>

                                 <ValorServicos>227.10</ValorServicos>

                                 <ValorIss>0.00</ValorIss>

                                 <ValorIssRetido>0.00</ValorIssRetido>

                                 <BaseCalculo>0.00</BaseCalculo>

                                 <Aliquota>0.0000</Aliquota>

                                 <ValorLiquidoNfse>227.10</ValorLiquidoNfse>

                         </ValoresServico>

                 </InfNfse>

         </NFSe>

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

-

 

 

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

 

Código

Mensagem

Situação

200

A mensagem foi recebida e está sendo processada.

Solicitação do envio processada com sucesso.

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.

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.

Erro não catalogado.