Retorno da consulta de VPO
O arquivo de retorno de Consulta de Operação de Vale-Pedágio terá a seguinte nomenclatura:
RetCovp_NomeDoArquivoOriginal_ddMMyyyyHHmmssfff.xml
Abaixo segue a especificação do arquivo de retorno de Consulta de Operação de Vale-Pedágio, que será gerado pela solução nddCargo na pasta de integração, após o envio desta através do Agente.
As informações abaixo, até o registro 0120 serão retornados conforme os dados enviados no arquivo de solicitação. Portanto, serão uma repetição da solicitação.
Campo | Elem. | Pai | Tipo | Ocor. | Tam. | Dec. | Observação |
---|---|---|---|---|---|---|---|
retornoConsultaOperacaoValePedagio | Raiz |
|
| 1 |
|
|
|
mensagens | Raiz | retornoConsultaOperacaoValePedagio |
| 0-1 |
|
| Dados das mensagens |
mensagem | Raiz | mensagens |
| 1-N |
|
| Dados da mensagem de retorno |
categoria | E | mensagem | N | 1 | 3 |
| Categoria da mensagem |
codigo | E | mensagem | N | 1 | 1-3 |
| Código de mensagem de retorno |
mensagem | E | mensagem | S | 1 | 1-2000 |
| |
observacao | E | mensagem | S | 0-1 | 1-2000 |
| Observação sobre a mensagem. Neste campo poderão ser apresentadas informações mais técnicas sobre o que ocorreu no processo. |
envioConsultarOperacaoValePedagio | Raiz | retornoConsultaOperacaoValePedagio |
| 0-1 |
|
| Dados da solicitação |
ID | A | envioConsultarOperacaoValePedagio | S | 0-1 |
|
| GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo. |
Id | A | envioConsultarOperacaoValePedagio | S | 0-1 |
|
| GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima. |
token | A | envioConsultarOperacaoValePedagio | 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. |
cnpj | E | envioConsultarOperacaoValePedagio | N | 1 | 14 |
| CNPJ da contratante ou agrupador que está realizando a emissão. Este CNPJ deve será utilizado para validar a assinatura. |
autorizacao | Raiz | envioConsultarOperacaoValePedagio |
| 1 |
|
| Dados da Autorização |
cnpj | E | autorizacao | N | 1 | 14 |
| CNPJ da contratante para a qual está sendo emitida a operação de vale-pedágio. |
ndvp | Raiz | autorizacao |
| 1 |
|
| Identificação através do NDVP. Deverá ser informado este elemento ou o ide |
numero | E | ndvp | N | 1 | 12 |
| Número do NDVP |
ndvpCodVerificador | E | ndvp | N | 1 | 4 |
| Protocolo de autorização do NDVP |
ide | Raiz | autorizacao |
| 1 |
|
| Identificação da Operação de Vale-Pedágio. Deverá ser informado este elemento ou o ndvp |
numero | E | ide | N | 1 | 1-9 |
| Número para a operação de vale-pedágio. |
serie | E | ide | N | 1 | 1-4 |
| Série para operação de vale-pedágio. |
retConsultarOperacaoValePedagio | Raiz | retornoConsultaOperacaoValePedagio |
| 0-1 |
|
| Dados do retorno da consulta |
ide | Raiz | retConsultarOperacaoValePedagio |
| 1 |
|
| Dados de identificação |
ndvp | Raiz | ide |
| 1 |
|
| Identificação através do NDVP. |
numero | E | ndvp | N | 1 | 12 |
| Número do NDVP |
ndvpCodVerificador | E | ndvp | N | 1 | 4 |
| Protocolo de autorização do NDVP |
numero | E | ide | N | 1 | 1-9 |
| Número para a operação de vale-pedágio. |
serie | E | ide | N | 1 | 1-4 |
| Série para operação de vale-pedágio. |
ptEmissor | E | ide | S | 1 | 1-30 |
| Ponto emissor responsável pela operação de vale-pedágio. |
gestoraCartao | E | ide | N | 1 | 3 |
| Gestora de cartão Dock - 009. Código de identificação da gestora de cartão que será usada para o pagamento. |
transportador | Raiz | retConsultarOperacaoValePedagio |
| 1 |
|
| Informações sobre o transportador |
rntrc | E | transportador | N | 1 | 9 |
| RNTRC do transportador responsável pela prestação de serviço e que receberá os valores do transporte |
cpfTransportador | E | transportador | S | 1 | 11 |
| CPF do transportador Deverá ser informado este elemento ou o cnpjTransportador |
cnpjTransportador | E | transportador | S | 1 | 14 |
| CNPJ do transportador Deverá ser informado este elemento ou o cpfTransportador |
nome | E | transportador | S | 1 | 1-150 |
| Nome do Transportador |
condutorFavorecido | Raiz | retConsultarOperacaoValePedagio |
| 1 |
|
| Dados do condutor. |
cpf | E | condutorFavorecido | N | 1 | 11 |
| CPF do condutor |
nome | E | condutorFavorecido | S | 1 | 1-150 |
| Nome do condutor |
pedagio | Raiz | retConsultarOperacaoValePedagio |
| 1 |
|
| Dados do Pedágio |
valor | E | pedagio | N | 1 | 1-13 | 2 | Valor do pedágio |
origem | E | pedagio | S | 0-1 | 1-200 |
| Cidade e estado de origem |
destino | E | pedagio | S | 0-1 | 1-200 |
| Cidade e estado de destino |
pracas | Raiz | pedagio |
| 0-1 |
|
| Dados das praças de pedágio. |
praca | Raiz | pracas |
| 1-N |
|
| Dados da praça. |
nome | E | praca | S | 1 | 1-200 |
| Nome da praça de pedágio |
valor | E | praca | N | 1 | 1-13 | 2 | Valor a ser pago no pedágio |
localizacao | E | praca | S | 1 | 1-200 |
| Localização da praça de pedágio |
statusPgto | E | retConsultarOperacaoValePedagio | N | 1 | 1 |
| Campo que define o status do pagamento do pedágio. 0 = Em aberto 1 = Pago 2 = Cancelado |
dataPagamento | E | retConsultarOperacaoValePedagio | D | 0-1 |
|
| Data em que o pagamento do pedágio foi realizado. Padrão: AAAA-MM-DD HH:MM:SS |
operacaoTransporte | E | retConsultarOperacaoValePedagio | S | 0-1 | 1-150 |
| Identificação da operação de transporte. Este campo deve ser utilizado quando há obrigatoriedade de vinculo do pagamento de pedágio há uma operação de transporte. |
observacao | E | retConsultarOperacaoValePedagio | S | 0-1 | 1-500 |
| Observação livre da operação de vale pedágio. Será exibida na impressão do NDVP. |
tag | Raiz | retConsultarOperacaoValePedagio |
| 1 |
|
| Informações de TAG de pedágio |
dataInicio | E | tag | D | 1 |
|
| Formato AAAA-MM-DD. |
dataFinal | E | tag | D | 1 |
|
| Formato AAAA-MM-DD. |
placa | E | tag | C | 1 | 7 |
|
|
categoriaPedagio | E | tag | N | 1 | 1-2 |
| Valores possíveis disponíveis nos anexos. |
idValePedagio | E | tag | N | 1 | 28 |
| Identificador do vale pedágio ANTT. |
numeroTag | E | tag | N | 1 | 1-30 |
| Número da tag. |