Campo
|
Elem.
|
Pai
|
Tipo
|
Ocor.
|
Tam.
|
Dec.
|
Observação
|
retornoConsultaEventosEfetivacao
|
Raiz
|
|
|
1
|
|
|
|
mensagens
|
Raiz
|
retornoConsultaEventosEfetivacao
|
|
0-1
|
|
|
|
mensagem
|
Raiz
|
mensagens
|
|
1-N
|
|
|
Dados da mensagem de retorno.
|
categoria
|
E
|
mensagemmensagem
|
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.
|
envioConsultaEventosEfetivacao
|
Raiz
|
retornoConsultaEventosEfetivacao
|
|
0-1
|
|
|
Dados da consulta
|
ID
|
A
|
envioConsultaEventosEfetivacao
|
S
|
0-1
|
|
|
GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo.
|
Id
|
A
|
envioConsultaEventosEfetivacao
|
S
|
0-1
|
|
|
GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima.
|
token
|
A
|
envioConsultaEventosEfetivacao
|
S
|
1
|
24
|
|
O token será usado para determinar quais os níveis de permissionamento podem ser aceitos. Por exemplo: determinar um valor limite de operações de transporte por token.
|
cnpjContratante
|
E
|
envioConsultaEventosEfetivacao
|
N
|
1
|
14
|
|
CNPJ do contratante ou do agrupador
|
cnpjEmitente
|
E
|
envioConsultaEventosEfetivacao
|
N
|
0-1
|
14
|
|
CNPJ do emitente
|
GUID
|
E
|
envioConsultaEventosEfetivacao
|
S
|
1
|
|
|
GUID
Deverá ser informado este elemento ou o OT ou o periodo.
|
OT
|
Raiz
|
envioConsultaEventosEfetivacao
|
|
1
|
|
|
Deverá ser informado este elemento ou o GUID ou o periodo
|
ciot
|
E
|
OT
|
N
|
1
|
12
|
|
Número do CIOT
Identificador único a ser associado com a integração. Caso já existe uma integração para este identificador, esta será retornada.
Deverá ser informado este elemento ou o ide
|
ide
|
Raiz
|
OT
|
|
1
|
|
|
Deverá ser informado este elemento ou o ciot
|
serie
|
E
|
ide
|
N
|
1
|
1-4
|
|
Número para a operação de transporte.
|
numero
|
E
|
ide
|
N
|
1
|
1-9
|
|
Número da série para a operação de transporte.
|
periodo
|
Raiz
|
envioConsultaEventosEfetivacao
|
|
1
|
|
|
Intervalo de data para a consulta dos eventos
Deverá ser informado este elemento ou o GUID ou o OT
|
dataInicial
|
E
|
periodo
|
D
|
1
|
|
|
Data inicial
Padrão para a data: AAAA-MM-DD
|
dataFinal
|
E
|
periodo
|
D
|
1
|
|
|
Data Final
Padrão para a data: AAAA-MM-DD
|
retornoConsultaEventosEfetivacao
|
Raiz
|
retornoConsultaEventosEfetivacao
|
|
0-1
|
|
|
|
dataHora
|
E
|
retornoConsultaEventosEfetivacao
|
D
|
1
|
|
|
Data e hora do retorno das informações. Padrão: AAAA-MM-DD HH:MM:SS.
|
operacaoTransporte
|
Raiz
|
retornoConsultaEventosEfetivacao
|
|
1-N
|
|
|
|
ide
|
Raiz
|
operacaoTransporte
|
|
1
|
|
|
Dados da integração da Operação de Transporte.
|
cnpj
|
E
|
ide
|
N
|
1
|
14
|
|
CNPJ da contratante
|
serie
|
E
|
ide
|
N
|
0-1
|
1-4
|
|
Serie da Operação de Transporte
|
numero
|
E
|
ide
|
N
|
0-1
|
1-9
|
|
Número da Operação de Transporte
|
autorizacao
|
Raiz
|
ide
|
|
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
|
parcelas
|
Raiz
|
operacaoTransporte
|
|
1
|
|
|
|
parcela
|
Raiz
|
parcelas
|
|
1-N
|
|
|
|
nome
|
E
|
parcela
|
S
|
1
|
1-50
|
|
Nome para apresentação da parcela dentro do sistema.
|
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.
|
eventos
|
Raiz
|
parcela
|
|
1
|
|
|
|
evento
|
Raiz
|
eventos
|
|
1-N
|
|
|
|
registroPassagem
|
Raiz
|
evento
|
|
1-N
|
|
|
Será retornado este elemento ou o aprovacaoCarga ou o triagemCentro ou o triagemContratante ou o rejeicaoCarga ou o solicitacaoPgtoImediato ou o confirmacaoPgto ou o realizacaoPgto
|
dataHoraRegistroPassagem
|
E
|
registroPassagem
|
D
|
1
|
|
|
Data em que foi realizado o registro de passagem. Padrão: AAAA-MM-DD HH:MM:SS
|
postoCredenciado
|
Raiz
|
registroPassagem
|
|
1
|
|
|
|
cnpj
|
E
|
postoCredenciado
|
N
|
1
|
14
|
|
CNPJ do posto
|
nome
|
E
|
postoCredenciado
|
S
|
1
|
1-150
|
|
Razão social do posto
|
endereco
|
Raiz
|
postoCredenciado
|
|
1
|
|
|
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço
|
carga
|
Raiz
|
registroPassagem
|
|
0-1
|
|
|
|
saida
|
Raiz
|
carga
|
|
1
|
|
|
|
quantidade
|
E
|
saida
|
N
|
1
|
1-5
|
2
|
Quantidade da carga
|
unidadeMedida
|
E
|
saida
|
N
|
1
|
1-20
|
|
Unidade de medida
|
dataPrevisaoEntrega
|
E
|
saida
|
D
|
1
|
|
|
Data prevista para a entrega da carga.
Padrão: AAAA-MM-DD
|
entrega
|
Raiz
|
carga
|
|
1
|
|
|
|
quantidade
|
E
|
entrega
|
N
|
1
|
1-5
|
2
|
Quantidade da carga que foi entregue.
|
unidadeMedida
|
E
|
entrega
|
N
|
1
|
1-20
|
|
Unidade de medida.
|
dataPrevisaoEntrega
|
E
|
entrega
|
D
|
1
|
|
|
Data que a carga foi entregue.
|
comentario
|
E
|
registroPassagem
|
S
|
0-1
|
1-500
|
|
Comentário informado no registro de passagem.
|
triagemCentro
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o aprovacaoCarga ou o triagemContratante ou o rejeicaoCarga ou o solicitacaoPgtoImediato ou o confirmacaoPgto ou o realizacaoPgto
|
dataHoraTriagem
|
E
|
triagemCentro
|
D
|
1
|
|
|
Data e hora da triagem de documentos. Padrão: AAAA-MM-DD HH:MM:SS.
|
localTriagem
|
Raiz
|
triagemCentro
|
|
1
|
|
|
|
cpf
|
E
|
localTriagem
|
N
|
1
|
11
|
|
CPF do triador da parcela.
Será retornado este elemento ou o cnpj
|
cnpj
|
E
|
localTriagem
|
N
|
1
|
14
|
|
CNPJ do triador da parcela.
Será retornado este elemento ou o cpf
|
nome
|
E
|
localTriagem
|
N
|
1
|
1-150
|
|
Nome do triador da parcela.
|
endereco
|
Raiz
|
localTriagem
|
|
1
|
|
|
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço
|
observacao
|
E
|
endereco
|
S
|
0-1
|
1-500
|
|
Observação informada durante a triagem dos documentos.
|
triagemContratante
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o triagemCentro ou o aprovacaoCarga ou o rejeicaoCarga ou o solicitacaoPgtoImediato ou o confirmacaoPgto ou o realizacaoPgto
|
dataHoraTriagem
|
E
|
triagemContratante
|
D
|
1
|
|
|
Data e hora da triagem de documentos. Padrão: AAAA-MM-DD HH:MM:SS.
|
cnpj
|
E
|
triagemContratante
|
N
|
1
|
14
|
|
CNPJ da contratante
|
nome
|
E
|
triagemContratante
|
S
|
1
|
1-150
|
|
Nome do triador da parcela
|
endereco
|
Raiz
|
triagemContratante
|
|
1
|
|
|
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço
|
observacao
|
E
|
triagemContratante
|
S
|
0-1
|
1-500
|
|
Observação informada durante a triagem dos documentos.
|
aprovacaoCarga
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o triagemCentro ou o triagemContratante ou o rejeicaoCarga ou o solicitacaoPgtoImediato ou o confirmacaoPgto ou o realizacaoPgto
|
dataAvaliacao
|
E
|
aprovacaoCarga
|
D
|
1
|
|
|
Data e hora que aprovação foi realizada. Padrão: AAAA-MM-DD HH:MM:SS.
|
confirmadorEletronica
|
Raiz
|
aprovacaoCarga
|
|
1
|
|
|
|
cpf
|
E
|
confirmadorEletronica
|
N
|
1
|
11
|
|
CPF do confirmador de carga
Será retornado este elemento ou o cnpj
|
cnpj
|
E
|
confirmadorEletronica
|
N
|
1
|
14
|
|
CNPJ do confirmador de carga
Será retornado este elemento ou o cpf
|
nome
|
E
|
confirmadorEletronica
|
N
|
1
|
1-150
|
|
Nome do confirmador de carga
|
endereco
|
Raiz
|
confirmadorEletronica
|
|
1
|
|
|
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço
|
rejeicaoCarga
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o triagemCentro ou o triagemContratante ou o aprovacaoCarga ou o solicitacaoPgtoImediato ou o confirmacaoPgto ou o realizacaoPgto
|
dataAvaliacao
|
E
|
rejeicaoCarga
|
D
|
1
|
|
|
Data e hora que aprovação foi realizada. Padrão: AAAA-MM-DD HH:MM:SS.
|
confirmadorEletronica
|
Raiz
|
rejeicaoCarga
|
|
1
|
|
|
|
cpf
|
E
|
confirmadorEletronica
|
N
|
1
|
11
|
|
CPF do confirmador de carga
Será retornado este elemento ou o cnpj
|
cnpj
|
E
|
confirmadorEletronica
|
N
|
1
|
14
|
|
CNPJ do confirmador de carga
Será retornado este elemento ou o cpf
|
nome
|
E
|
confirmadorEletronica
|
N
|
1
|
1-150
|
|
Nome do confirmador de carga
|
endereco
|
Raiz
|
confirmadorEletronica
|
|
1
|
|
|
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço
|
observacao
|
E
|
rejeicaoCarga
|
S
|
0-1
|
1-500
|
|
Observação informada durante a rejeição de carga.
|
solicitacaoPgtoImediato
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o triagemCentro ou o triagemContratante ou o aprovacaoCarga ou o rejeicaoCarga ou o confirmacaoPgto ou o realizacaoPgto
|
dataSolicitacao
|
E
|
solicitacaoPgtoImediato
|
D
|
1
|
|
|
Data e hora que o pagamento imediato foi solicitado. Padrão: AAAA-MM-DD HH:MM:SS.
|
motivo
|
E
|
solicitacaoPgtoImediato
|
S
|
1
|
1-500
|
|
Motivo informado durante a solicitação do pagamento imediato.
|
confirmacaoPgto
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o triagemCentro ou o triagemContratante ou o aprovacaoCarga ou o rejeicaoCarga ou o solicitacaoPgtoImediato ou o realizacaoPgto
|
dataConfirmacao
|
E
|
confirmacaoPgto
|
D
|
1
|
|
|
Data e hora da confirmação do pagamento. Padrão: AAAA-MM-DD HH:MM:SS.
|
observacao
|
E
|
confirmacaoPgto
|
S
|
0-1
|
|
|
Observação
|
realizacaoPgto
|
Raiz
|
evento
|
|
1
|
|
|
Será retornado este elemento ou o registroPassagem ou o triagemCentro ou o triagemContratante ou o aprovacaoCarga ou o rejeicaoCarga ou o solicitacaoPgtoImediato ou o confirmacaoPgto
|
dataPgto
|
E
|
realizacaoPgto
|
D
|
1
|
|
|
Data e hora da solicitação do pagamento.
Padrão: AAAA-MM-DD HH:MM:SS.
|
status
|
E
|
realizacaoPgto
|
S
|
1
|
1
|
|
Status referente ao processamento do pagamento.
0 = Não processado
1 = Processado com sucesso
2 = Processado com falha
|
observacao
|
E
|
realizacaoPgto
|
S
|
0-1
|
1-500
|
|
Observação
|