Busca Fatura de Pagamento
Anterior
Próximo
Imprimir

Busca Fatura de Pagamento

A integração disponibilizada para busca de faturas de pagamento é um processo assíncrono. É 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>4307</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:

o 4307 Pedido de Download de faturas de pagamento.

A01

N

S

-

4

B02

MessageType

Tipo da operação: 103

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem: 7 Envio

A01

N

S

FIXO

6

B04

EnterpriseId

Identificador do Operador Logístico.

A01

GUID

S

FIXO

7

B05

Token

Token para autenticação do 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>PaymentInvoice_EMI_46aaf9bd-f002-e911-80df-00155dff1f01</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>4307</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: 7 Envio

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem

A01

GUID

S

-

7

B05

EnterpriseId

Identificador do Operador Logístico.

A01

GUID

S

FIXO

8

B06

Token

Token para autenticação  do Operador Logístico.

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

          <MessageType>103</MessageType>

          <ExchangePattern>8</ExchangePattern>

          <Guid>f936299c-75b3-40a3-a2a8-3252a4c6c3f3</Guid>

          <EnterpriseId>16d043a5-d512-4adc-ab78-12515e25c5b6</EnterpriseId>

          <Token>e4693f3b-c0e7-4888-b12d-41f2eb85cee6</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: 8 Retorno

A01

N

S

FIXO

5

B03

ExchangePattern

TIpo da mensagem informada no envio

A01

N

S

FIXO

6

B04

Guid

Identificador Único da Mensagem retornada do envio

A01

GUID

S

-

7

B05

EnterpriseId

Identificador do embarcador informado no envio

A01

GUID

S

FIXO

8

B06

Token

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

 

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

         <MessageType>103</MessageType>

         <ExchangePattern>7</ExchangePattern>

         <Guid>80c3ee6d-2262-4c0a-bda0-41421e56890d</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>

                 <DataResponse Version="1.0">

                         <Element>

                                 <Id>PaymentInvoice_EMI_6d031a20-cb02-e911-80df-00155dff1f01</Id>

                                 <Data>

                                         <infFat>

                                                 <cBanco>033</cBanco>

                                                 <cExtPtoOper>GUA OP</cExtPtoOper>

                                                 <xCnpjOpe>12345678912345</xCnpjOpe>

                                                 <dtEmi>2018/12/14T12:01:03</dtEmi>

                                                 <dVencto>2018/12/19T12:00:00</dVencto>

                                                 <cFat>21</cFat>

                                                 <cExtForn>12345678912345</cExtForn>

                                                 <cExtCli>12345678912345</cExtCli>

                                                 <cLancto>21</cLancto>

                                                 <nContabil>21</nContabil>

                                                 <xSerie>2</xSerie>

                                                 <Observ>OBSERVACAO</Observ>

                                                 <Senso>D</Senso>

                                                 <xTipo>FAT</xTipo>

                                                 <cSubGrpCont>1</cSubGrpCont>

                                                 <cStat>1</cStat>

                                                 <tsPagto>1</tsPagto>

                                                 <vLancto>303.06</vLancto>

                                                 <NFFat>

                                                         <infNFFat>

                                                                 <cCTRC>1959</cCTRC>

                                                                 <nCTRC>1959</nCTRC>

                                                                 <Serie>12</Serie>

                                                                 <xSubSerie>0</xSubSerie>

                                                                 <vValDescontoCt>0.00</vValDescontoCt>

                                                                 <xDatEmiss>11/12/2018</xDatEmiss>

                                                                 <vValCTRC>201.53</vValCTRC>

                                                                 <cExtPtoOper>PTO OP</cExtPtoOper>

                                                                 <xCnpjOpe>12345678912345</xCnpjOpe>

                                                         </infNFFat>

                                                         <infNFFat>

                                                                 <cCTRC>1960</cCTRC>

                                                                 <nCTRC>1960</nCTRC>

                                                                 <Serie>12</Serie>

                                                                 <xSubSerie>0</xSubSerie>

                                                                 <vValDescontoCt>0.00</vValDescontoCt>

                                                                 <xDatEmiss>11/12/2018</xDatEmiss>

                                                                 <vValCTRC>101.53</vValCTRC>

                                                                 <cExtPtoOper>PTO OP</cExtPtoOper>

                                                                 <xCnpjOpe>12345678912345</xCnpjOpe>

                                                         </infNFFat>

                                                 </NFFat>

                                         </infFat>

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

220

A quantidade de identificadores é maior que o limite de pacotes configurado

O limite de registros configurado é maior que o número de identificadores informado.

404

Identificador não encontrado

Identificador informado na requisição não existe na base de dados do nddFrete.

999

Ocorreu um erro inesperado no processamento da mensagem.

Erro não catalogado.