A consulta disponibiliza a lista de identificadores relacionados ao cálculo de imposto não consumidos pelo solicitante, para disponibilização ao embarcador.
Crosstalk de Envio (parâmetro header) |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4316</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. |
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: o4316 Consulta Lista de Cálculo de Imposto. |
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 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 |
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>4316</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>7</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>CalcCredito_42171115023532000111575680000004561100803106</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 |
- |
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. |
Crédito de Imposto |
|---|
A integração disponibilizada para busca de Cálculo de Imposto é 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) |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4317</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>7</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. |
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: o4317 Pedido de Download de Cálculo |
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 Version = "1.0"> <Id>CalcCredito_42171115023532000111575680000004561100803106</Id> </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 |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4317</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>7</ExchangePattern> <Guid>c7f6be98-359c-4ddf-a2f9-d3bc3149a7a1</Guid> <EnterpriseId>fb7bb156-4370-4de5-aea8-5ba1c93ec4b5</EnterpriseId> <Token>a4c3e8d4-e855-4aaf-bc77-ce7acea990c6</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> <ResponseCode>200</ResponseCode> <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) |
|---|
<CrosstalkMessage><CrosstalkHeader> <ProcessCode>4317</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>8</ExchangePattern> <Guid>f936299c-75b3-40a3-a2a8-3252a4c6c3f3</Guid> <EnterpriseId>16d043a5-d512-4adc-ab78-12515e25c5b6</EnterpriseId> <Token>e4693f3b-c0e7-4888-b12d-41f2eb85cee6</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> </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 |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4317</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>8</ExchangePattern> <Guid>f936299c-75b3-40a3-a2a8-3252a4c6c3f3</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><![CDATA[<DataResponse Version="1.0"><Element><retContract xmlns="http://www.auditoreletronico.srv.br/ade" prot="18041717442750584484"> <cadToma IDVersao="7"> <xCNPJToma>65151466000133</xCNPJToma> <xIEToma>00</xIEToma> </cadToma> <Docs> <chCTe>42171115023532000111575680000004561100803106</chCTe> </Docs> <xCNPJPrest>29187583000193</xCNPJPrest> <retVal> <CodRet>012</CodRet> <xDescRet>ANALISE TRIBUTARIA REALIZADA</xDescRet> <Cred> <pICMS>0</pICMS> <vICMS>0.00</vICMS> <pPIS>0</pPIS> <vPIS>0.00</vPIS> <pCOFINS>0</pCOFINS> <vCOFINS>0.00</vCOFINS> <sitCred>1</sitCred> <xObsSitCred>DESTAQUE DO ICMS INCONSISTENTE COM O CENÁRIO</xObsSitCred> </Cred> </retVal> </retContract></Element></DataResponse>]]]]>><![CDATA[</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 |
- |
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. |
999 |
Ocorreu um erro inesperado no processamento da mensagem. |
Erro não catalogado. |