Consulta de Viagens
Método responsável por realizar a consulta das viagens.
Este método é muito utilizado para buscar informações de viagem cujo o ERP/TMS não conseguiu obter, por exemplo o IdViagem. Sendo assim, via documento conseguem obter a informação dos Ids.
Sugerimos o uso de envio composto de informações (exemplo CPFMotorista + NumeroControle + DataLancamentoInicial para maior acuracidade das informações e evitar retornos errados).
Request
- ENDPOINT: Viagem/Consultar
- VERBO: POST
| Índice | Chave | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | CNPJAplicacao | CNPJ para autenticação da Empresa | E | Caractere | 1-1 | 14 | 1.0 |
| 2 | CNPJEmpresa | CNPJ para autenticação da Empresa | E | Caractere | 1-1 | 14 | 1.0 |
| 3 | Token | Gerado a partir do CNPJ de autenticação para validar permissões de acesso | E | Caractere | 1-1 | 100 | 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 | CPFMotorista | CPF do motorista responsável pela viagem | E | Caractere | 1-0 | 11 | 1.0 |
| 7 | StatusViagem | Status da viagem para filtro. 1 = Aberta; 2 = Programada; 3 = Cancelada; 4 = Bloqueada; 5 = Baixada; | E | Inteiro | 1-0 | 1 | 1.0 |
| 8 | TokenViagem | Token específico de uma viagem | E | Caractere | 1-0 | 100 | 1.0 |
| 9 | DataLancamentoInicial | Data inicial de lançamento das viagens | E | Data | 1-0 | yyyy-MM-dd | 1.0 |
| 10 | DataLancamentoFinal | Data final de lançamento das viagens | E | Data | 1-0 | yyyy-MM-dd | 1.0 |
| 11 | IdsViagem | Lista de identificadores / códigos da viagem (IdViagem) | A | Inteiro | 1-0 | 1.0 | |
| 12 | NumerosControle | Lista de Número de Documentos (NumeroDocumento) | A | Caractere | 1-0 | 1.0 |
Modelo de Json - Request
{
"CNPJAplicacao": "",
"CNPJEmpresa": "",
"Token": "",
"DocumentoUsuarioAudit": "",
"NomeUsuarioAudit": "",
"CPFMotorista": "",
"StatusViagem": 1,
"TokenViagem": "",
"DataLancamentoInicial": "2024-12-31",
"DataLancamentoFinal": "2024-12-31",
"IdsViagem": [0],
"NumerosControle": [""]
}
Response
| Índice | Chave | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 3.41.5 | DadosANTT | Dados enviados para a ANTT | G | 0-1 | 1.0 | ||
| 3.41.5.1 | AltoDesempenho | Indicação se o veículo é de alto desempenho | E | Booleano | 1-1 | True/False | 1.0 |
| 3.41.5.2 | DestinacaoComercial | Indicação se a destinação da operação é comercial | E | Booleano | 1-1 | True/False | 1.0 |
| 3.41.5.3 | FreteRetorno | Indicação se há frete de retorno | E | Booleano | 1-1 | True/False | 1.0 |
| 3.41.5.4 | CEPRetorno | CEP do frete de retorno | E | Caractere | 0-1 | 8 | 1.0 |
| 3.41.5.5 | DistanciaRetorno | Distância do frete de retorno em KM | E | Inteiro | 0-1 | 10 | 1.0 |
| 3.41.5.6 | TipoCarga | Tipo da carga informado para validação da operação junto à ANTT | E | Enum | 0-1 | 1.0 | |
| 3.41.5.7 | ContratantesCargaFrac | Lista de CPF/CNPJ dos contratantes da carga fracionada | A | Caractere | 0-1 | 14 | 1.0 |
| 3.41.5.7.1 | CpfCnpj | CPF ou CNPJ do contratante informado no array ContratantesCargaFrac | E | Caractere | 0-N | 14 | 1.0 |
| 3.41.5.8 | Origem | Grupo de informações de localização da origem da viagem | G | 0-1 | 1.0 | ||
| 3.41.5.8.1 | Cep | CEP da origem da viagem | E | Caractere | 0-1 | 8 | 1.0 |
| 3.41.5.8.2 | CodIbge | Código IBGE do município de origem | E | Inteiro | 0-1 | 7 | 1.0 |
| 3.41.5.8.3 | Latitude | Latitude da origem da viagem | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.8.4 | Longitude | Longitude da origem da viagem | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.9 | Destino | Grupo de informações de localização do destino da viagem | G | 0-1 | 1.0 | ||
| 3.41.5.9.1 | Cep | CEP do destino da viagem | E | Caractere | 0-1 | 8 | 1.0 |
| 3.41.5.9.2 | CodIbge | Código IBGE do município de destino | E | Inteiro | 0-1 | 7 | 1.0 |
| 3.41.5.9.3 | Latitude | Latitude do destino da viagem | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.9.4 | Longitude | Longitude do destino da viagem | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.10 | 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.41.5.10.1 | Origem | Grupo de informações de localização da origem do trecho | G | 0-1 | 1.0 | ||
| 3.41.5.10.1.1 | Latitude | Latitude da origem do trecho | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.10.1.2 | Longitude | Longitude da origem do trecho | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.10.1.3 | Cep | CEP da origem do trecho | E | Caractere | 0-1 | 8 | 1.0 |
| 3.41.5.10.1.4 | CodIbge | Código IBGE do município de origem do trecho | E | Inteiro | 0-1 | 7 | 1.0 |
| 3.41.5.10.2 | Destino | Grupo de informações de localização do destino do trecho | G | 0-1 | 1.0 | ||
| 3.41.5.10.2.1 | Latitude | Latitude do destino do trecho | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.10.2.2 | Longitude | Longitude do destino do trecho | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.10.2.3 | Cep | CEP do destino do trecho | E | Caractere | 0-1 | 8 | 1.0 |
| 3.41.5.10.2.4 | CodIbge | Código IBGE do município de destino do trecho | E | Inteiro | 0-1 | 7 | 1.0 |
| 3.41.5.10.3 | DistanciaPercorrida | Distância percorrida entre a origem e o destino do trecho | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.11 | RetornoVazio | Indicação se a viagem possui retorno vazio | E | Booleano | 0-1 | True/False | 1.0 |
| 3.41.5.12 | CiotFrotaPropria | Grupo de informações para declaração do CIOT de frota própria | G | 0-1 | 1.0 | ||
| 3.41.5.12.1 | CnpjCpfContratante | CPF ou CNPJ do contratante da operação de frota própria | E | Caractere | 0-1 | 14 | 1.0 |
| 3.41.5.12.2 | RazaoSocialContratante | Razão social do contratante da operação de frota própria | E | Caractere | 0-1 | 100 | 1.0 |
| 3.41.5.13 | DistanciaViagem | Distância da viagem em KM | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.14 | ComposicaoVeicular | Indicação se a operação possui composição veicular | E | Booleano | 0-1 | True/False | 1.0 |
| 3.41.5.15 | PesoSaida | Peso de saída da viagem | E | Decimal | 0-1 | 1.0 | |
| 3.41.5.16 | MotivoCancelamento | Motivo do cancelamento da declaração/operação, quando aplicável | E | Caractere | 0-1 | 200 | 1.0 |
Modelo de Json - Response
{
"Sucesso": true,
"Mensagem": "",
"Objeto": [
{
"IdViagem": 0,
"IdEmpresa": 0,
"RazaoSocialEmpresa": "",
"PaisClienteOrigem": "",
"UFClienteOrigem": "",
"CidadeClienteOrigem": "",
"PaisClienteDestino": "",
"UFClienteDestino": "",
"CidadeClienteDestino": "",
"PaisClienteTomador": "",
"UFClienteTomador": "",
"CidadeClienteTomador": "",
"QuantidadeCargas": 0,
"NumeroDocumento": "",
"NumeroControle": "",
"DataEmissao": "2024-12-31 23:59:59",
"Produto": "",
"Unidade": 0,
"Quantidade": 0.0,
"CPFCNPJClienteTomador": "",
"ValorPedagio": 0.0,
"IRRPF": 0.0,
"INSS": 0.00,
"SESTSENAT": 0.0,
"StatusViagem": 3,
"TokenViagem": "",
"PesoChegada": 0.0,
"PesoSaida": 0.0,
"PesoDiferenca": 0.0,
"ValorMercadoria": 0.0,
"ValorQuebraMercadoria": 0.0,
"DataLancamento": "2024-12-31 23:59:59",
"CepOrigem": "",
"CepDestino": "",
"CodigoTipoCarga": 0,
"DistanciaViagem": 0,
"DadosPagamento": {
"FormaPagamento": 0,
"CodigoBacen": "",
"Agencia": "",
"Conta": "",
},
"ViagemRegras": [
{
"TaxaAntecipacao": 0.0,
"ToleranciaPeso": 0.0,
"TarifaTonelada": 0.0,
"TipoQuebraMercadoria": 0
}
],
"ViagemEstabelecimentos": {
"IdViagemEstabelecimento": 0,
"IdEstabelecimento": 0,
"IdViagem": 0,
"TipoEventoViagem": 0,
},
"ViagemEventos": [
{
"IdViagem": 0,
"IdViagemEvento": 0,
"IdProtocolo": 0,
"IdEstabelecimentoBase": 0,
"TipoEvento": 1,
"ValorPagamento": 0.0,
"ValorTotalPagamento": 0.0,
"ValorBruto": 0.00,
"DataPagamento": "",
"HoraPagamento": "",
"NumeroRecibo": "",
"NumeroControle": "",
"Instrucao": "",
"Token": "",
"ValorBruto": 0.0,
"Status": 1,
"SESTSENAT": 0.0,
"IRRPF": 0.0,
"INSS": 0.0,
"OrigemPagamento": 0,
"ViagemDocumentos": [
{
"IdDocumento": 0,
"IdEvento": 0,
"TipoEvento": 0,
"Descricao": "",
"TipoDocumento": 1,
"NumeroDocumento": 0,
"ObrigaAnexo": false
}
],
"ViagemOutrosDescontos": [
{
"IdViagemOutrosDescontos": 0,
"NumeroDocumento": 0,
"Descricao": "",
"Valor": 0.0
}
],
"ViagemOutrosAcrescimos": [
{
"IdViagemOutrosDescontos": 0,
"NumeroDocumento": 0,
"Descricao": "",
"Valor": 0.0
}
],
}
],
"CIOT": {
"Resultado": 0,
"Declarado": true,
"Mensagem": "",
"Dados": {
"Ciot": "",
"TipoOperacao": 0,
"Verificador": "",
"Senha": "",
"EmContigencia": false,
"DataDeclaracao": "2024-12-04 17:31:01",
"AvisoTransportador": ""
},
"DadosAntt": {
"AltoDesempenho ": false,
"DestinacaoComercial": false,
"FreteRetorno": false,
"CEPRetorno": "",
"TipoCarga": 0,
"ContratantesCargaFrac": [
"00000000000000"
],
"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
}
],
"RetornoVazio": false,
"CiotFrotaPropria": {
"CnpjCpfContratante": "00000000000000",
"RazaoSocialContratante": "NOME DO CONTRATANTE"
},
"DistanciaViagem": 0.0,
"ComposicaoVeicular": false,
"PesoSaida": 0.0,
"DistanciaRetorno": 0,
"MotivoCancelamento": ""
}
},
"ViagemDocumentosFiscais": [
{
"IdViagemDocumentoFiscal": 0,
"NumeroDocumento": 0.0,
"Serie": "",
"PesoSaida": 0.0,
"Valor": 0.0,
"IdClienteOrigem": 0,
"IdClienteDestino": 0,
"TipoDocumento": 1,
"Chave": ""
}
],
"Pedagio": {
"Status": 0,
"Mensagem": "",
"Valor": 0.0,
"ProtocoloRequisicao": 0,
"ProtocoloProcessamento": 0,
"EstornoSaldoResidualSolicitado": false,
"ProtocoloValePedagio": "",
"ProtocoloEnvioValePedagio": "",
"AvisoTransportador": "",
"Fornecedor": 1,
}
}
]
}