Este processo consiste no envio das DOCCOB (fatura) emitida pela transportadora classificados como ETC normal.
Crosstalk de Envio (parâmetro header) |
|---|
Para enviar um documento, além dos dados do mesmo é necessário informar o código da mensagem, bem como, os dados de identificação do cliente conforme layout detalhado abaixo.
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4111</ProcessCode> <MessageType>100</MessageType> <ExchangePattern>7</ExchangePattern> <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId> <Token>98dc2a43-1eed-41a8-869a-e5590f623558</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: O 4111 Envio de DOCCOB (fatura)
|
A01 |
N |
S |
- |
4 |
B02 |
MessageType |
Tipo da operação: 100 |
A01 |
N |
S |
FIXO |
5 |
B03 |
ExchangePattern |
TIpo da mensagem: 7 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 |
Documento de envio (Parametro rawdata - exemplo XML DOCCOB) |
00025512677000130 01016473000140 0603181536COB500603000 550COBRA500603001 55101016473000140TRANSPORTADOR01 552NDD 012 00000000010603201807032018000000000045000 I 5550101647300100 00000000045800000000004500028112017 01016473000140 SCPR EMBDEV.28666 35170865849838002577100000000684587000225730 55623700000061926052017 5590001000000000045000 |
Retorno da solicitação |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4111</ProcessCode> <MessageType>100</MessageType> <ExchangePattern>7</ExchangePattern> <Guid>97abcd76-f358-4e76-bc0d-8bbb92aef272</Guid> <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId> <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> <ResponseCode>200</ResponseCode> <ResponseMessage>A mensagem foi recebida e está sendo processada</ResponseMessage> <CustomId>01234567890</CustomId> </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 |
- |
5 |
B03 |
ExchangePattern |
TIpo da mensagem informada no envio |
A01 |
N |
S |
- |
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 |
B11 |
CustomId |
Identificador da Mensagem |
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 será retornado falha de schema. Se algum dos campos obrigatórios não estiver no formato correto, a mensagem de retorno criticará o mesmo.
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. |
200 |
A mensagem foi recebida e está sendo processada. |
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. |
Consulta do Processamento |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4111</ProcessCode> <MessageType>100</MessageType> <ExchangePattern>8</ExchangePattern> <Guid>97abcd76-f358-4e76-bc0d-8bbb92aef272</Guid> <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId> <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> </CrosstalkHeader> </CrosstalkMessage> |
A consulta com o ExchangePattern 8 retorna se a solicitação foi processada ou ainda está em processamento.
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 4111 Consulta de envio de DOCCOB (fatura) |
A01 |
N |
S |
- |
4 |
B02 |
MessageType |
Tipo da operação: 100 |
A01 |
N |
S |
FIXO |
5 |
B03 |
ExchangePattern |
TIpo da mensagem: 8 |
A01 |
N |
S |
FIXO |
6 |
B04 |
Guid |
Identificador Único da Mensagem |
A01 |
GUID |
S |
Informar Guid do Retorno do processamento |
7 |
B05 |
EnterpriseId |
Identificador para autenticação |
A01 |
GUID |
S |
FIXO |
8 |
B06 |
Token |
Token para autenticação |
A01 |
GUID |
S |
FIXO |
9 |
B07 |
ContentType |
Formato da mensagem enviada: text/xml |
A01 |
C |
S |
FIXO |
Retorno do Processamento |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4111</ProcessCode> <MessageType>100</MessageType> <ExchangePattern>8</ExchangePattern> <Guid>97abcd76-f358-4e76-bc0d-8bbb92aef272</Guid> <EnterpriseId>6c5bac4a-b12f-4c75-87aa-f782a29298dd</EnterpriseId> <Token>98dc2a43-1eed-41a8-869a-e5590f623558</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> <ResponseCode>205</ResponseCode> <ResponseMessage>A mensagem foi processada com sucesso.</ResponseMessage> <CustomId>01234567890</CustomId> </CrosstalkHeader> </CrosstalkMessage> |
Detalhamento do Header:
# |
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 |
- |
5 |
B03 |
ExchangePattern |
TIpo da mensagem informada no envio |
A01 |
N |
S |
- |
6 |
B04 |
Guid |
Identificador Único da Mensagem |
A01 |
GUID |
S |
- |
7 |
B05 |
EnterpriseId |
Identificador do transportador ou operador logístico informado no envio |
A01 |
GUID |
S |
FIXO |
8 |
B06 |
Token |
Token para autenticação do cliente ou operador logístico 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 |
- |
13 |
B11 |
CustomId |
Identificador da Mensagem |
A01 |
C |
S |
- |
Códigos Retorno do Cabeçalho da Mensagem |
|---|
Código |
Mensagem |
Situação |
203 |
A mensagem foi rejeitada por causa de falha na validação do esquema do documento. |
A estrutura do xml de envio estiver incorreta. |
205 |
A mensagem foi processada com sucesso. |
O processo de retorno do status do documento foi executado 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 informado não está cadastrado no sistema NddFrete. |
210 |
ProcessCode e MessageType inválido. |
O ProcessCode ou o MessageType informados não existem na aplicação nddFrete. |
218 |
A mensagem foi rejeitada porque o operador não está cadastrado. O operador não foi encontrado através do EnterpriseId e Token. |
O enterpriseId informado não está cadastrado no sistema NddFrete. |
999 |
Ocorreu um erro inesperado no processamento da mensagem. |
Um erro inesperado, que não foi tratado pelo sistema. |
Retorno do Rawdata |
|---|
<DocCobEngineResponse Version="1.0.0"> <Response> <Code>100</Code> <Description>Fatura de cobrança recepcionada com sucesso</Description> </Response> <Invoice> <Identification>251</Identification> <CarrierCNPJCPF>39213375000175</CarrierCNPJCPF> <CarrierName>Transportador</CarrierName> <BranchCNPJ>41796776000147</BranchCNPJ> <BillingDocument> <Series>2</Series> <Number>22517</Number> </BillingDocument> <Response> <Code>306</Code> <Description>Os seguintes DPS não foram encontrado na fatura informada: Série: 1, Número: 218. </Description> </Response> <Response> <Code>315</Code> <Description>Os seguintes DPS presentes na fatura não foram encontrados na fatura de cobrança enviada: Série: 12, Número: 2031. </Description> </Response> <Response> <Code>311</Code> <Description>O valor líquido informado no arquivo R$200,00 não é igual ao da fatura R$150,00</Description> </Response> <Response> <Code>313</Code> <Description>A data de vencimento informada no arquivo 01/02/2019 é menor do que a data atual</Description> </Response> <Response> <Code>304</Code> <Description>A data de vencimento informada no arquivo 01/02/2019 não é igual à da fatura 30/05/2019</Description> </Response> </Invoice> </DocCobEngineResponse>
|
Códigos Retorno do Corpo da Mensagem |
|---|
Código |
Mensagem |
Situação |
100 |
Fatura de cobrança recepcionada com sucesso |
Fatura foi recepcionada e processada. |
101 |
Fatura de cobrança conciliada com sucesso |
Fatura foi validada e conciliada com sucesso. |
102 |
Fatura de cobrança já foi recepcionada |
Fatura de cobrança já foi recepcionada e será descartada. |
200 |
Identificador do mapeamento não encontrado |
Identificador não cadastrado ou incorreto. |
201 |
Falha na execução do mapeador |
Documento não atende as regras de mapeamento. |
300 |
A fatura está fechada ou cancelada |
Fatura fechadas ou canceladas não podem ser conciliadas. |
301 |
A fatura não possui regra vinculada e não está marcada para recepcionar fatura de cobrança |
Não possui regra vinculada e não está marcada para recepcionar fatura de cobrança. |
302 |
Regra de pagamento não encontrada |
Não existe regra para a filial e transportador informado. |
303 |
A regra de pagamento (Identificador) não está configurado para recepcionar fatura de cobrança |
Regra de pagamento encontrada não recepciona fatura de cobrança. |
304 |
A data de vencimento informada no arquivo (data do arquivo) não é igual à da fatura (data da fatura) |
A data de vencimento não foi encontrada através do dia, mês e ano, ou o valor líquido da fatura não confere com o valor líquido informado no arquivo. |
305 |
O CNPJ/CPF do transportador informado no arquivo (CNPJ/CPF do arquivo) não é igual ao da fatura (CNPJ/CPF da fatura). |
O CNPJ/CPF do transportador ou tomador não são iguais ao da fatura. |
306 |
Os seguintes DPS não foram encontrado na fatura informada: Série: (Série do DPS), Número (Número do DPS). |
Os DPSs informados no arquivo não foram encontrados através da quantidade de DPSs, valor, série ou número. |
307 |
Os seguintes DPS não estão com a situação pagável: Série: (Série do DPS), Número: (Número do DPS). |
Os DPSs informados não foram encontrados através da série, número e CNPJ/CPF do transportador e/ou não se encontram com status de Pagáveis. |
308 |
O valor dos seguintes DPS informados no arquivo não coincidem com o valor encontrado no sistema: Série: (Série do DPS), Número: (Número do DPS). Valor DPS Fatura de Cobrança: (Valor DPS Arquivo). Valor DPS Pré-Fatura: (Valor DPS Pré-Fatura). |
Um ou mais DPSs informados nao possuem o mesmo valor dos DPSs da base de dados. |
309 |
O valor líquido da fatura informado no arquivo (R$ valor) não é o mesmo do valor total dos DPSs (R$ valor) |
A soma do total dos valores dos dps não se equivale ao valor liquido da fatura. |
310 |
Transportador não encontrado |
CNPJ/CPF do transportador informado no arquivo não foi encontrado na base de dados. |
311 |
O valor líquido informado no arquivo (R$ valor) não é igual ao da fatura (R$ valor) |
Valor informado no arquivo não é igual ao da Fatura encontrada na base de dados do nddFrete. |
312 |
O CNPJ/CPF da filial/ponto de operação informado no arquivo (CNPJCPF) não é igual ao da fatura (CNPJCPF) |
Valor informado no arquivo não é igual ao da Fatura encontrada na base de dados do nddFrete. |
313 |
A data de vencimento informada no arquivo (data) é menor do que a data atual |
A data de vencimento informada na fatura de cobrança é menor que a data atual. |
314 |
Já existe fatura de cobrança validada vinculada à pré-fatura 91 |
A pré-fatura informada já possuí uma fatura de cobrança valida a vinculada a ela. |
315 |
Os seguintes DPS presentes na fatura não foram encontrados na fatura de cobrança enviada: Série: (Série do DPS), Número: (Número do DPS). |
DPS contendo na pré-fatura não foram encontrados na fatura de cobrança. |
316 |
A regra de pagamento '{Identificador da regra}' está configurada para enviar pré-fatura, porém nenhuma fatura foi encontrada com o identificador: {Identificador da pré-fatura} |
Fatura não encontrada, mas encontrado regra configurada para enviar a pré-fatura. |