Download de Faturas e Pagamentos

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 de pagamentos 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)

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

</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: o4307 Pedido de Download de Fatura o4309 Pedido de Download de Provisão o4311 Pedido de Download de OVP o4313 Pedido de Download de PA	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>

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

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

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

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

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

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

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

</CrosstalkHeader>

</CiotRelacionado>

<RazaoSocial>teste</RazaoSocial>

<Logradouro>Rua Borges de Medeiros</Logradouro>

<Bairro>Centro</Bairro>

<Cidade>Vacaria</Cidade>

<Complemento>Proximo ao Estadio</Complemento>

</Endereco>

</DadosPagador>

<Nome>BINO SILVA AMARAL</Nome>

<Logradouro>MUITO LONGE MESMO</Logradouro>

<Bairro>CENTRO</Bairro>

<Cidade>SAO PAULO</Cidade>

</Endereco>

</DadosRecebedor>

<Logradouro>Rua Borges de Medeiros</Logradouro>

<Bairro>Centro</Bairro>

<Cidade>Vacaria</Cidade>

<Complemento>Proximo ao Estadio</Complemento>

</Endereco>

</FilialContratante>

<Inss>

<Observacoes>O Transportador citado já retém INSS através de outra empresa.</Observacoes>

</Inss>

<Irrf>

</Irrf>

<Sest>

</Sest>

<Senat>

</Senat>

</VlrImpostos>

</ValoresPA>

</RetornoConsultaPA>

</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 PA, porém, de acordo com o tipo do documento pesquisado será retornado em um layout, conforme tabela:

Documento	Tipo	Manual de formação	Exemplo
Fatura	Layout DOCCOB NDD	Esquema layout DOCCOB NDD	Arquivo_DOCCOB
Provisão	Layout Provisão NDD	Esquema XML layout Provisão NDD	Arquivo_Provisao
OVP	Layout OVP NDD	Esquema XML layout OVP NDD	Arquivo OVP.xml
PA	Layout de PA NDD	Esquema XML layout PA NDD	Arquivo PA.xml

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.