Disponibilização Pré-Fatura

A consulta de lista de identificadores de Pré-fatura é um processo síncrono onde identifica o solicitante da requisição e disponibiliza a lista de identificadores relacionados a PREFAT não consumidos pelo solicitante. A consulta suporta como solicitante os dados do embarcador ou o transportador.

</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 4318 Consulta Lista de PREFAT disponíveis.	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 do solicitante	A01	GUID	S	FIXO
7	B05	Token	Token para autenticação do solicitante	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

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

</CrosstalkHeader>

</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 solicitante informado no envio	A01	GUID	S	FIXO
8	B06	Token	Token para autenticação do solicitante 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	-

O prefixo gerado para os identificadores retornados da consulta da lista é configurado nos dados de mapeamento do embarcador.

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.

Download PREFAT

A integração disponibilizada para busca de PREFAT é 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)

</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 4319 Pedido de Download de PREFAT.	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 embarcador	A01	GUID	S	FIXO
7	B05	Token	Token para autenticação do embarcador	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

<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 do embarcador	A01	GUID	S	FIXO
8	B06	Token	Token para autenticação do embarcador	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)

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

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

</CrosstalkHeader>

<Data>000CARROS DO BRASIL AUTOMOVEIS LTDA TRANSPORTADDOR LTDA 23052018160002PRE012305

590PREFAT502305001

59104104117000761 79611697 CARROS DO BRASIL AUTOMOVEIS LTDA

592000000000123052018180620180003000000000099429ITESTE DE PREFAT

59352548435015524 0331802525484350155245700300002123510501026780030000212352202201800000000000789012345 QCN1 CC1 L

59352548435015524 0331802525484350155245700300002123610501026830030000212362202201800000000001163812345 QCN1 CC2 L

59352548435015524 0331802525484350155245700300002123710501026990030000212372202201800000000007990112346 QCN2 CC1 L

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

Documento	Tipo	Manual de formação
Fatura	Layout PREFAT NDD	Esquema layout PREFAT NDD

O conteúdo do donwload pode variar de acordo com o mapeamento configurado no cadastro na tela de "Configurações Gerais"

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.