Retorno de consulta de OT

Top  Previous  Next

 

O arquivo de retorno de resumo OT possui a seguinte nomenclatura:

RetResu_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.xml

Abaixo segue a especificação do arquivo de retorno de Resumo de Operação de Transporte, que será gerado pela solução nddCargo na pasta de integração, após o envio deste através do Agente. Este arquivo contém informações sobre o processamento de resumo de uma Operação de Transporte.

 

Campo

Elem.

Pai

Tipo

Ocor.

Tam.

Dec.

Observação

retornoConsultaResumo

Raiz

 

 

1

 

 

 

mensagens

Raiz

retornoConsultaResumo

 

0-1

 

 

 

mensagem

Raiz

mensagens

 

1-N

 

 

Dados da mensagem de retorno.

categoria

E

mensagem

N

1

3

 

Categoria da mensagem

codigo

E

mensagem

N

1

1-3

 

Código de mensagem de retorno

mensagem

E

mensagem

S

1

1-2000

 

Descrição da mensagem

observacao

E

mensagem

S

0-1

1-2000

 

Observação sobre a mensagem.

Neste campo poderão ser apresentadas informações mais técnicas sobre o que ocorreu no processo.

envioConsultaResumoOT

Raiz

retornoConsultaResumo

 

1

 

 

Dados da consulta        

ID

A

envioConsultaResumoOT

S

0-1

 

 

GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo.

Id

A

envioConsultaResumoOT

S

0-1

 

 

GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima.

cnpj

E

envioConsultaResumoOT

N

1

14

 

CNPJ da Contratante

OT

Raiz

envioConsultaResumoOT

 

1

 

 

Dados da operação

ciot

E

OT

N

1

12

 

Código Identificador da Operação de Transporte.

Deverá ser retornado este elemento ou o ide.

ide

Raiz

OT

 

1

 

 

Deverá ser retornado este elemento ou o ciot.

serie

E

ide

N

1

1-4

 

Número da série para a operação de transporte.

numero

E

ide

N

1

1-9

 

Número para a operação de transporte.

retConsultaResumoOT

Raiz

retornoConsultaResumo

 

0-1

 

 

Dados do retorno da consulta

dataHora

E

retConsultaResumoOT

D

1

 

 

Data e hora do retorno das informações

Formato: AAAA-MM-DD HH:MM:SS

ide

Raiz

retConsultaResumoOT

 

1

 

 

 

cnpj

E

ide

N

1

14

 

CNPJ da Contratante

serie

E

ide

N

1

1-2

 

Número da série para a operação de transporte.

numero

E

ide

N

1

1-9

 

Número para a operação de transporte.

dataEmissao

E

ide

D

1

 

 

Data de emissão da Operação de Transporte.

Formato: AAAA-MM-DD HH:MM:SS

mfParcelas

E

ide

N

1

1

 

Indica se a Operação de Transporte possui ou não Movimentação Financeira de Parcelas

1 = Sim

2 = Não.

mfPedagio

E

ide

N

1

1

 

Indica se a Operação de Transporte possui ou não Movimentação Financeira de Pedágio.

1 = Sim

2 = Não

emAlteracao

E

ide

N

1

1

 

Indica se a Operação de Transporte está em alteração.

1 = Sim

2 = Não

status

E

ide

N

1

1

 

Indica o status da Operação de Transporte.

0 =Vigente

1 = Encerrada

2 = Cancelada

4 = Aguardando Vigência

5 = Aberta

6 = Pendente

7 = Em Contingência

8 = Rejeitada

gestoraCartao

E

ide

N

0-1

3

 

Gestora de cartões

autorizacao

Raiz

OT

 

0-1

 

 

Tipo da Operação

ciot

Raiz

autorizacao

 

1

 

 

Autorização CIOT.

numero

E

ciot

N

1

12

 

Código Identificador da Operação de Transporte

ciotCodVerificador

E

ciot

S

1

4

 

Protocolo de autorização disponibilizado pela ANTT. Será informado XXXX caso seja uma emissão em contingência

avisoTransportador

E

ciot

S

0-1

1-300

 

Aviso ao transportador disponibilizado pela ANTT ou Administradora de meios de pagamento.

valores

Raiz

OT

 

1

 

 

Dados dos valores da operação

vlrFrete

E

valores

N

1

1-15

2

Valor do frete

vlrDespesas

E

valores

N

0-1

1-15

2

Valor de despesas

vlrCombustivel

E

valores

N

0-1

1-15

2

Valor do combustível

vlrSaldo

E

valores

N

1

1-15

2

Valor de saldo da Operação de Transporte

tarifas

Raiz

valores

 

1

 

 

Dados dos valores de Tarifa

quantidadeTotal

E

tarifas

N

1

1-7

 

Quantidae de Tarifas

valorTotal

E

tarifas

N

1

1-9

2

Valor de Tarifa

pedagio

Raiz

OT

 

0-1

 

 

Dados do pedágio

Deverá ser retornado este elemento ou o direcionamentosPedagio

valor

E

pedagio

N

1

1-15

2

Valor do pedágio

totalPago

E

pedagio

N

1

1-15

2

Valor total pago do pedágio

saldoPagar

E

pedagio

N

1

1-15

2

Saldo a pagar do pedágio

origem

E

pedagio

S

0-1

1-200

 

Cidade e estado de origem

destino

E

pedagio

S

0-1

1-200

 

Cidade e estado de destino

direcionamentosPedagio

Raiz

OT

 

0-1

 

 

Deverá ser retornado este elemento ou o pedagio

direcionamento

Raiz

direcionamentosPedagio

 

1-N

 

 

Dados do direcionamento.

pedagioERP

E

direcionamento

S

1

1-30

 

Identificador do direcionamento

cpf

E

direcionamento

N

1

11

 

CPF do condutor

rotaERP

E

direcionamento

S

0-1

1-30

 

Nome da rota

valor

E

direcionamento

N

1

1-15

2

Valor total do pedágio

origem

E

direcionamento

S

1

1-200

 

Cidade de origem

destino

E

direcionamento

S

1

1-200

 

Cidade de destino

status

E

direcionamento

N

1

1

 

Status pagamento.

1 = Aberto

2 = Pago

3 = Cancelado

categoriaPedagio

E

direcionamento

N

1

1-2

 

Categoria de pedágio.

Valores possíveis disponíveis nos anexos desse documento.

pedagiosViaFacil

Raiz

OT

 

0-1

 

 

Dados do pedágio com o Via Fácil

reciboViagem

Raiz

pedagiosViaFacil

 

1-N

 

 

Dados dos recibos do Via Fácil

identificadorViagem

E

reciboViagem

N

1

1-15

 

Identificador do vale pedágio no sistema Via Fácil

tipo

E

reciboViagem

S

1

1-50

 

Tipo do vale pedágio no sistema Via Fácil. Poderá ser:

Flex

Rota Fixa

nomeEmissor

E

reciboViagem

S

1

1-50

 

Nome do emissor (embarcador)

cnpjEmissor

E

reciboViagem

S

1

1-50

 

CNPJ do emissor (embarcador)

nomeTransportador

E

reciboViagem

S

1

1-50

 

Nome do transportador

cnpjTransporador

E

reciboViagem

S

1

1-50

 

CNPJ do transportador

dataCompra

E

reciboViagem

D

1

 

 

Data de compra do Vale Pedágio

(AAAA-MM-DD)

inicioVigencia

E

reciboViagem

D

1

 

 

Data de início de vigência do vale pedágio (AAAA-MM-DD)

fimVigencia

E

reciboViagem

D

1

 

 

Data de fim de vigência do vale pedágio (AAAA-MM-DD)

categoriaVeiculo

E

reciboViagem

S

1

1-50

 

Categoria de pedágio

nomeRota

E

reciboViagem

S

1

1-64

 

Nome da rota

valorTotal

E

reciboViagem

N

1

1-15

2

Valor total do Vale Pedágio

observacao

E

reciboViagem

S

1

1-500

 

Observação.

Mensagem explicativa a ser impressa no rodapé

pracasPedagio

Raiz

reciboViagem

 

1

 

 


praca

Raiz

pracasPedagio

 

1-N

 

 


nomePraca

E

praca

S

1

1-50

 

Nome da praça de pedágio.

nomeRodovia

E

praca

S

1

1-50

 

Nome da rodovia onde se encontra a praça.

nomeConcessionaria

E

praca

S

1

1-50

 

Nome da concessionária onde se encontra a praça.

placaVeiculo

E

praca

S

1

7

 

Placa do veículo que contém a tag do Via Fácil.

tag

E

praca

S

1

1-50

 

Código identificador do tag ViaFácil do veículo.

valorTarifa

E

praca

N

1

1-15

2

Valor da tarifa do pedágio na praça.

parcelas

Raiz

OT

 

0-1

 

 

Dados das parcelas

parcela

Raiz

parcelas

 

1-N

 

 

Dados da parcela

nome

E

parcela

N

1

1-50

 

Nome da Parcela

valorReal

E

parcela

N

1

1-15

2

Deve ser informada quando o valor real é diferente do valor aplicado, neste caso é porque houve descontos nesta parcela. Caso não seja informado, será calculado conforme valor aplicado, distribuição de impostos e descontos.

valorAplicado

E

parcela

N

1

1-15

2

Valor Aplicado

dataPrevisao

E

parcela

D

1

 

 

Data Prevista para o pagamento

Formato: AAAA-MM-DD

dataPagamento

E

parcela

D

0-1

 

 

Data de Efetivação do Pagamento

Formato: AAAA-MM-DD HH:MM:SS

status

E

parcela

N

1

1

 

Indica o status da Parcela.

0 = Em Aberto

1 = Aguardando pagamento

2 = Aguardando solicitação de pagamento

3 = Paga

4 = Cancelada

efetivacao

E

parcela

N

1

1

 

Define o local de efetivação do pagamento da parcela.

1 = Posto credenciado;

2 = Centro de Triagem;

3 = Contratante;

4 = Confirmador;

5 = Pagamento Imediato;

6 = Agendado.

prazoMinimo

E

parcela

N

1

1

 

Define a configuração de prazo mínimo para pagamento.

1 = Não utilizar;

2 = Baseado em dia fixo configurado na contratante;

3 = Baseado em data prevista.

confirmarPgto

E

parcela

N

1

1

 

Define se a contratante precisa ou não confirmar o pagamento da parcela após o evento de efetivação acontecer.

1 = Sim;

2 = Não.

carga

Raiz

parcela

 

0-1

 

 


quantidade

E

carga

N

1

1-7

2

Quantidade da carga.

unidadeMedida

E

carga

S

1

1-20

 

Unidade de medida.

dataPrevisaoEntrega

E

carga

D

1

 

 

Data prevista para a entrega da carga. Padrão: AAAA-MM-DD

transferenciaAutomatica

Raiz

carga

 

0-1

 

 


cpfCondutor

E

transferenciaAutomatica

N

1

11

 

Número do CPF do condutor beneficiado com a transferência automática.

finalidadeParcela

E

transferenciaAutomatica

N

1

1

 

Define a finalidade da parcela para uso na transferência automática.

1 = Adiantamento;

2 = Saldo.

condutores

Raiz

OT

 

0-1

 

 

Dados dos condutores

condutor

Raiz

condutores

 

1-N

 

 

Dados do condutor

cpf

E

condutor

N

1

11

 

CPF do condutor

nome

E

condutor

S

1

1-150

 

Nome do condutor