Alteração de Viagem (V2)
Método responsável pela alteração de viagem no formato V2 (versão 2). É possivel também atualizar os registro de CadastrosPreViagem através dos campos chaves como CPF/CNPJ e Placa, mandando na requisição também os campos com os valores que serão mantidos.
Request
- ENDPOINT: ViagemV2/Alterar
- VERBO: PUT
| Índice | Campo | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | Token | Token de autenticação | E | Caractere | 1-1 | 100 | 1.0 |
| 2 | CNPJAplicacao | CNPJ para autenticação | E | Caractere | 1-1 | 14 | 1.0 |
| 3 | CNPJEmpresa | CNPJ da empresa responsável pela requisição | E | Caractere | 1-1 | 14 | 1.0 |
| 4 | DocumentoUsuarioAudit | Documento do usuário que está realizando a operação | E | Caractere | 1-1 | 14 | 1.0 |
| 5 | NomeUsuarioAudit | Nome do usuário que está realizando a operação | E | Caractere | 1-1 | 60 | 1.0 |
| 6 | ViagemId | Chave da viagem para alteração | E | Inteiro | 1-1 | 10 | 1.0 |
| 7 | DadosViagem | Objeto pai responsável pelos objetos filhos que compõe a viagem | G | 1-1 | 1.0 | ||
| 7.1 | DadosIniciais | Objeto responsável pelos dados iniciais da viagem | G | 1-1 | 1.0 | ||
| 7.1.1 | NumeroControle | Número para controle no ERP | E | Caractere | 1-0 | 100 | 1.0 |
| 7.1.2 | StatusViagem | Enum de status de viagem, pondendo ser eles: 1: Aberto (Padrão); 2: Programada; 3: Cancelada; 4: Bloqueada; 5: Baixada. |
E | Inteiro | 1-0 | 1 | 1.0 |
| 7.1.3 | Produto | Descrição do produto da viagem | E | Caractere | 1-0 | 100 | 1.0 |
| 7.1.4 | UnidadeMedidaProduto | Enumeração da unidade de medida do produto, podendo ser: 0: Peso; 1: Saca. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.1.5 | NaturezaCarga | Código nacional de natureza de carga (Utilizado para a emissão de CIOT) | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.1.6 | RealizarIntegracoesPreViagem | Flag utilizada para informar se deseja que a API realize os cadastros de forma automática, usar default TRUE | E | Booleano | 1-0 | True/False | 1.0 |
| 7.1.7 | DistanciaViagem | Distância total da viagem considerada para validações da ANTT. | E | Decimal | 0-1 | 10,2 | 1.0 |
| 7.2 | DadosAntt | Objeto com os dados operacionais exigidos pela ANTT para validação, declaração ou retificação do CIOT. | G | 1-0 | 1.0 | ||
| 7.2.1 | AltoDesempenho | Obrigatório quando "TipoOperacao" 1. | E | Booleano | 1-0 | True/False | 1.0 |
| 7.2.2 | DestinacaoComercial | Indica se a operação possui destinação comercial. | E | Booleano | 1-0 | True/False | 1.0 |
| 7.2.3 | TipoCarga | Obrigatório quando "TipoOperacao" 1 (Lotação) ou 2 (Fracionada). Enum: 1: Granel sólido; 2: Granel líquido; 3: Frigorificada ou Aquecida; 4: Conteinerizada; 5: Carga Geral; 6: Neogranel; 7: Perigosa (granel sólido); 8: Perigosa (granel líquido); 9: Perigosa (Frigorificada ou Aquecida); 10: Perigosa (conteinerizada); 11: Perigosa (carga geral); 12: Carga Granel Pressurizada. |
E | Inteiro | 1-0 | 2 | 1.0 |
| 7.2.4 | ContratantesCargaFrac | Array de CPF/CNPJ dos contratantes da carga fracionada. | A | Caractere | 1-0 | 14 | 1.0 |
| 7.2.6 | ComposicaoVeicular | Obrigatório quando "TipoOperacao" 1. | E | Booleano | 1-0 | True/False | 1.0 |
| 7.2.7 | RetornoVazio | Obrigatório quando "TipoOperacao" 1. | E | Booleano | 1-0 | True/False | 1.0 |
| 7.2.8 | TipoOperacao | Não obrigatório. Caso enviado nulo, não será declarado CIOT. Enum: 1: Operação Carga Lotação; 2: Operação Carga Fracionada; 3: Operação TAC-Agregado. |
E | Inteiro | 1-0 | 1 | 1.0 |
| 7.2.9 | FreteRetorno | Indica se há frete retorno na operação. | E | Booleano | 1-0 | True/False | 1.0 |
| 7.2.10 | CEPRetorno | CEP utilizado para retorno da operação, quando aplicável. | E | Caractere | 1-0 | 8 | 1.0 |
| 7.2.11 | DistanciaRetorno | Distância de retorno considerada na operação, quando aplicável. | E | Decimal | 1-0 | 10,2 | 1.0 |
| 7.2.12 | Origem | Objeto com as coordenadas geográficas de origem utilizadas pela ANTT. | G | 1-0 | 1.0 | ||
| 7.2.13.1 | Cep | CEP da origem utilizado pela ANTT para validação da operação. | E | Caractere | 1-0 | 8 | 1.0 |
| 7.2.13.2 | CodIbge | Código IBGE da origem utilizado pela ANTT para validação da operação. | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.2.13.3 | Latitude | Obrigatório quando "TipoOperacao" 1 (Lotação) ou 2 (Fracionada). | E | Decimal | 1-0 | 10,7 | 1.0 |
| 7.2.13.4 | Longitude | Obrigatório quando "TipoOperacao" 1 (Lotação) ou 2 (Fracionada). | E | Decimal | 1-0 | 10,7 | 1.0 |
| 7.2.14 | Destino | Objeto com as coordenadas geográficas de destino utilizadas pela ANTT. | G | 1-0 | 1.0 | ||
| 7.2.14.1 | Cep | CEP do destino utilizado pela ANTT para validação da operação. | E | Caractere | 1-0 | 8 | 1.0 |
| 7.2.14.2 | CodIbge | Código IBGE do destino utilizado pela ANTT para validação da operação. | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.2.14.3 | Latitude | Obrigatório quando "TipoOperacao" 1 (Lotação) ou 2 (Fracionada). | E | Decimal | 1-0 | 10,7 | 1.0 |
| 7.2.14.4 | Longitude | Obrigatório quando "TipoOperacao" 1 (Lotação) ou 2 (Fracionada). | E | Decimal | 1-0 | 10,7 | 1.0 |
| 7.2.15 | OrigemDestino | Array de origem e destino da operação, contendo localização da origem, localização do destino e distância percorrida. | A | 0-1 | 1.0 | ||
| 7.2.15.1 | Origem | Grupo de informações de localização da origem do trecho. | G | 0-1 | 1.0 | ||
| 7.2.15.1.1 | Latitude | Latitude da origem do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 7.2.15.1.2 | Longitude | Longitude da origem do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 7.2.15.1.3 | Cep | CEP da origem do trecho utilizado pela ANTT para validação da operação. | E | Caractere | 0-1 | 8 | 1.0 |
| 7.2.15.1.4 | CodIbge | Código IBGE da origem do trecho utilizado pela ANTT para validação da operação. | E | Inteiro | 0-1 | 10 | 1.0 |
| 7.2.15.2 | Destino | Grupo de informações de localização do destino do trecho. | G | 0-1 | 1.0 | ||
| 7.2.15.2.1 | Latitude | Latitude do destino do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 7.2.15.2.2 | Longitude | Longitude do destino do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 7.2.15.2.3 | Cep | CEP do destino do trecho utilizado pela ANTT para validação da operação. | E | Caractere | 0-1 | 8 | 1.0 |
| 7.2.15.2.4 | CodIbge | Código IBGE do destino do trecho utilizado pela ANTT para validação da operação. | E | Inteiro | 0-1 | 10 | 1.0 |
| 7.2.15.3 | DistanciaPercorrida | Distância percorrida entre a origem e o destino do trecho. | E | Decimal | 0-1 | 10,2 | 1.0 |
| 7.2.16 | MotivoCancelamento | Motivo pelo qual se deseja cancelar a viagem | E | Caractere | 1-1 | 500 | 1.0 |
| 7.2.17 | CiotFrotaPropria | Objeto com os dados do contratante para declaração do CIOT Frota Própria. | G | 1-0 | 1.0 | ||
| 7.2.17.1 | CnpjCpfContratante | CNPJ/CPF do contratante informado para o CIOT Frota Própria. | E | Caractere | 1-0 | 14 | 1.0 |
| 7.2.17.2 | RazaoSocialContratante | Razão social do contratante informado para o CIOT Frota Própria. | E | Caractere | 1-0 | 100 | 1.0 |
| 7.3 | Documentos | Objeto responsável pelos dados que contém os documentos (CPF/CNPJ) da viagem | G | 1-1 | 1.0 | ||
| 7.3.1 | ClienteOrigemDocumento | CPF/CNPJ do cliente de origem que compõe a viagem | E | Caractere | 1-1 | 14 | 1.0 |
| 7.3.2 | ClienteDestinoDocumento | CPF/CNPJ do cliente de destino que compõe a viagem | E | Caractere | 1-1 | 14 | 1.0 |
| 7.3.3 | ClienteTomadorDocumento | CPF/CNPJ do cliente tomador que compõe a viagem | E | Caractere | 1-0 | 14 | 1.0 |
| 7.3.4 | FilialDocumento | CNPJ da Filial que compõe a viagem | E | Caractere | 1-0 | 14 | 1.0 |
| 7.3.5 | MotoristaDocumento | CPF do Motorista que compõe a viagem | E | Caractere | 1-1 | 11 | 1.0 |
| 7.3.6 | ProprietarioDocumento | CPF/CNPJ do Proprietário que compõe a viagem | E | Caractere | 1-1 | 11 | 1.0 |
| 7.3.7 | NumeroDocumentoNotaCliente | Número do documento na nota (numeração para o cliente) | E | Caractere | 1-0 | 100 | 1.0 |
| 7.3.8 | NumeroDocumentoFiscal | Número do documento fiscal | E | Caractere | 1-0 | 100 | 1.0 |
| 7.4 | Valores | Objeto responsável pelos valores da viagem | G | 1-1 | 1.0 | ||
| 7.4.1 | Irrpf | Valor do Imposto de Renda Retido na Fonte | E | Decimal | 1-1 | 10,2 | 1.0 |
| 7.4.2 | Inss | Valor do Instituto Nacional do Seguro Social | E | Decimal | 1-1 | 10,2 | 1.0 |
| 7.4.3 | SestSenat | Valor do Serviço Social do Transporte e o Serviço Nacional de Aprendizagem do Transporte | E | Decimal | 1-1 | 10,2 | 1.0 |
| 7.4.4 | PesoSaida | Peso do frete detalhado no documento do transporte. Maior que zero e obrigatório quando "TipoOperacao" 1 (Lotação) ou 2 (Fracionada). | E | Decimal | 1-1 | 10,3 | 1.0 |
| 7.4.5 | ValorMercadoria | Valor total da mercadoria | E | Decimal | 1-0 | 10,2 | 1.0 |
| 7.4.6 | Quantidade | Quantidade referente a carga | E | Decimal | 1-1 | 18,2 | 1.0 |
| 7.5 | Enderecos | Objeto com os dados dos endereços que compõe a viagem | G | 1-1 | 1.0 | ||
| 7.5.1 | EnderecoColeta | Endereço de coleta da mercadoria | E | Caractere | 1-0 | 100 | 1.0 |
| 7.5.2 | EnderecoEntrega | Endereço de entrega da mercadoria | E | Caractere | 1-0 | 100 | 1.0 |
| 7.6 | DadosPagamento | Objeto com os dados dos dados de pagamento que compõe a viagem | G | 1-0 | 1.0 | ||
| 7.6.1 | FormaPagamento | Enum de forma de pagamento, podendo ser: 1: Cartao; 2: Conta Corrente; 3: Conta Poupança; 4: Conta Pagamento; 5: Outros |
E | Inteiro | 1-0 | 1 | 1.0 |
| 7.6.2 | CodigoBacen | Codigo do banco registrado no Banco Central | E | Caractere | 1-0 | 5 | 1.0 |
| 7.6.3 | Agencia | Agencia | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.6.4 | Conta | Dados da Conta corrente | E | Caractere | 1-0 | 20 | 1.0 |
| 7.6.5 | TipoConta | Enum de tipo de conta, podendo ser: 0: ContaCorrente; 1: ContaPoupanca. |
E | Inteiro | 1-0 | 1 | 1.0 |
| 7.7 | Veiculo | Objeto com os dados do veículo | G | 1-1 | 1.0 | ||
| 7.7.1 | Rntrc | Registro nacional de transportes rodoviários de cargas do veículo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.7.2 | Placa | Placa do veículo | E | Caractere | 1-1 | 7 | 1.0 |
| 7.8 | Datas | Objeto com as datas das que compõe a viagem | G | 1-0 | 1.0 | ||
| 7.8.1 | DataColeta | Data da coleta da carga (carregamento) | E | Data | 1-0 | yyyy-MM-dd HH:mm:ss | 1.0 |
| 7.8.2 | DataPrevisaoEntrega | Data de previsão de entrega da carga (descarregamento) | E | Data | 1-0 | yyyy-MM-dd HH:mm:ss | 1.0 |
| 7.8.3 | DataEmissaoDocumentosFiscal | Data que foi emitido o documento fiscal | E | Data | 1-0 | yyyy-MM-dd HH:mm:ss | 1.0 |
| 7.9 | ViagemEventos | Array de Objetos com os dados das parcelas que compõe a viagem | A | 1-1 | 1.0 | ||
| 7.9.1 | IdViagemEvento | Código do evento da viagem previamente cadastrada | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.9.2 | HabilitarPagamentoCartao | Ao definir o parâmetro de pagamento como true, a transação será processada via Extratta (Cartão). Caso o proprietário não tenha um cartão vinculado, o sistema criará automaticamente uma conta virtual, na qual o valor será disponibilizado. Se o parâmetro pagamento for definido como false, dois cenários são possíveis: 1- O pagamento poderá ser registrado como depósito (transação não irá ocorrer pela Extratta); 2- O pagamento poderá ser realizado via PIX através da Extratta, desde que o cliente tenha contratado o serviço de pagamento via PIX e o proprietário tenha uma chave PIX válida cadastrada. |
E | Booleano | 1-1 | True/False | 1.0 |
| 7.9.3 | NumeroControle | Número de controle para ERP | E | Caractere | 1-0 | 100 | 1.0 |
| 7.9.4 | TipoEvento | Enumeração do tipo de parcela, podendo ser: 0: Adiantamento; 1: Saldo; 2: Estadia; 3: RPA; 4: Tarifa ANTT; 5: Abastecimento; 6: Abono. |
E | Inteiro | 1-0 | 1 | 1.0 |
| 7.9.5 | ValorPagamento | Valor do pagamento da viagem | E | Decimal | 1-1 | 10,3 | 1.0 |
| 7.9.6 | DataValidade | Data de validade | E | Data | 1-0 | yyyy-MM-dd | 1.0 |
| 7.9.7 | NumeroRecibo | Número do recibo | E | Caractere | 1-0 | 20 | 1.0 |
| 7.9.8 | Instrucao | Instruções | E | Caractere | 1-0 | 100 | 1.0 |
| 7.9.9 | Status | Enumeração com o status que compõe o andamento do pagamento | E | Inteiro | 1-1 | 1 | 1.0 |
| 7.9.10 | DataAgendamentoPagamento | Data para agendamento de pagamento automático no formato dd/MM/yyyy, é obrigatório o uso em conjunto com o status Agendado. | E | Data | 1-0 | yyyy-MM-dd | 1.0 |
| 7.9.11 | MotivoBloqueio | Motivo para bloqueio caso o evento seja bloqueado | E | Caractere | 1-0 | 100 | 1.0 |
| 7.9.12 | ViagemDocumentos | Array de Objetos com os dados dos documentos que compõe a parcela da viagem | A | 1-0 | 1.0 | ||
| 7.9.12.1 | IdViagemDocumento | Código de identificação para alteração de ViagemDocumento | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.9.12.2 | Descricao | Descrição do documento | E | Caractere | 1-0 | 100 | 1.0 |
| 7.9.12.3 | TipoDocumento | Enumeração do tipo do documento, podendo ser: 0: Outros; 1: CT-e; 2: NF Serviço; 3: Ordem de coleta; 4: Nota Fiscal. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.9.12.4 | NumeroDocumento | Número do documento | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.9.12.5 | ObrigaAnexo | Obrigar Anexo | E | Booleano | 1-0 | True/False | 1.0 |
| 7.9.12.6 | ObrigaAnexoMatriz | Obrigar Anexo Matriz | E | Booleano | 1-0 | True/False | 1.0 |
| 7.9.12.7 | ObrigaAnexoFilial | Obrigar Anexo Filial | E | Booleano | 1-0 | True/False | 1.0 |
| 7.9.12.8 | ObrigaDocOriginal | Obrigar documento original | E | Booleano | 1-0 | True/False | 1.0 |
| 7.9.13 | ViagemOutrosAcrescimos | Array de Objetos com os dados de acréscimos que compõe a parcela da viagem | A | 1-0 | 1.0 | ||
| 7.9.13.1 | Descricao | Descrição do documento | E | Caractere | 1-0 | 100 | 1.0 |
| 7.9.13.2 | NumeroDocumento | Número do documento | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.9.13.3 | Valor | Valor do desconto | E | Decimal | 1-1 | 10,2 | 1.0 |
| 7.9.13.4 | CodigoERP | Código do ERP | E | Long | 1-0 | 20 | 1.0 |
| 7.10 | DocumentosFiscais | Array de Objetos com os dados dos documentos que compõe a viagem | A | 1-0 | 1.0 | ||
| 7.10.1 | NumeroDocumento | Número do documento | E | Decimal | 1-1 | 10 | 1.0 |
| 7.10.2 | Serie | Série | E | Caractere | 1-1 | 4 | 1.0 |
| 7.10.3 | PesoSaida | Peso de saída | E | Decimal | 1-1 | 10,3 | 1.0 |
| 7.10.4 | Valor | Valor | E | Decimal | 1-0 | 10,2 | 1.0 |
| 7.10.5 | TipoDocumento | Enumeração do tipo do documento, podendo ser: 0: Outros; 1: CT-e; 2: NF Serviço; 3: Ordem de coleta; 4: Nota Fiscal. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.11 | AutorizacaoEstabelecimentos | Array de Objetos com os dados dos estabelecimentos autorizados a pagar determinada parcela da viagem | A | 1-0 | 1.0 | ||
| 7.11.1 | Cnpj | CNPJ do estabelecimento | E | Caractere | 1-1 | 14 | 1.0 |
| 7.11.2 | TipoEvento | Enumeração do tipo de parcela, podendo ser: 0: Adiantamento; 1: Saldo; 2: Estadia; 3: RPA; 4: Tarifa ANTT; 5: Abastecimento; 6: Abono. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.12 | Pedagio | Objeto com os dados para o processo de compra de pedágio para viagem | G | 1-0 | 1.0 | ||
| 7.12.1 | Fornecedor | Enumeração com o fornecedor do pedágio, podendo ser: 0: Desabilitado (padrão); 1: Moedeiro: Carga no cartão moedeiro Extratta (Descontinuado pela ANTT); 2: Via Fácil (Sem Parar); 3: Move Mais; 4: Veloe; 5: Tag Extratta; 6: ConectCar; 7: Taggy Edenred. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.12.2 | TipoVeiculo | Enumeração com o tipo de veículo, podendo ser: 0: Carro; 1: Motocicleta; 2: Ônibus; 3: Caminhão. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.12.3 | QtdEixos | Quantidade de eixos do veículo ( somatória dos eixos de todos veículos que compõe a viagem ) | E | Inteiro | 1-1 | 2 | 1.0 |
| 7.12.4 | Localizacoes | Array de Objetos com os dados das localizações da rota | A | 1-0 | 1.0 | ||
| 7.12.4.1 | IbgeCidade | Código de IBGE da cidade | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.12.4.2 | Latitude | Latitude | E | Decimal | 1-0 | 10,7 | 1.0 |
| 7.12.4.3 | Longitude | Longitude | E | Decimal | 1-0 | 10,7 | 1.0 |
| 7.12.5 | ValorPedagio | Valor do pedágio Enviar OU identificador OU ValorPedágio OU NomeRota OU IdRotaModelo |
E | Decimal | 1-0 | 10,2 | 1.0 |
| 7.12.6 | IdentificadorHistorico | Código de identificação de rota de pedágio obtivo via métodode roteirização (calcular custo do pedágio) Se operar com rota fixa (cadastrada) deverá realizar a consulta custo rota pelo IDRotaModelo ou NomeRota e informar o identificador histórico (hash) na viagem. |
E | Guid | 1-0 | 1.0 | |
| 7.13 | CadastrosPreViagem | Objeto pai com os dados para o processo de cadastro das informações necessárias para criar uma viagem | G | 1-0 | 1.0 | ||
| 7.13.1 | ClienteOrigem | Objeto com os dados para a integração de um cliente do tipo origem | G | 1-0 | 1.0 | ||
| 7.13.1.1 | BACENPais | Código do BACEN do país deste cliente. | E | Inteiro | 1-1 | 14 | 1.0 |
| 7.13.1.2 | IBGEEstado | Código IBGE do estado. | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.1.3 | IBGECidade | Código IBGE da cidade. | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.1.4 | RazaoSocial | Razão social do cliente. | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.1.5 | NomeFantasia | Nome fantasia do cliente. | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.1.6 | TipoPessoa | Tipo de Pessoa. 1 = Física, 2 = Jurídica | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.1.7 | CNPJCPF | CPF ou CNPJ | E | Caractere | 1-1 | 14 | 1.0 |
| 7.13.1.8 | RG | Registro Geral / Numero do Documento de Identidade | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.1.9 | OrgaoExpedidorRG | Órgão Expedidor | E | Caractere | 1-0 | 5 | 1.0 |
| 7.13.1.10 | IE | Inscrição Estadual | E | Numerico | 1-0 | 15 | 1.0 |
| 7.13.1.11 | Celular | Número de celular, apenas números | E | Caractere | 1-0 | 10 | 1.0 |
| 7.13.1.12 | E | Caractere | 1-0 | 100 | 1.0 | ||
| 7.13.1.13 | CEP | CEP do Cliente | E | Caractere | 1-1 | 10 | 1.0 |
| 7.13.1.14 | Endereco | Endereço | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.1.15 | Complemento | Complemento | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.1.16 | Numero | Número | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.1.17 | Bairro | Bairro | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.2 | ClienteDestino | Objeto com os dados para a integração de um cliente do tipo destino | G | 1-0 | 1.0 | ||
| 7.13.2.1 | BACENPais | Código do BACEN do país deste cliente. | E | Inteiro | 1-1 | 14 | 1.0 |
| 7.13.2.2 | IBGEEstado | Código IBGE do estado. | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.2.3 | IBGECidade | Código IBGE da cidade. | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.2.4 | RazaoSocial | Razão social do cliente. | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.2.5 | NomeFantasia | Nome fantasia do cliente. | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.2.6 | TipoPessoa | Tipo de Pessoa. 1 = Física, 2 = Jurídica | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.2.7 | CNPJCPF | CPF ou CNPJ | E | Caractere | 1-1 | 14 | 1.0 |
| 7.13.2.8 | RG | Registro Geral / Numero do Documento de Identidade | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.2.9 | OrgaoExpedidorRG | Órgão Expedidor | E | Caractere | 1-0 | 5 | 1.0 |
| 7.13.2.10 | IE | Inscrição Estadual | E | Numerico | 1-0 | 15 | 1.0 |
| 7.13.2.11 | Celular | Número de celular, apenas números | E | Caractere | 1-0 | 10 | 1.0 |
| 7.13.2.12 | E | Caractere | 1-0 | 100 | 1.0 | ||
| 7.13.2.13 | CEP | CEP do Cliente | E | Caractere | 1-1 | 10 | 1.0 |
| 7.13.2.14 | Endereco | Endereço | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.2.15 | Complemento | Complemento | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.2.16 | Numero | Número | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.2.17 | Bairro | Bairro | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.3 | Proprietário | Objeto com os dados para a integração de um proprietário | G | 1-0 | 1.0 | ||
| 7.13.3.1 | CnpjCpf | CPF ou CNPJ do proprietário | E | Caractere | 1-1 | 14 | 1.0 |
| 7.13.3.2 | RazaoSocial | Razão social | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.3.3 | NomeFantasia | Nome fantasia | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.3.4 | RG | Registro Geral/Número da Carteira de Identidade para pessoa física | E | Caractere | 1-0 | 50 | 1.0 |
| 7.13.3.5 | RGOrgaoExpedidor | Órgão expedidor para pessoa física | E | Caractere | 1-0 | 10 | 1.0 |
| 7.13.3.6 | RNTRC | Registro nacional de transportadores de carga | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.3.7 | IE | Inscrição Estadual para pessoa jurídica | E | Inteiro | 1-0 | 15 | 1.0 |
| 7.13.3.8 | TipoContrato | Tipo de contrato do proprietário a ser integrado 1: Frota, 2: Cooperado, 3: Agregado/Terceiro) |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.13.3.9 | DataNascimento | Data de nascimento do proprietário pessoa física | E | Data | 1-1 | yyyy-MM-dd | 1.0 |
| 7.13.3.10 | Cartao | Objeto com os dados para a vinculação de um cartão a um proprietário | G | 1-0 | 1.0 | ||
| 7.13.3.10.1 | NumeroCartao | Número de identificação do cartão | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.3.10.2 | RealizarTrocaCartao | Flag para indicar se deve ser realizado a troca do cartão caso o proprietário já tenha um cartão vinculado | E | Booleano | 1-1 | True/False | 1.0 |
| 7.13.3.11 | Contatos | Array de Objetos com os dados de contato de um proprietário | A | 1-1 | 1.0 | ||
| 7.13.3.11.1 | E-mail do proprietário | E | Caractere | 1-0 | 20 | 1.0 | |
| 7.13.3.11.2 | Telefone | Telefone do proprietário | E | Caractere | 1-1 | 20 | 1.0 |
| 7.13.3.11.3 | Celular | Celular do proprietário | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.3.12 | Enderecos | Array de Objetos com os dados de endereço de um proprietário | A | 1-0 | 1.0 | ||
| 7.13.3.12.1 | CEP | CEP | E | Caractere | 1-1 | 8 | 1.0 |
| 7.13.3.12.2 | Endereco | Endereço do proprietário | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.3.12.3 | Complemento | Complemento | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.3.12.4 | Numero | Número | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.3.12.5 | Bairro | Bairro | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.3.12.6 | IBGECidade | Código IBGE da cidade | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.3.12.7 | IBGEEstado | Código IBGE do estado | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.3.12.8 | BACENPais | Código BACEN do país | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.4 | Motorista | Objeto com os dados para a integração de um motorista | G | 1-0 | 1.0 | ||
| 7.13.4.1 | Nome | Nome do motorista | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.4.2 | RG | Registro geral/Documento de Identidade | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.4.3 | RGOrgaoExpedidor | Órgão de expedição do registro geral | E | Caractere | 1-1 | 10 | 1.0 |
| 7.13.4.4 | CPF | CPF do motorista | E | Caractere | 1-1 | 11 | 1.0 |
| 7.13.4.5 | Sexo | Sexo: M ou F (Masculino/Feminino) | E | Caractere | 1-1 | 1 | 1.0 |
| 7.13.4.6 | CNH | Carteira nacional de habilitação / Número do Registro da CNH | E | Caractere | 1-1 | 11 | 1.0 |
| 7.13.4.7 | CNHCategoria | Categoria da carteira nacional de habilitação: A, B, AB, C, D ou E | E | Caractere | 1-1 | 2 | 1.0 |
| 7.13.4.8 | ValidadeCNH | Validade da CNH do motorista | E | Data | 1-1 | yyyy-MM-dd | 1.0 |
| 7.13.4.9 | Celular | Número de contato com DDD | E | Caractere | 1-0 | 11 | 1.0 |
| 7.13.4.10 | TipoContrato | Tipo do contrato: 1: Frota, 2: Cooperado, 3: Agregado, 4: Terceiro |
E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.4.11 | E-mail de contato | E | Caractere | 1-0 | 100 | 1.0 | |
| 7.13.4.12 | IBGECidade | Código IBGE da cidade | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.4.13 | IBGEEstado | Código IBGE do estado | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.4.14 | BACENPais | Código BACEN do país | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.4.15 | CEP | CEP do endereço | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.4.16 | Endereco | Endereço do motorista | E | Caractere | 1-1 | 100 | 1.0 |
| 7.13.4.17 | Complemento | Complemento | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.4.18 | Numero | Número da residência | E | Caractere | 1-0 | 5 | 1.0 |
| 7.13.4.19 | Bairro | Bairro | E | Caractere | 1-1 | 50 | 1.0 |
| 7.13.4.20 | FormularioCnh | Formulário CNH | E | Caractere | 1-0 | 100 | 1.0 |
| 7.13.4.21 | Cartao | Objeto com os dados para a vinculação de um cartão a um motorista | G | 1-0 | 1.0 | ||
| 7.13.4.21.1 | NumeroCartao | Número de identificação do cartão | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.4.21.2 | RealizarTrocaCartao | Flag para indicar se deve ser realizado a troca do cartão caso o proprietário já tenha um cartão vinculado | E | Booleano | 1-1 | True/False | 1.0 |
| 7.13.5 | Veículo | Objeto com os dados para a integração de um veículo | G | 1-0 | 1.0 | ||
| 7.13.5.1 | CPFCNPJProprietario | CPF ou CNPJ do proprietário do veículo, associado a ANTT | E | Caractere | 1-0 | 14 | 1.0 |
| 7.13.5.2 | CPFMotorista | CPF do motorista | E | Caractere | 1-0 | 11 | 1.0 |
| 7.13.5.3 | Placa | Placa do veículo | E | Caractere | 1-1 | 7 | 2.0 |
| 7.13.5.4 | Chassi | Número do chassi | E | Caractere | 1-1 | 22 | 1.0 |
| 7.13.5.5 | RENAVAM | Número do RENAVAM | E | Inteiro | 1-1 | 11 | 1.0 |
| 7.13.5.6 | AnoFabricacao | Ano de fabricação do veículo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.5.7 | AnoModelo | Ano do modelo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.5.8 | Marca | Marca do Veículo | E | Caractere | 1-1 | 50 | 1.0 |
| 7.13.5.9 | Modelo | Modelo do Veículo | E | Caractere | 1-1 | 20 | 1.0 |
| 7.13.5.10 | ComTracao | Se possui tração: true - Sim: Cavalo/Utilitário false - Não: Carreta |
E | Booleano | 1-1 | True/False | 1.0 |
| 7.13.5.11 | TipoRodagem | Enum de tipo de rodagem, podendo ser eles: 1 - Simples; 2 - Duplo. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.13.5.12 | IdTipoCarreta | Id do tipo de carreta | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.5.13 | TipoContrato | Tipo de contrato do veículo, podendo ser eles: 1 - Frota; 2 - Cooperado; 3 - Agregado; 4 - Terceiro. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.13.5.14 | QuantidadeEixos | Quantidade de eixos do veículo. IMPORTANTE enviar a quantidade correta de eixos, pois o calculo de pedágio é baseado nesta quantidade. |
E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.5.15 | IdTipoCavalo | Id do tipo de cavalo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.5.16 | IBGECidade | Código IBGE da cidade | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.6 | Carretas | Objeto com os dados para a integração de um veículo | G | 1-0 | 1.0 | ||
| 7.13.6.1 | CPFCNPJProprietario | CPF ou CNPJ do proprietário | E | Caractere | 1-0 | 14 | 1.0 |
| 7.13.6.2 | Placa | Placa do veículo | E | Caractere | 1-1 | 7 | 2.0 |
| 7.13.6.3 | RNTRC | Registro Nacional Transporte Rodoviário de Carga ( ANTT ) | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.6.4 | Chassi | Número do chassi | E | Caractere | 1-1 | 22 | 1.0 |
| 7.13.6.5 | RENAVAM | Número do RENAVAM | E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.6.6 | AnoFabricacao | Ano de fabricação do veículo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.6.7 | AnoModelo | Ano do modelo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.6.8 | Marca | Marca do Veículo | E | Caractere | 1-1 | 50 | 1.0 |
| 7.13.6.9 | Modelo | Modelo do Veículo | E | Caractere | 1-1 | 20 | 1.0 |
| 7.13.6.10 | ComTracao | Se possui tração: true - Sim: Cavalo/Utilitário false - Não: Carreta |
E | Booleano | 1-1 | True/False | 1.0 |
| 7.13.6.11 | TipoRodagem | Enum de tipo de rodagem, podendo ser eles: 1 - Simples; 2 - Duplo. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.13.6.12 | IdTipoCarreta | Id do tipo de carreta | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.6.13 | TipoContrato | Tipo de contrato do veículo, podendo ser eles: 1 - Frota; 2 - Cooperado; 3 - Agregado; |
E | Inteiro | 1-1 | 1 | 1.0 |
| 7.13.6.14 | QuantidadeEixos | Quantidade de eixos do veículo. IMPORTANTE enviar a quantidade correta de eixos, pois o calculo de pedágio é baseado nesta quantidade. |
E | Inteiro | 1-1 | 10 | 1.0 |
| 7.13.6.15 | IdTipoCavalo | Id do tipo de cavalo | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.6.16 | IBGECidade | Código IBGE da cidade | E | Inteiro | 1-0 | 10 | 1.0 |
| 7.13.6.17 | Municipio | Municipio do emplacamento | E | Caractere | 1-1 | 50 | 1.0 |
| 7.13.6.18 | NumeroFrota | Numero da Frota | E | Long | 1-0 | 20 | 1.0 |
| 7.13.6.19 | CNPJFilial | CNPJ da Filial | E | Caractere | 1-0 | 14 | 1.0 |
| 7.13.6.20 | CorVeiculo | Cor do Veiculo | E | Caractere | 1-1 | 50 | 1.0 |
Modelo de Json - Request
{
"Token": "",
"CnpjAplicacao": "",
"CNPJEmpresa": "",
"DocumentoUsuarioAudit": "",
"NomeUsuarioAudit": "",
"ViagemId": 0,
"DadosViagem": {
"DadosIniciais": {
"NumeroControle": "",
"Produto": "",
"UnidadeMedidaProduto": 0,
"NaturezaCarga": 0,
"RealizarIntegracoesPreViagem": true,
"DistanciaViagem": 0.0,
},
"DadosAntt": {
"AltoDesempenho": false,
"DestinacaoComercial": false,
"TipoCarga": 0,
"ContratantesCargaFrac": [
"00000000000000"
],
"ComposicaoVeicular": false,
"RetornoVazio": false,
"FreteRetorno": false,
"CEPRetorno": "",
"TipoOperacao": 0,
"DistanciaRetorno": 0.0,
"CiotFrotaPropria": {
"CnpjCpfContratante": "00000000000000",
"RazaoSocialContratante": "NOME DO CONTRATANTE"
},
"Origem": {
"Cep": "",
"CodIbge": 0,
"Latitude": 0.0,
"Longitude": 0.0
},
"Destino": {
"Cep": "",
"CodIbge": 0,
"Latitude": 0.0,
"Longitude": 0.0
},
"OrigemDestino": [
{
"Origem": {
"Latitude": -22.906847,
"Longitude": -43.172897,
"Cep": null,
"CodIbge": null
},
"Destino": {
"Latitude": -22.906847,
"Longitude": -43.172897,
"Cep": null,
"CodIbge": null
},
"DistanciaPercorrida": 200
}
],
"MotivoCancelamento": ""
},
"Documentos": {
"ClienteOrigemDocumento": "",
"ClienteDestinoDocumento": "",
"ClienteTomadorDocumento": "",
"FilialDocumento": "",
"MotoristaDocumento": "",
"ProprietarioDocumento": "",
"NumeroDocumentoNotaCliente": ""
},
"Valores": {
"Irrpf": ,
"Inss": ,
"SestSenat": ,
"PesoSaida": ,
"ValorMercadoria": ,
"Quantidade":
},
"Enderecos": {
"EnderecoColeta": "",
"EnderecoEntrega": ""
},
"DadosPagamento": {
"FormaPagamento": 0,
"CodigoBacen": "",
"Agencia": 0,
"Conta": "",
"TipoConta": 0,
},
"Veiculo": {
"Rntrc": "",
"Placa": ""
},
"Datas": {
"DataColeta": "2024-12-31",
"DataPrevisaoEntrega": "2024-12-31",
"DataEmissaoDocumentoFiscal": "2024-12-31"
},
"ViagemEventos": {
"IdViagemEvento": 0,
"HabilitarPagamentoCartao": true,
"NumeroControle": "",
"TipoEvento": 1,
"ValorPagamento": 0.0,
"DataValidade": 2024-12-31,
"NumeroRecibo": "",
"Instrucao": "",
"Status": 0,
"DataAgendamentoPagamento": "2024-12-31",
"MotivoBloqueio": "",
"ViagemOutrosDescontos": [
{
"Descricao": "",
"NumeroDocumento": 0,
"Valor": 0.0,
"CodigoERP": 0,
}
]
},
"DocumentosFiscais": [
{
"IdViagemDocumento": "",
"NumeroDocumento": 0,
"Serie": "",
"PesoSaida": 0.0,
"Valor": 0.0,
"TipoDocumento": 1
}
],
"AutorizacaoEstabelecimentos": {
"Cnpj": "",
"TipoEvento": 0
},
"Pedagio": {
"Fornecedor": 0,
"TipoVeiculo": 0,
"QtdEixos": 0,
"Localizacoes":{ [
"IbgeCidade": 0,
"Latitude": 0.0,
"Longitude": 0.0,
]},
"ValorPedagio": 0.0,
"IdentificadorHistorico": ""
},
"CadastrosPreViagem": {
"ClienteOrigem": {
"BACENPais": 0,
"IBGEEstado": 0,
"IBGECidade": 0,
"RazaoSocial": "",
"NomeFantasia": "",
"TipoPessoa": 1,
"CNPJCPF": "",
"RG": "",
"OrgaoExpedidorRG": "",
"IE": 0,
"Celular": "",
"Email": "",
"CEP": "",
"Endereco": "",
"Complemento": "",
"Numero": 0,
"Bairro": ""
},
"ClienteDestino": {
"BACENPais": 0,
"IBGEEstado": 0,
"IBGECidade": 0,
"RazaoSocial": "",
"NomeFantasia": "",
"TipoPessoa": 1,
"CNPJCPF": "",
"RG": "",
"OrgaoExpedidorRG": "",
"IE": 0,
"Celular": "",
"Email": "",
"CEP": "",
"Endereco": "",
"Complemento": "",
"Numero": 0,
"Bairro": ""
},
"Proprietario": {
"CnpjCpf": "",
"RazaoSocial": "",
"NomeFantasia": "",
"RG": "",
"RGOrgaoExpedidor": "",
"RNTRC": "",
"IE": 0,
"TipoContrato": 1,
"DataNascimento": "",
"Cartao": {
"NumeroCartao": 0,
"RealizarTrocaCartao": false,
}
"Contatos": [
{
"Email": "",
"Telefone": "",
"Celular": ""
}
],
"Enderecos": [
{
"CEP": "",
"Endereco": "",
"Complemento": "",
"Numero": 0,
"Bairro": "",
"IBGECidade": 0,
"IBGEEstado": 0,
"BACENPais": 0
}
]
},
"Motorista": {
"Nome": "",
"RG": "",
"RGOrgaoExpedidor": "",
"CPF": "",
"Sexo": "",
"CNH": "",
"CNHCategoria": "",
"ValidadeCNH": "",
"Celular": "",
"TipoContrato": 0,
"Email": "",
"IBGECidade": 0,
"IBGEEstado": 0,
"BACENPais": 0,
"CEP": "",
"Endereco": "",
"Complemento": "",
"Numero": 0,
"Bairro": "",
"FormularioCnh": "",
"Cartao": {
"NumeroCartao": 0,
"RealizarTrocaCartao":
}
},
"Veiculo": {
"CPFCNPJProprietario": "",
"CPFMotorista": "",
"Placa": "",
"Chassi": "",
"RENAVAM": "",
"AnoFabricacao": "2024-12-31",
"AnoModelo": "2024-12-31",
"Marca": "",
"Modelo": "",
"ComTracao": true,
"TipoRodagem": 1,
"IdTipoCarreta": 0,
"TipoContrato": 1,
"QuantidadeEixos": 0,
"IdTipoCavalo": 0,
"IBGECidade": 0
},
"Carretas": [
{
"CPFCNPJProprietario": "",
"CPFMotorista": "",
"Placa": "",
"Chassi": "",
"RENAVAM": "",
"AnoFabricacao": "2024-12-31",
"AnoModelo": "2024-12-31",
"Marca": "",
"Modelo": "",
"ComTracao": false,
"TipoRodagem": 1,
"IdTipoCarreta": 0,
"TipoContrato": 1,
"QuantidadeEixos": 0,
"IdTipoCavalo": 0,
"IBGECidade": 0,
"Municipio": "",
"NumeroFrota": 0,
"CNPJFilial": "",
"CorVeiculo": ""
}
]
}
}
}
Response
| Índice | Campo | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | Sucesso | Resultado da requisição, caso não passe por uma validação de negócio ou um erro interno do sistema será 'false' | E | Booleano | 1-1 | True/False | 1.0 |
| 2 | Mensagem | Mensagem do resultado da requisição | E | Caractere | 1-1 | 200 | 1.0 |
| 3 | Objeto | Objeto pai que contém os dados | G | 0-1 | 1.0 | ||
| 3.1 | IdViagem | Chave da viagem | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.2 | NumeroDocumento | Número do documento | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.3 | IdsViagemEstabelecimento | Lista de ids dos estabelecimentos da viagem | A | Inteiro | 0-1 | 10 | 1.0 |
| 3.4 | Irrpf | Valor do imposto | E | Decimal | 0-1 | 10,2 | 1.0 |
| 3.5 | Inss | Valor do impostoo | E | Decimal | 0-1 | 10,2 | 1.0 |
| 3.6 | SestSenat | Valor do imposto | E | Decimal | 0-1 | 10,2 | 1.0 |
| 3.7 | Eventos | Array de Objetos com os dados das parcelas que compõe a viagem | A | 1-1 | 1.0 | ||
| 3.7.1 | IdViagemEvento | Código de identidade do evento da viagem previamente integrado, utilizado para edição de um evento | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.2 | NumeroControle | Número de controle do evento para ERP | E | Caractere | 0-1 | 300 | 1.0 |
| 3.7.3 | Token | Token do evento da viagem | E | Caractere | 1-1 | 300 | 1.0 |
| 3.7.4 | TipoEventoViagem | Enumeração com o tipo de parcela, podendo ser: 0: Adiantamento; 1: Saldo; 2: Estadia; 3: RPA; 4: Tarifa ANTT; 5: Abastecimento; 6: Abono. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 3.7.5 | OperacaoCartao | Array com informações referente ao status última transação do evento. | A | 0-1 | 1.0 | ||
| 3.7.5.1 | Status | Status da última transação do evento, podendo ser carga, transferência, ou estorno. 0: Pendente - Falha ao realizar a carga no cartão, porém o próprio serviço do meio homologado está encarregado de reprocessar a transação. Isto pode acontecer em caso de instabilidade na comunicação com a instituição financeira. Nosso serviço mantem o operacional funcionando, e indica a situação neste status; 1: Sucesso - Carga realizada com sucesso; 2: Erro - Erro ao realizar a carga de crédito, onde a plataforma do meio homologado não irá tentar refazer o processo automaticamente; 3: Não habilitado - Não houve necessidade de pagamento no cartão para o evento. Isto ocorre enquanto o status do evento é aberto ou cancelado, e quando o TMS integra a viagem com a funcionalidade de cartão desabilitada; 4: Agendado: Evento com pagamento agendado automaticamente para uma data futura. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 3.7.5.2 | Mensagem | Mensagem do status do processamento | E | Caractere | 1-1 | 200 | 1.0 |
| 3.7.6 | IdsViagemDocumento | Array que contém uma lista de documentos do evento | A | 0-1 | 1.0 | ||
| 3.7.6.1 | IdViagemDocumento | Código do documento da viagem informado para a edição do registro | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.6.2 | NumeroDocumento | Número do documento | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.7 | IdsViagemOutrosDescontos | Lista de códigos de outros descontos | A | Inteiro | 0-1 | 1.0 | |
| 3.7.8 | ViagemOutrosDescontos | Objeto pai que contém uma lista de outros descontos relacionados a um evento da viagem | A | 0-1 | 1.0 | ||
| 3.7.8.1 | IdViagemOutrosDescontos | Código do registro de outros descontos da viagem informado para a edição do registro | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.8.2 | NumeroDocumento | Número do documento | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.8.3 | Descrição | Descrição | E | Caractere | 0-1 | 100 | 1.0 |
| 3.7.8.4 | Valor | Valor do desconto | E | Decimal | 1-1 | 10,2 | 1.0 |
| 3.7.9 | IdsViagemOutrosAcrescimos | Lista de códigos de outros acréscimos | A | Inteiro | 0-1 | 1.0 | |
| 3.7.10 | ViagemOutrosAcrescimos | Objeto pai que contém uma lista de outros acrescimos relacionados a um evento da viagem | A | 0-1 | 1.0 | ||
| 3.7.10.1 | IdViagemOutrosAcrescimos | Código do registro de outros valores da viagem informado para a edição do registro | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.10.2 | NumeroDocumento | Número do documento | E | Inteiro | 1-1 | 10 | 1.0 |
| 3.7.10.3 | Descrição | Descrição | E | Caractere | 0-1 | 100 | 1.0 |
| 3.7.10.4 | Valor | Valor do desconto | E | Decimal | 1-1 | 10,2 | 1.0 |
| 3.8 | Ciot | Objeto que contém informações relacionadas ao CIOT | G | 0-1 | 1.0 | ||
| 3.8.1 | Resultado | Indica o status da declaração de CIOT em relação a obrigatoriedade de registro na ANTT: 0: Sucesso; 1: Erro; 2: NaoObrigatorio; 3: NaoHabilitado. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 3.8.2 | Declarado | true: Ciot declarado; false: Ciot não declarado. |
E | Booleano | 1-1 | True/False | 1.0 |
| 3.8.3 | Mensagem | Mensagem informativa sobre a declaração do CIOT, em casos de falhas, também é indicado a mensagem do erro. | E | Caractere | 0-1 | 200 | 1.0 |
| 3.8.4 | Dados | Objeto que contém informações com os dados integrados na ANTT referente ao CIOT | G | 0-1 | 1.0 | ||
| 3.8.4.1 | Ciot | Número do CIOT gerado pelo meio homologado | E | Caractere | 1-1 | 12 | 1.0 |
| 3.8.4.2 | Verificador | Número verificador do CIOT gerado pela ANTT. Contém os 4 últimos dígitos, caso a ANTT estiver operando em modo de contingência, é gerado os caracteres “XXXX” para indicar a situação, que também é um número válido autorizado pela ANTT. | E | Caractere | 1-1 | 4 | 1.0 |
| 3.8.4.3 | Senha | Senha de acesso ao CIOT gerada pelo meio homologado. Utilizado em páginas públicas do meio homologado. | E | Caractere | 1-1 | 20 | 1.0 |
| 3.8.4.4 | EmContigencia | Indicador se a viagem foi declarada em contingência na ANTT | E | Booleano | 1-1 | True/False | 1.0 |
| 3.8.4.5 | DataDeclaracao | Data e hora da integração com ANTT | E | Data | 1-1 | yyyy-MM-dd HH:mm:ss | 1.0 |
| 3.8.4.6 | AvisoTransportador | Mensagem de aviso cadastrada pela ANTT para o contratado. Sempre que existir esta mensagem, sua apresentação ao transportador e impressão no documento correspondente é obrigatória. | E | Caractere | 0-1 | 300 | 1.0 |
| 3.9 | DadosAntt | Objeto com os dados operacionais retornados da ANTT relacionados à viagem. | G | 0-1 | 1.0 | ||
| 3.9.1 | AltoDesempenho | Indica se a operação utiliza veículo ou composição de alto desempenho. | E | Booleano | 0-1 | True/False | 1.0 |
| 3.9.2 | DestinacaoComercial | Indica se a operação possui destinação comercial. | E | Booleano | 0-1 | True/False | 1.0 |
| 3.9.3 | FreteRetorno | Indica se há frete retorno na operação. | E | Booleano | 0-1 | True/False | 1.0 |
| 3.9.4 | CEPRetorno | CEP utilizado para retorno da operação, quando aplicável. | E | Caractere | 0-1 | 8 | 1.0 |
| 3.9.5 | DistanciaRetorno | Distância de retorno considerada na operação, quando aplicável. | E | Decimal | 0-1 | 10,2 | 1.0 |
| 3.9.6 | MotivoCancelamento | Motivo pelo qual a viagem foi cancelada. | E | Caractere | 0-1 | 500 | 1.0 |
| 3.9.7 | ComposicaoVeicular | Indica se a operação possui composição veicular. | E | Booleano | 0-1 | True/False | 1.0 |
| 3.9.8 | TipoCarga | Código do tipo de carga retornado pela ANTT. | E | Inteiro | 0-1 | 10 | 1.0 |
| 3.9.9 | ContratantesCargaFrac | Array de CPF/CNPJ dos contratantes da carga fracionada. | A | Caractere | 0-1 | 14 | 1.0 |
| 3.9.10 | RetornoVazio | Indica se a operação possui retorno vazio. | E | Booleano | 0-1 | True/False | 1.0 |
| 7.2.8 | TipoOperacao | Não obrigatório. Caso enviado nulo, não será declarado CIOT. Enum: 1: Operação Carga Lotação; 2: Operação Carga Fracionada; 3: Operação TAC-Agregado. |
E | Inteiro | 1-0 | 1 | 1.0 |
| 3.9.11 | Origem | Objeto com as coordenadas geográficas de origem utilizadas pela ANTT. | G | 0-1 | 1.0 | ||
| 3.9.11.1 | Cep | CEP da origem utilizado pela ANTT para validação da operação. | E | Caractere | 0-1 | 8 | 1.0 |
| 3.9.11.2 | CodIbge | Código IBGE da origem utilizado pela ANTT para validação da operação. | E | Inteiro | 0-1 | 10 | 1.0 |
| 3.9.11.3 | Latitude | Latitude da origem. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.11.4 | Longitude | Longitude da origem. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.12 | Destino | Objeto com as coordenadas geográficas de destino utilizadas pela ANTT. | G | 0-1 | 1.0 | ||
| 3.9.12.1 | Cep | CEP do destino utilizado pela ANTT para validação da operação. | E | Caractere | 0-1 | 8 | 1.0 |
| 3.9.12.2 | CodIbge | Código IBGE do destino utilizado pela ANTT para validação da operação. | E | Inteiro | 0-1 | 10 | 1.0 |
| 3.9.12.3 | Latitude | Latitude do destino. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.12.4 | Longitude | Longitude do destino. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.13 | OrigemDestino | Array de origem e destino da operação, contendo localização da origem, localização do destino e distância percorrida. | A | 0-1 | 1.0 | ||
| 3.9.13.1 | Origem | Grupo de informações de localização da origem do trecho. | G | 0-1 | 1.0 | ||
| 3.9.13.1.1 | Latitude | Latitude da origem do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.13.1.2 | Longitude | Longitude da origem do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.13.1.3 | Cep | CEP da origem do trecho utilizado pela ANTT para validação da operação. | E | Caractere | 0-1 | 8 | 1.0 |
| 3.9.13.1.4 | CodIbge | Código IBGE da origem do trecho utilizado pela ANTT para validação da operação. | E | Inteiro | 0-1 | 10 | 1.0 |
| 3.9.13.2 | Destino | Grupo de informações de localização do destino do trecho. | G | 0-1 | 1.0 | ||
| 3.9.13.2.1 | Latitude | Latitude do destino do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.13.2.2 | Longitude | Longitude do destino do trecho. | E | Decimal | 0-1 | 10,7 | 1.0 |
| 3.9.13.2.3 | Cep | CEP do destino do trecho utilizado pela ANTT para validação da operação. | E | Caractere | 0-1 | 8 | 1.0 |
| 3.9.13.2.4 | CodIbge | Código IBGE do destino do trecho utilizado pela ANTT para validação da operação. | E | Inteiro | 0-1 | 10 | 1.0 |
| 3.9.13.3 | DistanciaPercorrida | Distância percorrida entre a origem e o destino do trecho. | E | Decimal | 0-1 | 10,2 | 1.0 |
| 3.9.14 | PesoSaida | Peso de saída considerado para validações da ANTT. | E | Decimal | 0-1 | 10,3 | 1.0 |
| 3.9.15 | CiotFrotaPropria | Objeto com os dados do contratante para declaração do CIOT Frota Própria. | G | 0-1 | 1.0 | ||
| 3.9.15.1 | CnpjCpfContratante | CNPJ/CPF do contratante informado para o CIOT Frota Própria. | E | Caractere | 0-1 | 14 | 1.0 |
| 3.9.15.2 | RazaoSocialContratante | Razão social do contratante informado para o CIOT Frota Própria. | E | Caractere | 0-1 | 100 | 1.0 |
| 3.10 | Pedagio | Objeto que contém informações relacionadas a compra do pedágio caso habilitada | G | 0-1 | 1.0 | ||
| 3.10.1 | Status | Enumeração de indicador de sucesso na comunicação com fornecedor de pedágio, podendo ser: 0: CompraSolicitada; 1: Erro; 2: NaoRealizado; 3: CancelamentoSolicitado; 4: CompraConfirmada; 5: CancelamentoConfirmado. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 3.10.2 | Mensagem | Mensagem com indicador da mensagem de falha do processo. | E | Caractere | 0-1 | 200 | 1.0 |
| 3.10.3 | Valor | Valor solicitado para carga de pedágio | E | Decimal | 1-1 | 10,2 | 1.0 |
| 3.10.4 | EstornoSaldoResidualSolicitado | Indicador se foi solicitado estorno de saldo residual nesta compra | E | Booleano | 1-1 | True/False | 1.0 |
| 3.10.5 | ProtocoloValePedagio | Número de protocolo do registro de pedágio na ANTT. | E | Caractere | 0-1 | 14 | 1.0 |
| 3.10.6 | ProtocoloEnvioValePedagio | Número de protocolo do registro de envio do pedágio para ANTT. Deve ser informado no MDF-e o campo sem os 8 primeiros dígitos que identificam a Fornecedora de Vale-Pedágio obrigatório; |
E | Caractere | 0-1 | 28 | 1.0 |
| 3.10.7 | Fornecedor | Enumeração com o fornecedor do pedágio, podendo ser: 0: Desabilitado (padrão); 1: Moedeiro: Carga no cartão moedeiro Extratta (Descontinuado pela ANTT); 2: Via Fácil (Sem Parar); 3: Move Mais; 4: Veloe; 5: Tag Extratta; 6: ConectCar; 7: Taggy Edenred. |
E | Inteiro | 1-1 | 1 | 1.0 |
| 3.10.8 | AvisoTransportador | Mensagem de aviso cadastrada pela ANTT para o contratado. Sempre que existir esta mensagem, sua apresentação ao transportador e impressão no documento correspondente é obrigatória. | E | Caractere | 0-1 | 300 | 1.0 |
| 3.11 | IntegracoesPreViagem | Objeto que contém dados das pré integrações realizadas | G | 0-1 | 1.0 | ||
| 3.11.1 | ClienteOrigem | Objeto com os dados da integração de um cliente do tipo origem | G | 0-1 | 1.0 | ||
| 3.11.1.1 | Sucesso | Resultado da requisição, caso não passe por uma validação de negócio ou um erro interno do sistema será 'false' | E | Booleano | 1-1 | True/False | 1.0 |
| 3.11.1.2 | Mensagem | Mensagem do resultado da requisição | E | Caractere | 0-1 | 200 | 1.0 |
| 3.11.2 | ClienteDestino | Objeto com os dados da integração de um cliente do tipo destino | G | 0-1 | 1.0 | ||
| 3.11.2.1 | Sucesso | Resultado da requisição, caso não passe por uma validação de negócio ou um erro interno do sistema será 'false' | E | Booleano | 1-1 | True/False | 1.0 |
| 3.11.2.2 | Mensagem | Mensagem do resultado da requisição | E | Caractere | 0-1 | 200 | 1.0 |
| 3.11.3 | Proprietario | Objeto com os dados da integração do proprietário | G | 0-1 | 1.0 | ||
| 3.11.3.1 | Sucesso | Resultado da requisição, caso não passe por uma validação de negócio ou um erro interno do sistema será 'false' | E | Booleano | 1-1 | True/False | 1.0 |
| 3.11.3.2 | Mensagem | Mensagem do resultado da requisição | E | Caractere | 0-1 | 200 | 1.0 |
| 3.11.4 | Motorista | Objeto com os dados da integração do motorista | G | 0-1 | 1.0 | ||
| 3.11.4.1 | Sucesso | Resultado da requisição, caso não passe por uma validação de negócio ou um erro interno do sistema será 'false' | E | Booleano | 1-1 | True/False | 1.0 |
| 3.11.4.2 | Mensagem | Mensagem do resultado da requisição | E | Caractere | 0-1 | 200 | 1.0 |
| 3.11.5 | Veiculo | Objeto com os dados da integração do veículo | G | 0-1 | 1.0 | ||
| 3.11.5.1 | Sucesso | Resultado da requisição, caso não passe por uma validação de negócio ou um erro interno do sistema será 'false' | E | Booleano | 1-1 | True/False | 1.0 |
| 3.11.5.2 | Mensagem | Mensagem do resultado da requisição | E | Caractere | 0-1 | 200 | 1.0 |
| 4 | Faults | Objeto pai que contém uma lista de erro(s) ou aviso(s) caso aconteça | A | ||||
| 4.1 | Type | Tipo de erro ou aviso, podendo ser eles: 1 - Error; 2 - Alert. |
E | Inteiro | 0-1 | 1 | 1.0 |
| 4.2 | Code | Codigo do erro | E | Caractere | 0-1 | 10 | 1.0 |
| 4.3 | Message | Mensagem do erro | E | Caractere | 0-1 | 200 | 1.0 |
Modelo de Json - Response
{
"Sucesso": true,
"Mensagem": "",
"Objeto": {
"IdViagem": 0,
"NumeroDocumento": "",
"IdsViagemEstabelecimento": [],
"Irrpf": 0.0,
"Inss": 0.0,
"SestSenat": 0.0,
"Eventos": [
{
"IdViagemEvento": 0,
"NumeroControle": "",
"Token": "",
"TipoEventoViagem": 0,
"OperacaoCartao": {
"Status": 0,
"Mensagem": ""
},
"IdsViagemDocumento": [
{
"IdViagemDocumento": 0,
"NumeroDocumento": 0
}
],
"IdsViagemOutrosDescontos": [],
"ViagemOutrosDescontos": [
{
"IdViagemDocumento": 0,
"NumeroDocumento": 0,
"Descricao": "",
"Valor": 0.0
}
],
"IdsViagemOutrosAcrescimos": [],
"ViagemOutrosAcrescimos": [
{
"IdViagemDocumento": 0,
"NumeroDocumento": 0,
"Descricao": "",
"Valor": 0.0
}
],
}
],
"Ciot": {
"Resultado": 0,
"Declarado": true,
"Mensagem": "",
"Dados": {
"Ciot": "",
"Verificador": "",
"Senha": "",
"EmContigencia": false,
"DataDeclaracao": "",
"AvisoTransportador": ""
}
},
"DadosAntt": {
"AltoDesempenho": false,
"DestinacaoComercial": false,
"FreteRetorno": false,
"CEPRetorno": "",
"DistanciaRetorno": 0.0,
"ComposicaoVeicular": false,
"TipoCarga": 0,
"TipoOperacao": 0,
"ContratantesCargaFrac": [
"00000000000000"
],
"RetornoVazio": false,
"CiotFrotaPropria": {
"CnpjCpfContratante": "00000000000000",
"RazaoSocialContratante": "NOME DO CONTRATANTE"
},
"Origem": {
"Cep": "",
"CodIbge": 0,
"Latitude": 0.0,
"Longitude": 0.0
},
"Destino": {
"Cep": "",
"CodIbge": 0,
"Latitude": 0.0,
"Longitude": 0.0
},
"OrigemDestino": [
{
"Origem": {
"Latitude": -22.906847,
"Longitude": -43.172897,
"Cep": null,
"CodIbge": null
},
"Destino": {
"Latitude": -22.906847,
"Longitude": -43.172897,
"Cep": null,
"CodIbge": null
},
"DistanciaPercorrida": 200
}
],
"PesoSaida": 0.0,
"MotivoCancelamento": ""
},
"Pedagio": {
"Status": 0,
"Mensagem": "",
"Valor": 0.0,
"EstornoSaldoResidualSolicitado": false,
"ProtocoloValePedagio": "",
"ProtocoloEnvioValePedagio": "",
"AvisoTransportador": "",
"Fornecedor": 2,
},
"IntegracoesPreViagem": {
"ClienteOrigem": {
"Sucesso": true,
"Mensagem": ""
},
"ClienteDestino": {
"Sucesso": true,
"Mensagem": ""
},
"Proprietario": {
"Sucesso": true,
"Mensagem": ""
},
"Motorista": {
"Sucesso": true,
"Mensagem": ""
},
"Veiculo": {
"Sucesso": true,
"Mensagem": ""
}
}
},
"Faults": [
{
"Type": 0,
"Code": "",
"Message": ""
}
]
}