Solicitar lista dos Documentos Faturados disponíveis

A solicitação da lista do XML faturados disponíveis visa relacionar ao responsável pela requisição da mesma, os identificadores dos pacotes ainda não consumidos pelo solicitante. Ao processar a chamada, o módulo de integração do nddFrete verifica os documentos emitidos disponíveis e associa aos mesmos um identificador, baseado em:

•Prefixo: Identificador do Embarcador ou identificador do documento;

•Tipo do documento: Tipo do documento disponibilizado;

•Número: Número do documento disponibilizado;

•Série: Série do documento disponibilizado;

•FAT: Identificador de fatura fixo;

•Número de fatura: Número da fatura dos documento disponibilizados.

Exemplos:

•DocumentoFaturado_NFSe_6456_654_FAT_3

•DocumentoFaturado_CTe_457_568_FAT_4

•DocumentoFaturado_NotaDebito_18_0_FAT_2

Crosstalk de Envio (parâmetro header)

</CrosstalkHeader>

</CrosstalkMessage>

Será possível filtrar a solicitação dos documentos solicitados através da da tag DocumentKind como a seguir:

</InvoicedDocumentsRequest>

•DocumentKind: 0 - Todos;

•DocumentKind: 1 - CT-e;

•DocumentKind: 2 - NFS-e;

•DocumentKind: 3 - Nota de Débito;

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: o4314 Solicita Lista de documentos Faturados	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

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

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

</CrosstalkHeader>

<Id>DocumentoFaturado_NFSe_6456_654_FAT_3</Id>

<Id>DocumentoFaturado_CTe_457_568_FAT_4</Id>

<Id>DocumentoFaturado_NotaDebito_18_0_FAT_2</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 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
11	B09	ResponseCode	Código de resposta do processamento	A01	N	S	-
12	B10	ResponseMessage	Mensagem referente ao ResponseCode	A01	C	S	-
14	C01	RawData	Código dos documentos disponíveis	-	C	N	-

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.