Arquivo de Encerramento de OT
O arquivo de envio de encerramento deve possuir a seguinte nomenclatura:
EnvEnce_nomeQualquer.xml
A parte inicial da nomenclatura do arquivo (EnvEnce) é determinante para o funcionamento do processo.
Abaixo, segue a especificação de registros e campos que devem/podem ser informados em um arquivo de solicitação de Encerramento de Operação de Transporte.
Campo | Elem. | Pai | Tipo | Ocor. | Tam. | Dec. | Observação |
---|---|---|---|---|---|---|---|
encerrarOT_envio | Raiz |
|
| 1 |
|
|
|
versao | A | encerrarOT_envio | S | 1 | 7 |
| Versão da integração que está sendo realizada. |
token | A | encerrarOT_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. |
infEnceOT | Raiz | encerrarOT_envio |
| 1 |
|
|
|
ID | A | infEnceOT | S | 0-1 |
|
| GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo. |
Id | A | infEnceOT | S | 0-1 |
|
| GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima. |
cnpj | E | infEnceOT | N | 1 | 14 |
| CNPJ da Contratante |
autorizacao | Raiz | infEnceOT |
| 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 |
encerramento | Raiz | infEnceOT |
| 1 |
|
| Dados para o encerramento da Operação de Transporte. |
padrao | Raiz | encerramento |
| 1 |
|
| Dados para encerramento de uma operação de transporte padrão. Deverá ser informado este elemento ou o AP38 |
qtdeCarga | E | padrao | N | 1 | 1-7 | 2 | Quantidade da carga |
adicionais | Raiz | padrao |
| 0-1 |
|
| Dados adicionais para uso na impressão. |
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 |
financeiro | Raiz | padrao |
| 1 |
|
|
|
comMF | Raiz | financeiro |
| 1 |
|
| Campos contendo dados de tarifas para operações com MF |
tarifas | Raiz | comMF |
| 1 |
|
| Campos contendo dados de tarifas |
quantidadeTotal | E | tarifas | N | 1 | 1-7 |
| Quantidade total de tarifas |
ajustaParc | Raiz | comMF |
| 1 |
|
| Campos contendo os dados de alterações referentes a adição de parcela para a operação de transporte |
nome | E | ajustaParc | S | 1 | 1-255 |
| Nome da pacela |
altValor | Raiz | ajustaParc |
| 1 |
|
| Campos contendo os dados para ajustar a parcela adicionando valores |
adicional | Raiz | altValor |
| 1 |
|
|
|
valor | E | adicional | N | 1 | 1-15 | 2 | Valor para ser adicionado |
rubrica | E | adicional | N | 1 | 1 |
| Determinar qual a rubrica o valor deve ser adicionado. Para o encerramento deve ser permitido apenas o tipo 4 = Valor de Tarifa. |
desconto | Raiz | altValor |
| 1 |
|
|
|
nmDesc | E | desconto | S | 1 | 1-255 |
| Nome do desconto |
vlrDesc | E | desconto | N | 1 | 1-15 | 2 | Valor do desconto quando retido na fonte. |
dsDesc | E | desconto | S | 1 | 1-2000 |
| Descrição contendo informações adicionais sobre o desconto |
rubrica | E | desconto | N | 1 | 1 |
| Determinar qual a rubrica o valor deve ser adicionado. Para o encerramento deve ser permitido apenas o tipo 4 = Valor de Tarifa. |
valorValidacao | E | altValor | N | 1 | 1-15 | 2 | Informar o valor que será usado para a validação do ajuste. Como este ajuste é referente as rúbricas, deve ser informado o valor total da OT (frete + combustível + despesas + Valor de Tarifa). |
semMF | Raiz | financeiro |
| 1 |
|
| Campos contendo dados de tarifas para operações sem MF |
tarifas | Raiz | semMF |
| 1 |
|
| Campos contendo dados de tarifas |
quantidadeTotal | E | tarifas | N | 1 | 1-7 |
| Quantidade total de tarifas |
valorTotal | E | tarifas | N | 1 | 1-15 | 2 | Este valor é participante do valor total da operação de transporte a ser paga ao transportador. |
TACagregado | Raiz | encerramento |
| 1 |
|
| Dados para encerramento de uma operação TAC-agregado. Deverá ser informado este elemento ou o AP12 |
viagens | Raiz | TACagregado |
| 1 |
|
| Dados de viagens realizadas durante uma operação de transporte com TAC-agregado. |
viagem | Raiz | viagens |
| 1-N |
|
| Dados da viagem |
rota | Raiz | viagem |
| 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 informada esta tag ou a tag cep |
cep | E | pontoParada | N | 1 | 8 |
| CEP do ponto de parada Deverá ser informada esta tag ou a tag 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. |
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 | responsavel | N | 0-1 | 1 |
| Possibilita a utilização do roteirizador para calcular a distância e valores de pedágio. 1 = Sim 2 = Não |
totalKm | E | responsavel | N | 0-1 | 1-15 | 2 | Total de quilômetros da rota. |
notificarRespContratante | E | responsavel | 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 |
codigoSH | E | viagem | N | 1 | 4 |
| Natureza da carga, conforme a tabela de códigos do Sistema Harmonizado de Designação e de Codificação de Mercadorias. |
qtdeCarga | E | viagem | N | 1 | 1-10 | 2 | Quantidade da carga |
qtdeViagens | E | viagem | N | 1 | 1-5 |
| Quantidade de viagens |
adicionais | Raiz | TACagregado |
| 0-1 |
|
| Dados adicionais para uso na impressão. |
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 |
financeiro | Raiz | TACagregado |
| 1 |
|
|
|
comMF | Raiz | financeiro |
| 1 |
|
| Campos contendo dados de tarifas para operações com MF |
tarifas | Raiz | comMF |
| 1 |
|
| Campos contendo dados de tarifas |
quantidadeTotal | E | tarifas | N | 1 | 1-7 |
| Quantidade total de tarifas |
ajusteParc | Raiz | comMF |
| 1 |
|
| Campos contendo os dados de alterações referentes a adição de parcela para a operação de transporte |
nome | E | ajusteParc | S | 1 | 1-255 |
| Nome da parcela para ser ajustada. |
altValor | Raiz | ajusteParc |
| 1 |
|
| Campos contendo os dados para ajustar a parcela adicionando valores |
adicional | Raiz | altValor |
| 1 |
|
|
|
valor | E | adicional | N | 1 | 1-15 | 2 | Valor para ser adicionado |
rubrica | E | adicional | N | 1 | 1 |
| Determinar qual a rubrica o valor deve ser adicionado. Para o encerramento deve ser permitido apenas o tipo 4 = Valor de Tarifa. |
desconto | Raiz | altValor |
| 1 |
|
|
|
nmDesc | E | desconto | S | 1 | 1-255 |
| Nome do desconto |
vlrDesc | E | desconto | N | 1 | 1-15 | 2 | Valor do desconto quando retido na fonte. |
dsDesc | E | desconto | S | 1 | 1-2000 |
| Descrição contendo informações adicionais sobre o desconto |
rubrica | E | desconto | N | 1 | 1 |
| Determinar qual a rubrica o valor deve ser adicionado. Para o encerramento deve ser permitido apenas o tipo 4 = Valor de Tarifa. |
valorValidacao | Raiz | altValor | N | 1 | 1-15 | 2 | Informar o valor que será usado para a validação do ajuste. Como este ajuste é referente as rúbricas, deve ser informado o valor total da OT (frete + combustível + despesas + Valor de Tarifa). |
semMF | Raiz | financeiro |
| 1 |
|
| Campos contendo dados de tarifas para operações sem MF |
tarifas | Raiz | semMF |
| 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 | Valor toral de tarifas |
ds:Signature | Raiz | encerrarOT_envio |
| 1 |
|
| Tag de assinatura |