Campo
|
Elem.
|
Pai
|
Tipo
|
Ocor.
|
Tam.
|
Dec.
|
Observação
|
alterarOT_envio
|
Raiz
|
|
|
1
|
|
|
|
versao
|
A
|
alterarOT_envio
|
S
|
1
|
7
|
|
Versão da integração que está sendo realizada.
|
token
|
A
|
alterarOT_envio
|
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.
|
OT
|
Raiz
|
alterarOT_envio
|
|
1-N
|
|
|
|
infOT
|
Raiz
|
OT
|
|
1
|
|
|
|
ID
|
A
|
infOT
|
S
|
0-1
|
|
|
GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo.
|
Id
|
A
|
infOT
|
S
|
0-1
|
|
|
GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima.
|
cnpj
|
E
|
infOT
|
N
|
1
|
14
|
|
CNPJ da Contratante.
|
autorizacao
|
Raiz
|
infOT
|
|
1
|
|
|
Tipo de operação
|
ciot
|
Raiz
|
autorizacao
|
|
1
|
|
|
Informações sobre a Operação de Transporte
|
numero
|
E
|
ciot
|
N
|
1
|
12
|
|
Código Identificador da Operação de Transporte
|
ciotCodVerificador
|
E
|
ciot
|
S
|
1
|
4
|
|
Protocolo de autorização da Operação de Transporte, disponibilizado pela ANTT.
Informar XXXX caso seja uma emissão em contingência
|
alteracoes
|
Raiz
|
infOT
|
|
1
|
|
|
Dados das alterações da operação de transporte
|
alteracao
|
Raiz
|
alteracoes
|
|
1-N
|
|
|
Dados da alteração.
|
ANTT
|
Raiz
|
alteracao
|
|
1
|
|
|
Dados para alteração na ANTT.
Deverá ser informado este elemento ou o financeiro ou o adicionais ou o semMF ou o condutor
|
padrao
|
Raiz
|
ANTT
|
|
1
|
|
|
Dados para alteração na ANTT de OT do tipo padrão.
Deverá ser informado este elemento ou o TACagregado.
|
ate24hrs
|
Raiz
|
padrao
|
|
1
|
|
|
Alteração de campos que podem ser alterados até 24 horas da data de início das operações de transporte padrão.
Deverá ser informado este elemento ou o depois24hrs.
|
validade
|
Raiz
|
ate24hrs
|
|
0-1
|
|
|
Dados que identificam o período de validade da operação de transporte.
|
dtInicio
|
E
|
validade
|
D
|
1
|
|
|
Data em que a Operação de Transporte começa a ter validade.
Formato: AAAA-MM-DD
|
dtFim
|
E
|
validade
|
D
|
1
|
|
|
Data de término da Operação de Transporte.
Formato: AAAA-MM-DD
|
carga
|
Raiz
|
ate24hrs
|
|
0-1
|
|
|
Dados que identificam a carga da operação de transporte.
|
codigoSH
|
E
|
carga
|
N
|
1
|
4
|
|
Natureza da carga, conforme a tabela de códigos do Sistema Harmonizado de Designação e de Codificação de Mercadorias.
|
quantidade
|
E
|
carga
|
N
|
1
|
1-9
|
2
|
Quantidade de carga na unidade de medida Kg.
|
veiculos
|
Raiz
|
ate24hrs
|
|
0-1
|
|
|
Dados dos veículos para alteração.
|
veiculo
|
Raiz
|
veiculos
|
|
1-5
|
|
|
Dados do veículo.
|
placa
|
E
|
veiculo
|
S
|
1
|
7
|
|
Placa do veículo.
|
informacoes
|
Raiz
|
veiculo
|
|
0-1
|
|
|
Dados do veículo para cadastro.
|
modelo
|
E
|
informacoes
|
S
|
1
|
1-100
|
|
Modelo do veículo.
|
kmLitroModelo
|
E
|
informacoes
|
N
|
0-1
|
1-4
|
2
|
KM por litro do modelo.
|
tipo
|
E
|
informacoes
|
N
|
1
|
1
|
|
Tipo do veículo:
1 = Tração
2 = Reboque
|
kmLitroVeiculo
|
E
|
informacoes
|
N
|
0-1
|
1-4
|
2
|
KM por litro do veículo.
|
RNTRCTransportador
|
E
|
informacoes
|
N
|
1
|
9
|
|
RNTRC do transportador responsável pelo veículo, na ANTT.
|
categoriaPedagio
|
E
|
ate24hrs
|
N
|
0-1
|
1-2
|
|
Categoria de pedágio.
Valores possíveis disponíveis nos anexos.
|
rota
|
Raiz
|
ate24hrs
|
|
0-1
|
|
|
Dados da rota a ser utilizada no transporte.
|
rotaERP
|
E
|
rota
|
S
|
1
|
1-30
|
|
Nome da rota no ERP para a integração.
|
informacoes
|
Raiz
|
rota
|
|
0-1
|
|
|
Dados para inserção de uma rota no sistema ou atualização de uma já existente.
|
nome
|
E
|
informacoes
|
S
|
1
|
1-50
|
|
Nome de apresentação da rota dentro do sistema.
|
tipoRotaPadrao
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Define o tipo de rota padrão a ser utilizado nos pontos de parada.
1 = Rápida
2 = Curta
|
pontosParada
|
Raiz
|
informacoes
|
|
1
|
|
|
Dados dos pontos da parada da rota.
|
pontoParada
|
Raiz
|
pontosParada
|
|
2-N
|
|
|
Dados do ponto de parada.
|
codigoIBGE
|
E
|
pontoParada
|
N
|
1
|
7
|
|
Código IBGE do ponto de parada
Deverá ser informado este elemento ou o cep.
|
cep
|
E
|
pontoParada
|
N
|
1
|
8
|
|
CEP do ponto de parada
Deverá ser informado este elemento ou o codigoIBGE.
|
tipoRotaEspecifico
|
E
|
pontoParada
|
N
|
0-1
|
1
|
|
Tipo de rota específico para o ponto de parada em relação ao ponto anterior.
1 = Rápida
2 = Curta
|
responsaveis
|
Raiz
|
informacoes
|
|
0-1
|
|
|
Dados dos responsáveis pela rota.
|
responsavel
|
Raiz
|
responsaveis
|
|
1-N
|
|
|
Dados do responsável.
|
nome
|
E
|
responsavel
|
S
|
1
|
1-50
|
|
Nome do responsável pela rota na Contratante.
|
email
|
E
|
responsavel
|
S
|
1
|
1-255
|
|
E-mail do responsável pela rota na Contratante. Em caso de alterações na rota, o aviso será encaminhado para este e-mail.
|
utilizarRoteirizador
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Possibilita a utilização do roteirizador para calcular a distância e valores de pedágio. Quando informado 1 os dados da praça de pedágio irá para a ANTT automaticamente, quando informado 2 para que seja enviado para ANTT deve informar o código CNP (Código Nacional da Praça), caso seja 2 e não informe o CNP não será enviado os dados de pedágio para a ANTT.
1 = Sim
2 = Não
|
totalKm
|
E
|
informacoes
|
N
|
0-1
|
1-15
|
2
|
Total de quilômetros da rota.
|
notificarRespContratante
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Define a notificação para os responsáveis na Contratante, caso o roteirizador identifique alterações na rota.
1 = Sim
2 = Não
|
pedagios
|
Raiz
|
informacoes
|
|
0-1
|
|
|
|
pedagio
|
Raiz
|
pedagios
|
|
1-N
|
|
|
Dados das praças de pedágio da rota
|
cnp
|
E
|
pedagio
|
N
|
1
|
1-17
|
|
Código Nacional da Praça de Pedágio.
|
nomePraca
|
E
|
pedagio
|
S
|
1
|
1-255
|
|
Nome da Praça de Pedágio.
|
valorPraca
|
E
|
pedagio
|
N
|
1
|
1-15
|
2
|
Valor da Praça de Pedágio.
|
tarifas
|
Raiz
|
ate24hrs
|
|
1
|
|
|
Campos contendo dados de tarifas
|
quantidadeTotal
|
E
|
tarifas
|
N
|
1
|
1-7
|
|
Quantidade total de tarifas.
|
depois24hrs
|
Raiz
|
padrao
|
|
1
|
|
|
Alterações de campos que podem ser alterados depois de 24 horas da data de início das operações de transporte padrão.
Deverá ser informado este elemento ou o ate24hrs.
|
veiculos
|
Raiz
|
depois24hrs
|
|
0-1
|
|
|
Dados dos veículos para alteração.
|
veiculo
|
Raiz
|
veiculos
|
|
1-5
|
|
|
Dados do veículo.
|
placa
|
E
|
veiculo
|
S
|
1
|
7
|
|
Placa do veículo.
|
informacoes
|
Raiz
|
veiculo
|
|
0-1
|
|
|
Dados do veículo para cadastro.
|
modelo
|
E
|
informacoes
|
S
|
1
|
1-100
|
|
Modelo do veículo.
|
kmLitroModelo
|
E
|
informacoes
|
N
|
0-1
|
1-4
|
2
|
KM por litro do modelo.
|
tipo
|
E
|
informacoes
|
N
|
1
|
1
|
|
Tipo do veículo:
1 = Tração
2 = Reboque
|
kmLitroVeiculo
|
E
|
informacoes
|
N
|
0-1
|
1-4
|
2
|
KM por litro do veículo.
|
RNTRCTransportador
|
E
|
informacoes
|
N
|
1
|
9
|
|
RNTRC do transportador responsável pelo veículo, na ANTT
|
categoriaPedagio
|
E
|
depois24hrs
|
N
|
0-1
|
1-2
|
|
Categoria de pedágio.
Valores possíveis disponíveis nos anexos.
|
TACagregado
|
Raiz
|
ANTT
|
|
1
|
|
|
Dados para alteração na ANTT de OT do tipo TAC-Agregado. Até 72 horas após a data de término.
Deverá ser informado este elemento ou o padrao.
|
veiculos
|
Raiz
|
TACagregado
|
|
0-1
|
|
|
Dados dos veículos para alteração
|
veiculo
|
Raiz
|
veiculos
|
|
1-5
|
|
|
Dados do veículo.
|
placa
|
E
|
veiculo
|
S
|
1
|
7
|
|
Placa do veículo.
|
informacoes
|
Raiz
|
veiculo
|
|
0-1
|
|
|
Dados do veículo para cadastro.
|
modelo
|
E
|
informacoes
|
S
|
1
|
1-100
|
|
Modelo do veículo
|
kmLitroModelo
|
E
|
informacoes
|
N
|
0-1
|
1-4
|
2
|
KM por litro do modelo
|
tipo
|
E
|
informacoes
|
N
|
1
|
1
|
|
Tipo do veículo:
1 = Tração
2 = Reboque
|
kmLitroVeiculo
|
E
|
informacoes
|
N
|
0-1
|
1-4
|
2
|
KM por litro do veículo
|
RNTRCTransportador
|
E
|
informacoes
|
N
|
1
|
9
|
|
RNTRC do transportador responsável pelo veículo, na ANTT
|
categoriaPedagio
|
E
|
TACagregado
|
N
|
0-1
|
1-2
|
|
Categoria de pedágio.
Valores possíveis disponíveis nos anexos.
|
tarifas
|
Raiz
|
TACagregado
|
|
0-1
|
|
|
Campos contendo dados de tarifas
|
quantidadeTotal
|
E
|
tarifas
|
N
|
1
|
1-7
|
|
Quantidade total de tarifas.
|
financeiro
|
Raiz
|
alteracao
|
|
1
|
|
|
Dados para alteração financeira na operação de transporte.
Deverá ser informado este elemento ou o ANTT ou o adicionais ou o semMF ou o condutor
|
novaParc
|
Raiz
|
financeiro
|
|
1
|
|
|
Dados para adição de uma nova parcela.
Deverá ser informado este elemento ou o ajustaParc ou o pedagio.
|
nome
|
E
|
novaParc
|
S
|
1
|
1-50
|
|
Nome da parcela para apresentação no nddCargo.
|
tipoPgto
|
Raiz
|
novaParc
|
|
1
|
|
|
Identificação do tipo do pagamento.
|
manual
|
Raiz
|
tipoPgto
|
|
1
|
|
|
Dados para parcela manual.
Deverá ser informado este elemento ou o automatico ou imediato.
|
dataPrevisao
|
E
|
manual
|
D
|
1
|
|
|
Data prevista para o pagamento da parcela, no formato: AAAA-MM-DD.
|
efetivacao
|
E
|
manual
|
N
|
0-1
|
1-1
|
|
Define o local de efetivação do pagamento.
1 = Posto credenciado
2 = Centro de triagem
3 = Contratante
4 = Confirmação eletrônica
|
cnpjPostoCredenciado
|
E
|
manual
|
N
|
0-1
|
14
|
|
Indica o posto credenciado autorizado a fazer o registro de passagem da parcela.
|
automatico
|
Raiz
|
tipoPgto
|
|
1
|
|
|
Dados para parcela automática.
Deverá ser informado este elemento ou o manual ou imediato.
|
dataHora
|
E
|
automatico
|
D
|
1
|
|
|
Data e hora para o pagamento da parcela, no formato: AAAA-MM-DD HH:MM:SS
|
imediato
|
E
|
tipoPgto
|
N
|
1
|
1
|
|
Caso o pagamento da parcela seja do tipo imediato informe o número 2.
Deverá ser informado este elemento ou o manual ou automatico.
|
valorAplicado
|
E
|
novaParc
|
N
|
1
|
1-15
|
2
|
Valor aplicado da parcela, não levando em consideração os descontos.
|
valorReal
|
E
|
novaParc
|
N
|
0-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.
|
documentos
|
Raiz
|
novaParc
|
|
0-1
|
|
|
Dados dos documentos da parcela.
|
documento
|
Raiz
|
documentos
|
|
1-N
|
|
|
Dados do documento.
|
tipo
|
E
|
documento
|
S
|
1
|
1-255
|
|
Tipo do documento.
|
obrigatorio
|
E
|
documento
|
N
|
0-1
|
1
|
|
Indica se há a obrigatoriedade de entrega do documento na coleta.
1 = Sim
2 = Não
|
dependencias
|
Raiz
|
documento
|
|
1
|
|
|
Dados da dependência do documento.
|
dependencia
|
Raiz
|
dependencias
|
|
1-N
|
|
|
Dados da dependência.
|
descricao
|
E
|
dependencia
|
S
|
1
|
1-255
|
|
Descrição da dependência.
|
descontos
|
Raiz
|
novaParc
|
|
0-1
|
|
|
Dados dos descontos da parcela.
|
desconto
|
Raiz
|
descontos
|
|
1-N
|
|
|
Dados do desconto.
|
nmDesc
|
E
|
desconto
|
S
|
1
|
1-50
|
|
Nome do desconto.
|
vlrDesc
|
E
|
desconto
|
S
|
0-1
|
1-15
|
2
|
Valor do desconto, quando retido na fonte.
|
dsDesc
|
E
|
desconto
|
S
|
0-1
|
1-255
|
|
Informações adicionais do desconto.
|
restricoes
|
Raiz
|
novaParc
|
|
0-1
|
|
|
Lista de restrições para que o pagamento seja realizado.
|
restricao
|
Raiz
|
restricoes
|
|
1-N
|
|
|
Dados da restrição.
|
campo
|
E
|
restricao
|
N
|
1
|
1
|
|
Campo para comparação na restrição:
1 = CNPJ do posto credenciado
2 = Data
|
valor
|
E
|
restricao
|
S
|
1
|
1-15
|
|
Valor para comparação respeitando o critério.
|
criterio
|
E
|
restricao
|
N
|
0-1
|
1
|
|
Critérios para restrição:
1 = Igual
2 = Diferente
3 = Maior
4 = Maior ou igual
5 = Menor
6 = Menor ou igual
|
conector
|
E
|
restricao
|
N
|
0-1
|
1
|
|
Conector de comparação em relação ao campo anterior.
1 = E
2 = OU
|
retencoes
|
Raiz
|
novaParc
|
|
0-1
|
|
|
Dados das retenções de impostos.
|
irrf
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de IRRF.
Mesmo que o valor seja zero este campo deve ser preenchido
|
inss
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de INSS.
Mesmo que o valor seja zero este campo deve ser preenchido
|
sestsenat
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de SEST/SENAT
Mesmo que o valor seja zero este campo deve ser preenchido
|
rubrica
|
E
|
retencoes
|
N
|
1
|
1
|
|
Rubrica a qual o valor se refere.
1 = Frete
2 = Combustível
3 = Despesa
|
prazoMinimo
|
E
|
novaParc
|
N
|
0-1
|
1
|
|
Prazo mínimo de pagamento.
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.
Se não for informada, por padrão será configurada a parcela para não utilizar.
|
carga
|
Raiz
|
novaParc
|
|
0-1
|
|
|
Campos contendo os dados de carga da parcela.
|
quantidade
|
E
|
carga
|
N
|
1
|
1-9
|
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
|
confirmarPgto
|
E
|
novaParc
|
N
|
0-1
|
|
|
Confirmação de pagamento
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.
Por padrão, a contratante não vai confirmar o pagamento.
|
transferenciaAutomatica
|
Raiz
|
novaParc
|
|
0-1
|
|
|
Campos contendo os dados de configuração da transferência automática para condutores.
|
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.
|
ajustaParc
|
Raiz
|
financeiro
|
|
1
|
|
|
Dados para ajuste de uma parcela existente.
Deverá ser informado este elemento ou o novaParc ou o pedagio.
|
nome
|
E
|
ajustaParc
|
S
|
1
|
1-50
|
|
Nome da parcela a ser alterada
|
altData
|
Raiz
|
ajustaParc
|
|
1
|
|
|
Dados para alteração de data da parcela.
Deverá ser informado este elemento ou o altValores, prazoMinimo, carga, confirmarPgto, transferenciaAutomatica ou dadosBancarios.
|
data
|
E
|
altData
|
D
|
1
|
|
|
Data e hora de pagamento.
Se o pagamento for do tipo automático, o agendamento será alterado para a data informada. Se for do tipo manual, a data prevista de pagamento será alterada para a data informada.
Formato: AAAA-MM-DD HH:MM:SS
|
altValores
|
Raiz
|
ajustaParc
|
|
1
|
|
|
Dados para manipulação de valores da parcela.
Deverá ser informado este elemento ou o altData, prazoMinimo, carga, confirmarPgto, transferenciaAutomatica ou dadosBancarios.
|
adicional
|
Raiz
|
altValores
|
|
1
|
|
|
Dados para adicionar valor em uma parcela.
Deverá ser informado este elemento ou o desconto ou o retencoes ou o descontoRetencoes.
|
valor
|
E
|
adicional
|
N
|
1
|
1-15
|
2
|
Valor a ser acrescido na parcela
|
rubrica
|
E
|
adicional
|
N
|
1
|
1
|
|
Determinar qual a rubrica o valor deve ser adicionado. 1 = Frete, 2 = Combustível, 3 = Despesa e 4 = Valor de Tarifa
|
desconto
|
Raiz
|
altValores
|
|
1
|
|
|
Dados para descontar valor em uma parcela.
Deverá ser informado este elemento ou o adicional ou o retencoes ou o descontoRetencoes.
|
nmDesc
|
E
|
desconto
|
S
|
1
|
1-50
|
|
Nome do desconto.
|
vlrDesc
|
E
|
desconto
|
S
|
0-1
|
1-15
|
2
|
Valor do desconto, quando retido na fonte.
|
dsDesc
|
E
|
desconto
|
S
|
0-1
|
1-255
|
|
Informações adicionais do desconto.
|
rubrica
|
E
|
desconto
|
N
|
0-1
|
1
|
|
Determinar qual a rubrica o valor deve ser adicionado. 1 = Frete, 2 = Combustível, 3 = Despesa e 4 = Valor de Tarifa
|
retencoes
|
Raiz
|
altValores
|
|
1
|
|
|
Dados das retenções de impostos em uma parcela.
Deverá ser informado este elemento ou o adicional ou o desconto ou o descontoRetencoes.
|
irrf
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de IRRF.
Mesmo que o valor seja zero este campo deve ser preenchido
|
inss
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de INSS.
Mesmo que o valor seja zero este campo deve ser preenchido
|
sestsenat
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de SEST/SENAT
Mesmo que o valor seja zero este campo deve ser preenchido
|
descontoRetencoes
|
Raiz
|
altValores
|
|
1
|
|
|
Dados de desconto de impostos em uma parcela.
Deverá ser informado este elemento ou o adicional ou o desconto ou o retencoes.
|
irrf
|
E
|
descontoRetencoes
|
N
|
1
|
1-15
|
2
|
Retenção de IRRF.
Mesmo que o valor seja zero este campo deve ser preenchido
|
inss
|
E
|
descontoRetencoes
|
N
|
1
|
1-15
|
2
|
Retenção de INSS.
Mesmo que o valor seja zero este campo deve ser preenchido
|
sestsenat
|
E
|
descontoRetencoes
|
N
|
1
|
1-15
|
2
|
Retenção de SEST/SENAT
Mesmo que o valor seja zero este campo deve ser preenchido
|
valorValidacao
|
E
|
altValores
|
N
|
0-1
|
1-15
|
2
|
Valor de validação
Informar o valor que será usado para a validação do ajuste. Se o ajuste for referente as rubricas, deve ser informado o valor total da OT (frete + combustível + despesas). Caso seja referente aos impostos, deve ser informado o valor total de impostos na OT (IRRF + INSS + SEST/SENAT).
|
prazoMinimo
|
E
|
ajustaParc
|
N
|
0-1
|
1
|
|
Prazo mínimo de pagamento.
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.
Se não for informada, por padrão será configurada a parcela para não utilizar.
Deverá ser informado este elemento ou o altData, altValores, carga, confirmarPgto ou transferenciaAutomatica.
|
carga
|
Raiz
|
ajustaParc
|
|
0-1
|
|
|
Campos contendo os dados de carga da parcela
Deverá ser informado este elemento ou o altData, altValores, prazoMinimo, confirmarPgto, transferenciaAutomatica ou dadosBancarios.
|
quantidade
|
E
|
carga
|
N
|
1
|
1-9
|
2
|
Quantidade da carga.
|
unidadeMedida
|
E
|
carga
|
S
|
0-1
|
1-20
|
|
Unidade de medida.
|
dataPrevisaoEntrega
|
E
|
carga
|
D
|
0-1
|
|
|
Data prevista para a entrega da carga. Padrão: AAAA-MM-DD
|
confirmarPgto
|
E
|
ajustaParc
|
N
|
0-1
|
|
|
Confirmação de pagamento
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.
Por padrão, a contratante não vai confirmar o pagamento.
Deverá ser informado este elemento ou o altData, altValores, prazoMinimo, carga, transferenciaAutomatica ou dadosBancarios.
|
transferenciaAutomatica
|
Raiz
|
ajustaParc
|
|
1
|
|
|
Campos contendo os dados de configuração da transferência automática para condutores
Deverá ser informado este elemento ou o altData, altValores, prazoMinimo, carga, confirmarPgto ou dadosBancarios.
|
novaConfiguracao
|
Raiz
|
transferenciaAutomatica
|
|
1
|
|
|
Define nova configuração de transferência automatica para a parcela. Se a parcela já tiver configuração, será substituída.
|
cpfCondutor
|
E
|
novaConfiguracao
|
N
|
1
|
11
|
|
Número do CPF do condutor beneficiado com a transferência automática.
|
finalidadeParcela
|
E
|
novaConfiguracao
|
N
|
1
|
1
|
|
Define a finalidade da parcela para uso na transferência automática.
1 = Adiantamento;
2 = Saldo.
|
removerConfiguracao
|
Raiz
|
transferenciaAutomatica
|
|
1
|
|
|
Remover a configuração da parcela para usar a transferência automatica.
|
cpfCondutor
|
E
|
removerConfiguracao
|
N
|
1
|
11
|
|
Número do CPF do condutor beneficiado com a transferência automática.
|
dadosBancarios
|
Raiz
|
ajustaParc
|
|
1
|
|
|
Elemento requerido quando for necessário realizar a alteração da chave Pix.
Deverá ser informado este elemento ou o altData, altValores, prazoMinimo, carga, confirmarPgto ou transferenciaAutomatica.
|
codigoInstituicaoFinanceira
|
E
|
dadosBancarios
|
N
|
1
|
1-3
|
|
Exemplo: 001 Referente ao Banco do Brasil, 104 Referente a Caixa Econômico Federal.
|
numeroAgencia
|
E
|
dadosBancarios
|
S
|
0-1
|
1-6
|
|
Informe o número e o digito da agência.
Informar 0 no lugar de X.
|
numeroConta
|
E
|
dadosBancarios
|
S
|
0-1
|
1-20
|
|
Informe o número da conta.
Informar 0 no lugar de X.
|
digitoConta
|
E
|
dadosBancarios
|
N
|
0-1
|
1
|
|
Informe o dígito da conta.
Informar 0 no lugar de X.
|
chavePix
|
E
|
dadosBancarios
|
S
|
0-1
|
1-64
|
|
Informe a chave Pix.
|
tipoChave
|
E
|
dadosBancarios
|
N
|
0-1
|
1
|
|
Informe o tipo da Chave:
1 = Email;
2 = Cpf/Cnpj;
3 = Telefone;
4 = Aleatorio;
5 = Dados Bancários.
|
pedagio
|
Raiz
|
financeiro
|
|
1
|
|
|
Dados para alterar o valor do pedágio diretamente ou manipulando direcionamentos.
Deverá ser informado este elemento ou o novaParc ou o ajustaParc.
|
valor
|
E
|
pedagio
|
N
|
1
|
1-15
|
2
|
Valor do pedágio. Deverá ser informado este elemento ou o finalidadeParcela ou notificarRespContratante.
|
direcionamento
|
Raiz
|
pedagio
|
|
1
|
|
|
Dados para manipular os direcionamentos.
Deverá ser informado este elemento ou o valor ou pedagioViaFacil.
|
adicionar
|
Raiz
|
direcionamento
|
|
1
|
|
|
Dados para adicionar um novo direcionamento.
Deverá ser informado este elemento ou o remover.
|
pedagioERP
|
E
|
adicionar
|
S
|
1
|
1-30
|
|
Identificador do direcionamento.
|
cpf
|
E
|
adicionar
|
N
|
1
|
11
|
|
CPF do condutor.
|
valor
|
E
|
adicionar
|
N
|
0-1
|
1-15
|
2
|
Valor do pedágio para o condutor.
Caso utilizado o cálculo através do roteirizador, este campo não deve ser informado.
|
rota
|
Raiz
|
adicionar
|
|
1
|
|
|
Informações da rota para direcionamento de pedágio
|
rotaERP
|
E
|
rota
|
S
|
1
|
1-30
|
|
Nome da rota no ERP para a integração.
|
informacoes
|
Raiz
|
rota
|
|
0-1
|
|
|
Dados para inserção de uma rota no sistema ou atualização de uma já existente.
|
nome
|
E
|
informacoes
|
S
|
1
|
1-50
|
|
Nome de apresentação da rota dentro do sistema.
|
tipoRotaPadrao
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Define o tipo de rota padrão a ser utilizado nos pontos de parada.
1 = Rápida
2 = Curta
|
pontosParada
|
Raiz
|
informacoes
|
|
1
|
|
|
Dados dos pontos da parada da rota.
|
pontoParada
|
Raiz
|
pontosParada
|
|
2-N
|
|
|
Dados do ponto de parada.
|
codigoIBGE
|
E
|
pontoParada
|
N
|
1
|
7
|
|
Código IBGE do ponto de parada.
Deverá ser informado este elemento ou o cep.
|
cep
|
E
|
pontoParada
|
N
|
1
|
8
|
|
CEP do ponto de parada.
Deverá ser informado este elemento ou o codigoIBGE.
|
tipoRotaEspecifico
|
E
|
pontoParada
|
N
|
0-1
|
1
|
|
Tipo de rota específico para o ponto de parada em relação ao ponto anterior.
1 = Rápida
2 = Curta
|
responsaveis
|
Raiz
|
informacoes
|
|
0-1
|
|
|
Dados dos responsáveis pela rota.
|
responsavel
|
Raiz
|
responsaveis
|
|
1-N
|
|
|
Dados do responsável.
|
nome
|
E
|
responsavel
|
S
|
1-1
|
1-50
|
|
Nome do responsável pela rota na Contratante.
|
email
|
E
|
responsavel
|
S
|
1
|
1-255
|
|
E-mail do responsável pela rota na Contratante. Em caso de alterações na rota, o aviso será encaminhado para este e-mail.
|
utilizarRoteirizador
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Possibilita a utilização do roteirizador para calcular a distância e valores de pedágio. Quando informado 1 os dados da praça de pedágio irá para a ANTT automaticamente, quando informado 2 para que seja enviado para ANTT deve informar o código CNP (Código Nacional da Praça), caso seja 2 e não informe o CNP não será enviado os dados de pedágio para a ANTT.
1 = Sim
2 = Não
|
totalKm
|
E
|
informacoes
|
N
|
0-1
|
1-15
|
2
|
Total de quilômetros da rota.
|
notificarRespContratante
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Define a notificação para os responsáveis na Contratante, caso o roteirizador identifique alterações na rota.
1 = Sim
2 = Não
|
pedagios
|
Raiz
|
informacoes
|
|
0-1
|
|
|
|
pedagio
|
Raiz
|
pedagios
|
|
1-N
|
|
|
Dados das praças de pedágio da rota
|
cnp
|
E
|
pedagio
|
N
|
1
|
1-17
|
|
Código Nacional da Praça de Pedágio.
|
nomePraca
|
E
|
pedagio
|
S
|
1
|
1-255
|
|
Nome da Praça de Pedágio.
|
valorPraca
|
E
|
pedagio
|
N
|
1
|
1-15
|
2
|
Valor da Praça de Pedágio.
|
categoriaPedagio
|
E
|
adicionar
|
N
|
1
|
1-2
|
|
Categoria de pedágio.
Valores possíveis disponíveis nos anexos.
|
remover
|
Raiz
|
direcionamento
|
|
1
|
|
|
Informações para remoção do direcionamento de pedágio.
Deverá ser informado este elemento ou o adicionar.
|
pedagioERP
|
E
|
remover
|
S
|
1
|
1-30
|
|
Identificador do direcionamento.
|
cpf
|
E
|
remover
|
N
|
1
|
11
|
|
CPF do condutor.
|
pedagioViaFacil
|
Raiz
|
pedagio
|
|
1
|
|
|
Dados de pedágio com o Via Fácil. Deverá ser informado este elemento ou o pedagio ou direcionamento.
|
compra
|
Raiz
|
pedagioViaFacil
|
|
1
|
|
|
Dados para compra de pedágio com o Via Fácil
Deverá ser informado este elemento ou o reemissao ou o cancelamento.
|
nomeRota
|
E
|
compra
|
S
|
1
|
1-64
|
|
Nome da rota cadastrada no sistema Via Fácil.
|
placaVeiculo
|
E
|
compra
|
S
|
1
|
7
|
|
Placa do veículo que contém a tag do Via Fácil.
|
numeroEixos
|
E
|
compra
|
N
|
1
|
2
|
|
Número de eixos.
|
inicioVigencia
|
E
|
compra
|
D
|
1
|
|
|
Data de início de vigência do vale pedágio
(AAAA-MM-DD)
|
fimVigencia
|
E
|
compra
|
D
|
1
|
|
|
Data de fim de vigência do vale pedágio
(AAAA-MM-DD)
|
itemFin1
|
E
|
compra
|
S
|
0-1
|
1-50
|
|
Item Financeiro 1
Campo de texto livre
|
itemFin2
|
E
|
compra
|
S
|
1
|
1-50
|
|
Item Financeiro 2
Campo de texto livre. O valor deste campo deve ser único por viagem da Contratante
|
reemissao
|
Raiz
|
pedagioViaFacil
|
|
1
|
|
|
Dados para reemissão de pedágio com o Via Fácil
Deverá ser informado este elemento ou o compra ou o cancelamento.
|
identificadorViagem
|
E
|
reemissao
|
N
|
1
|
1-15
|
|
Identificador do vale pedágio no sistema Via Fácil
|
novaPlacaVeiculo
|
E
|
reemissao
|
S
|
1
|
7
|
|
Placa do novo veículo que contém a tag do Via Fácil
|
pracasPedagio
|
E
|
reemissao
|
S
|
1
|
1-N
|
|
Formato 99-999-99... Lista de praças de pedágio que deverão ser trocadas para o novo veículo. Deve-se informar a ordem das praças conforme no recibo de viagem. Apenas praças sem passagem reconhecida serão reemitidas. A primeira praça é o número 1 e assim sucessivamente.
|
cancelamento
|
Raiz
|
pedagioViaFacil
|
|
1
|
|
|
Dados para cancelamento de pedágio com o Via Fácil
Deverá ser informado este elemento ou o compra ou o reemissao.
|
identificadorViagem
|
E
|
cancelamento
|
N
|
1
|
1-15
|
|
Identificador do vale pedágio no sistema Via Fácil
|
adicionais
|
Raiz
|
alteracao
|
|
1
|
|
|
Dados adicionais para uso na impressão.
Deverá ser informado este elemento ou o ANTT ou o financeiro ou o semMF ou o condutor.
|
campo
|
Raiz
|
adicionais
|
|
1-N
|
|
|
Dados do adicional de impressão.
|
nome
|
E
|
campo
|
S
|
1
|
1-255
|
|
Nome do campo.
|
valor
|
E
|
campo
|
S
|
1
|
1-2000
|
|
Valor do campo, formatado.
|
semMF
|
Raiz
|
alteracao
|
|
1
|
|
|
Dados para alterar operação de transporte sem movimentação financeira.
Deverá ser informado este elemento ou o ANTT ou o financeiro ou o adicionais ou o condutor.
|
valores
|
Raiz
|
semMF
|
|
1
|
|
|
Dados para alteração de valores da operação de transporte sem movimentação financeira.
|
vlrFrete
|
E
|
valores
|
N
|
0-1
|
1-15
|
2
|
Valor do frete.
|
despesas
|
Raiz
|
valores
|
|
0-1
|
|
|
Dados das despesas.
|
vlrDespesas
|
E
|
despesas
|
N
|
1
|
1-15
|
2
|
Valor total das despesas.
|
descricao
|
E
|
despesas
|
S
|
1
|
1-2000
|
|
Descrição das despesas
|
retencoes
|
Raiz
|
valores
|
|
0-1
|
|
|
Dados das retenções de impostos da operação de transporte.
|
irrf
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de IRRF.
Mesmo que o valor seja zero este campo deve ser preenchido
|
inss
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de INSS.
Mesmo que o valor seja zero este campo deve ser preenchido
|
sestsenat
|
E
|
retencoes
|
N
|
1
|
1-15
|
2
|
Retenção de SEST/SENAT
Mesmo que o valor seja zero este campo deve ser preenchido
|
vlrCombustivel
|
E
|
valores
|
N
|
0-1
|
1-15
|
2
|
Valor do combustível.
|
vlrPedagio
|
E
|
valores
|
N
|
0-1
|
1-15
|
2
|
Valor do pedágio.
|
desconto
|
Raiz
|
valores
|
|
0-1
|
|
|
Dados do desconto.
|
nmDesc
|
E
|
desconto
|
S
|
1
|
1-50
|
|
Nome do desconto
|
vlrDesc
|
E
|
desconto
|
S
|
1
|
1-15
|
2
|
Valor do desconto, quando retido na fonte.
|
rubrica
|
E
|
desconto
|
N
|
1
|
1
|
|
Determinar qual a rubrica o valor deve ser adicionado. 1 = Frete, 2 = Combustível, 3 = Despesa e 4 = Valor de Tarifa
|
dsDesc
|
E
|
desconto
|
S
|
0-1
|
1-255
|
|
Informações adicionais do desconto
|
tarifas
|
Raiz
|
valores
|
|
0-1
|
|
|
Campos contendo dados de tarifas
|
quantidadeTotal
|
E
|
tarifas
|
N
|
1
|
1-7
|
|
Quantidade total de tarifas
|
valorTotal
|
E
|
tarifas
|
N
|
1
|
1-10
|
2
|
Este valor é participante do valor total da operação de transporte a ser paga ao transportador.
|
condutor
|
Raiz
|
alteracao
|
|
1
|
|
|
Alteração do(s) condutor(es) da Operação de Transporte
Deverá ser informado este elemento ou o ANTT ou o financeiro ou o adicionais ou o semMF.
|
tipo
|
E
|
condutor
|
N
|
1
|
1
|
|
Tipo da Operação.
1 = Adição de condutor
2 = Remoção de condutor
|
infCondutor
|
Raiz
|
condutor
|
|
0-1
|
|
|
Dados do condutor.
|
cpf
|
E
|
infCondutor
|
N
|
1
|
11
|
|
CPF do condutor
|
informacoes
|
Raiz
|
infCondutor
|
|
0-1
|
|
|
Dados para cadastramento do condutor
|
nomeCompleto
|
E
|
informacoes
|
S
|
1
|
1-150
|
|
Nome do condutor
|
nomeMae
|
E
|
informacoes
|
S
|
1
|
1-150
|
|
Nome da mãe do condutor
|
nomePai
|
E
|
informacoes
|
S
|
0-1
|
1-150
|
|
Nome do pai do condutor
|
dataNascimento
|
E
|
informacoes
|
D
|
1
|
|
|
Data de nascimento do condutor.
Formato: AAAA-MM-DD
|
identidade
|
E
|
informacoes
|
S
|
1
|
1-20
|
|
Identidade do condutor
|
RNTRCTransportador
|
E
|
informacoes
|
N
|
0-1
|
9
|
|
RNTRC do transportador.
Este campo será obrigatório quando o condutor tiver um cartão a ser vinculado, pois esta ação deverá criar o condutor equiparado.
|
cpfTransportador
|
E
|
informacoes
|
N
|
0-1
|
11
|
|
CPF do transportador
Deverá ser informado este elemento ou o cnpjTransportador.
|
cnpjTransportador
|
E
|
informacoes
|
N
|
0-1
|
14
|
|
CNPJ do transportador
Deverá ser informado este elemento ou o cpfTransportador.
|
endereco
|
Raiz
|
informacoes
|
|
1
|
|
|
Dados de endereço do condutor.
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF do condutor.
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município do condutor.
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro do condutor.
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro do condutor.
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número do endereço do condutor.
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP do condutor.
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço do condutor.
|
CNH
|
E
|
informacoes
|
N
|
0-1
|
1-15
|
|
Número da CNH do condutor.
|
dataEmissaoCNH
|
E
|
informacoes
|
D
|
0-1
|
|
|
Data de emissão da CNH do condutor.
Formato: AAAA-MM-DD
|
dataRenovacaoCNH
|
E
|
informacoes
|
D
|
0-1
|
|
|
Data de vencimento da CNH do condutor.
Formato: AAAA-MM-DD
|
telefone
|
E
|
informacoes
|
N
|
1
|
10-11
|
|
Informar o número do celular do condutor, juntamente com o DDD. Caso não haja um número válido, informar 9999999999 ou 99999999999.
|
cartaoId
|
E
|
informacoes
|
N
|
0-1
|
1-15
|
|
Identificação do cartão que foi entregue ao condutor, para que seja feito o vínculo na processadora.
|
documentoOriginario
|
Raiz
|
alteracao
|
|
1
|
|
|
Lista de documentos originários.
|
tipo
|
E
|
documentoOriginario
|
C
|
1
|
1-40
|
|
Tipo de documento.
|
numero
|
E
|
documentoOriginario
|
C
|
1
|
1-44
|
|
Numero do documento.
|
motivo
|
E
|
infOT
|
S
|
1
|
1-1000
|
|
Motivo da alteração.
Motivo pelo qual está sendo solicitada a alteração da Operação de Transporte.
|
ds:Signature
|
Raiz
|
OT
|
|
1
|
|
|
Tag de assinatura
|