Upload

A integração disponibilizada do envio dos apontamentos da Fatura é um processo assíncrono, e captura uma fatura ou um documento específico da fatura para realizar alterações na fatura conforme o tipo informado, 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 os dados da fatura ou do documento.

Ao receber a lista de apontamentos, a aplicação nddFrete localiza em sua base de dados as faturas ou os documentos informados, processa-os, monta a mensagem de reposta . O resultado do processamento é retornado na busca da resposta da primeira requisição.

A primeira chamada é o Envio do Apontamento, que deve receber dois parametros: O Crosstalk de Envio e a Lista de apontamentos

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: o3152 Apontamento de Fatura	A01	N	S	-
4	B02	MessageType	Tipo da operação: 103	A01	N	S	FIXO
5	B03	ExchangePattern	TIpo da mensagem: 7 Requisição	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

Envio - Lista de apontamentos (parâmetro rawdata)

<Number>EMBDEV.27600-P01</Number>

<IdentifierCode>teste</IdentifierCode>

</Billing>

<Number>EMBDEV.27600-P01</Number>

<IdentifierCode>teste</IdentifierCode>

</Document>

<Obs>acrescimo</Obs>

</Financial>

</AppointmentType>

</Appointment>

</PaymentAppointmentPost>

Detalhamento da Consulta

#	ID	CAMPO	DESCRIÇÃO	PAI	TIPO	OBR.	OBS.
1	RAIZ	PaymentAppointmentPost	Tag raiz da mensagem	-	-	S	FIXO
2	A01	Appointment	Registro realizado por fatura ou por documento	RAIZ	-	S	FIXO
3	B01	OperationPointCnpj	CNPJ do ponto de Operação	A01	N	S	FIXO
4	B02	ServiceProviderCnpj	CNPJ do transportador	A01	N	S	FIXO
5	B03	Billing	Fatura	A01	-	N	FIXO
6	C01	Type	Tipo da fatura 0-Fatura de Pagamento, 1-Fatura de Cobrança	B03	N	N	FIXO
7	C02	Serie	Serie da Fatura	B03	C	S	FIXO
8	C03	Number	Número da Fatura	B03	C	S	FIXO
9	C04	IdentifierCode	Código de Identificação para ser rastreado pelo cliente	B03	C	N	FIXO
10	B04	Document	Documentos de transporte	A01	-	N	FIXO
11	D01	Type	Tipo do documento 1-CTe, 2-NFSe, 3-CIOT, 4-Nota de Débito, 5-OST	B04	N	S	FIXO
12	D02	Serie	Série do documento	B04	C	S	FIXO
13	D03	Number	Número do documento	B04	N	S	FIXO
14	D04	IdentifierCode	Código de Identificação para ser rastreado pelo cliente	B04	C	N	FIXO
15	B05	AppointmentType	Tipo do apontamento	A01	-	S	FIXO
16	E01	Taxes	Apontamento de Impostos	B05	-	N	FIXO
17	F01	Tax	Lista de Impostos	E01	-	S	FIXO
18	J01	Type	Tipo do imposto 0-ICMS, 1-ISS, 2-PIS, 3-COFINS, 4-IR, 5-INSS, 6-CSLL, 7-SEST, 8-SENAT	F01	N	S	FIXO
19	J02	BaseCalculation	Base de Cálculo	F01	N	N	FIXO
20	J03	Aliquot	Alíquota	F01	N	N	FIXO
21	J04	Value	Valor do Imposto	F01	N	S	FIXO
22	J05	Obs	Observação adicional	F01	C	N	FIXO
23	E02	Financial	Apontamento financeiro	B05	-	N	FIXO
24	G01	Identification	Tipo do apontamento financeiro conforme cadastro	E02	N	S	FIXO
25	G02	dhAppointment	Data/hora da amortização	E02	C	S	FIXO
26	G03	Value	Valor da amortização	E02	N	S	FIXO
27	G04	Obs	Observação adicional emitida pelo legado	E02	C	N	FIXO
28	E03	Postpone	Apontamento de Postergação	B05	-	N	FIXO
29	H01	dPostpone	Data para postergação da fatura	E03	C	S	FIXO
30	H02	Obs	Observação adicional emitida pelo legado.	E03	C	N	FIXO
31	E04	Cancellation	Apontamento de Cancelamento	B05	-	N	FIXO
32	I01	dhCancellation	Data para o cancelamento	E04	C	S	FIXO
33	I02	Obs	Observação adicional pelo legado.	E04	C	N	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>

<RawData><![CDATA[<PaymentAppointmentPostResponse Version="1.0.0"><Response><Code>100</Code><Description>Amortização processada com sucesso</Description></Response><Appointment><ServiceProviderCnpj>14631417773</ServiceProviderCnpj><Document><Type>3</Type><Serie>EMB</Serie><Number>EMBDEV.27600-C01</Number></Document><Response><Code>100</Code><Description>Amortização processada com sucesso</Description></Response></Appointment></PaymentAppointmentPostResponse>

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

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
100	Amortização processada com sucesso	Processamento realizado com sucesso.
200	Identificador do mapeamento não encontrado	Identificador não cadastrado ou incorreto.
201	Falha na execução do mapeador	arquivo enviado é invalido ou mal formado.
300	Fatura não encontrada na base de dados	Fatura não encontrada com base nos dados informados.
301	Documento não encontrado na base de dados	Documento não encontradocom base nos dados informados.
302	Fatura com status cancelada ou paga	A fatura solicitada se ecncontra com um status que não permite o processo de amortização.
303	Fatura com status diferente de liberada para pagamento ou aguardando apontamento	Fatura solicitada com status de Evento diferente dos que são permitidos.
304	Código de identificação não cadastrado na base de dados	Código informado para apontamento financeiro não existe na base de dados
305	O valor do pagamento da fatura do tipo CIOT deve ser igual ao saldo a receber	O valor informado na requisição de uma fatura tipo CIOT é diferente do saldo a receber.
306	O valor do pagamento do documento ultrapassou o saldo a receber.	O valor informado é maior que o saldo a receber da fatura.
307	O valor do pagamento da fatura ultrapassou o saldo a receber	O valor informado é maior que o saldo a receber da fatura.
308	O valor do desconto do documento ultrapassou o saldo a receber	O valor informado é maior que o saldo a receber da fatura.
309	O valor do desconto da fatura ultrapassou o saldo a receber	O valor informado é maior que o saldo a receberda fatura.
310	Para faturas do tipo CIOT, a data de pagamento deve ser maior do que a data atual	A data informada na requisição não pode maior que a data atual.
311	Para pagamento de documento de uma fatura do tipo CIOT, a fatura deve conter apenas um documento	Informado mais de um documento na requisição de uma fatura do tipo CIOT.
312	A data informada para postergação não pode ser inferior à data de vencimento da fatura	O valor da data informado é menor que a data de vencimento atual.