A consulta de lista de identificadores de faturas de pagamento é um processo síncrono onde identifica o solicitante da requisição e disponibiliza a lista de identificadores relacionados as faturas ainda não consumidas pelo solicitante que estiverem fechadas e aprovadas. A consulta suporta como solicitante apenas o operador logístico, não estando disponível para embarcador e transportador.
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4306</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. |
1 |
RAIZ |
CrossTalk_Message |
Tag raiz da mensagem |
- |
- |
S |
2 |
A01 |
CrossTalk_Header |
Cabeçalho |
RAIZ |
- |
S |
3 |
B01 |
ProcessCode |
Código da mensagem da recepção de documentos: o 4306 Consulta Lista de faturas de pagamento. |
A01 |
N |
S |
4 |
B02 |
MessageType |
Tipo da operação: 103 |
A01 |
N |
S |
5 |
B03 |
ExchangePattern |
TIpo da mensagem: 1 (síncrona) |
A01 |
N |
S |
6 |
B04 |
EnterpriseId |
Identificador do Operador Logístico. |
A01 |
GUID |
S |
7 |
B05 |
Token |
Token para autenticação do Operador Logístico. |
A01 |
GUID |
S |
8 |
B06 |
ContentType |
Formato da mensagem enviada: text/xml |
A01 |
C |
S |
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>4306</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>1</ExchangePattern> <Guid>a5d0b06a-a9be-47a3-b726-e064fa96e38a</Guid> <EnterpriseId>16d043a5-d512-4adc-ab78-12515e25c5b6</EnterpriseId> <Token>e4693f3b-c0e7-4888-b12d-41f2eb85cee6</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> <ResponseCode>205</ResponseCode> <ResponseMessage>A mensagem foi processada com sucesso.</ResponseMessage> </CrosstalkHeader> <CrosstalkBody> <RawData> <ListResponse Version="1.0"> <Id>PaymentInvoice_EMI_6d031a20-cb02-e911-80df-00155dff1f01</Id> <Id>PaymentInvoice_EMI_010ce20d-0003-e911-80df-00155dff1f01</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 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 operador logístico.
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. |