Retorno do envio de VPO

retornoOperacaoValePedagio

Raiz

1

mensagens

Raiz

retornoOperacaoValePedagio

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

Descrição da mensagem

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.

envioOperacaoValePedagio

Raiz

retornoOperacaoValePedagio

0-1

Dados da solicitação

ID

A

envioOperacaoValePedagio

S

0-1

GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo.

Id

A

envioOperacaoValePedagio

S

0-1

GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima.

impAuto

A

envioOperacaoValePedagio

N

0-1

1

Informar se haverá a necessidade de impressão automática ou não.

1 = Sim

2 = Não

Por padrão haverá a impressão automática.

Este atributo não tem validade para integrações que não utilizam o módulo agente.

token

A

envioOperacaoValePedagio

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

envioOperacaoValePedagio

N

1

14

CNPJ da contratante ou agrupador que esta realizando a emissão. Este CNPJ deve será utilizado para validar a assinatura.

ide

Raiz

envioOperacaoValePedagio

1

Informações sobre a Operação de Vale-Pedágio

cnpj

E

ide

N

1

14

CNPJ da contratante para a qual está sendo emitida a operação de vale-pedágio.

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

envioOperacaoValePedagio

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

N

1

11

CPF do transportador

Deverá ser informado este elemento ou o cpfTransportador

cnpjTransportador

E

transportador

S

1

14

CNPJ do transportador

Deverá ser informado este elemento ou o cpfTransportador

infTransportador

Raiz

transportador

0-1

Dados do transportador para cadastro.

ide

Raiz

infTransportador

0-1

Identificação do tipo de transportador.

tac

Raiz

ide

0-1

Dados do Transportador TAC. Deverá ser informado este elemento ou o etc ou ctc.

nomeCompleto

E

tac

S

1

1-150

Nome completo do Transportador TAC.

nomeMae

E

tac

S

1

1-150

Nome da mãe do transportador TAC.

nomePai

E

tac

S

0-1

1-150

Nome do pai do transportador TAC.

dataNascimento

E

tac

D

1

Data de nascimento do transportador. Deve ser informado para a entrega de cartão a um TAC. Deverá ser informado caso o campo identidade seja informado.

Formato: AAAA-MM-DD

identidade

E

tac

S

1

1-20

Identidade do transportador.

O campo deve ser preenchido sem máscara. Deverá ser informado caso o campo dataNascimento seja informado.

etc

Raiz

ide

1

Dados do Transportador ETC. Deverá ser informado este elemento ou o tac ou ctc.

razaoSocial

E

etc

S

1

1-150

Razao social do Transportador ETC.

nomeFantasia

E

etc

S

1

1-150

Nome fantasia do Transportador ETC.

inscEstadual

E

etc

S

1

1-14

Inscricao estadual do Transportador ETC.

atividadePrincipal

E

etc

N

1

2

Ver anexo Lista de Atividades

formaConstituicao

E

etc

S

1

5

Ver anexo Lista e Formas de Constituicao

dataConstituicao

E

etc

D

1

Formato AAAA-MM-DD

socio

Raiz

etc

1

Dados do sócio do Transportador ETC

nomeCompleto

E

socio

S

1

1-150

Nome completo do sócio do Transportador ETC.

nomeMae

E

socio

S

1

1-150

Nome da mãe do sócio do Transportador ETC.

nomePai

E

socio

S

0-1

1-150

Nome do pai do sócio do Transportador ETC.

dataNascimento

E

socio

D

1

Data de nascimento do sócio do Transportador ETC.

cpf

E

socio

N

1

11

CPF do sócio do Transportador ETC.

identidade

E

socio

S

1

1-20

Identidade do sócio do Transportador ETC.

endereço

Raiz

socio

1

Dados de endereço do sócio do Transportador ETC.

UF

E

endereço

S

1

2

Sigla da Unidade Federativa sócio do Transportador ETC.

cidade

E

endereço

S

1

1-100

Nome da Cidade sócio do Transportador ETC.

bairro

E

endereço

S

1

1-255

Informar EXTERIOR caso seja do exterior.

logradouro

E

endereço

S

1

1-255

Informar EXTERIOR caso seja do exterior.

numero

E

endereço

N

0-1

1-8

número do endereço do sócio

CEP

E

endereço

N

0-1

8

Informar 0 caso seja do exterior.

complemento

E

endereço

S

0-1

1-255

CEP do sócio

telefone

E

endereço

N

1

10|11

Telefone do sócios do Transportador ETC.

email

E

endereço

S

0-1

1-255

Email do sócio do Transportador ETC

ctc

Raiz

ide

1

Dados de endereço do transportador CTC. Deverá ser informado este elemento ou o tac ou etc. .

razaoSocial

E

ctc

S

1

1-150

Razão social do Transportador CTC.

nomeFantasia

E

ctc

S

1

1-150

Nome fantasia do Transportador CTC.

inscEstadual

E

ctc

S

1

1-14

Inscrição Estadual do Transportador CTC.

atividadePrincipal

E

ctc

N

1

2

Ver anexo Lista de Atividades

formaConstituicao

E

ctc

S

1

5

Ver anexo Lista de Forma de Constituicao

dataConstituicao

E

ctc

D

1

Formato AAAA-MM-DD

socio

Raiz

ctc

1

Dados do sócio do Transportador CTC.

nomeCompleto

E

socio

S

1

1-150

Nome completo do sócio do Transportador CTC.

nomeMae

E

socio

S

1

1-150

Nome da mãe do sócio do Transportador CTC.

nomePai

E

socio

S

0-1

1-150

Nome do pai do sócio do Transportador CTC.

dataNascimento

E

socio

D

1

Data de nascimento do sócio do Transportador CTC.

cpf

E

socio

N

1

11

CPF do sócio do Transportador CTC.

identidade

E

socio

S

1

1-20

Identidade do sócio do Transportador CTC.

endereço

Raiz

socio

1

Dados de endereço do sócio do Transportador CTC.

UF

E

endereço

S

1

2

Sigla da Unidade Federativa do sócio.

cidade

E

endereço

S

1

1-100

cidade do sócio

bairro

E

endereço

S

1

1-255

Informar EXTERIOR caso seja do exterior.

logradouro

E

endereço

S

1

1-255

Informar EXTERIOR caso seja do exterior.

numero

E

endereço

N

0-1

1-8

número do endereço do sócio

CEP

E

endereço

N

0-1

8

Informar 0 caso seja do exterior.

complemento

E

endereço

S

0-1

1-255

complemento do sócio

telefone

E

socio

N

1

10|11

Telefone do sócio.

email

E

socio

S

0-1

1-255

Email do sócio

endereçoTransportador

Raiz

infTransportador

1

Dados de endereço do transportador TAC/ETC/CTC.

UF

E

endereçoTransportador

S

1

2

Sigla UF do transportador TAC/ETC/CTC.

cidade

E

endereçoTransportador

S

1

1-100

Código do município do transportador TAC/ETC/CTC.

bairro

E

endereçoTransportador

S

1

1-255

Bairro do transportador TAC/ETC/CTC.

logradouro

E

endereçoTransportador

S

1

1-255

Logradouro do transportador TAC/ETC/CTC.

numero

E

endereçoTransportador

N

0-1

1-8

Número do transportador TAC/ETC/CTC.

CEP

E

endereçoTransportador

N

0-1

8

CEP do transportador TAC/ETC/CTC.

complemento

E

endereçoTransportador

S

0-1

1-255

Complemento do endereço do transportador TAC/ETC/CTC.

telefone

E

infTransportador

N

1

10-11

Telefone celular do transportador.

Informar o número do celular do transportador, juntamente com o DDD. Caso não haja um número válido, informar 9999999999 ou 99999999999.

cartaoId

E

infTransportador

N

0-1

1-15

Identificador do cartão para vincular ao transportador.

email

E

infTransportador

S

0-1

1-255

E-mail do transportador.

condutorFavorecido

Raiz

envioOperacaoValePedagio

0-1

Dados do condutor.

cpf

E

condutorFavorecido

N

1

11

CPF do condutor

informacoes

Raiz

condutorFavorecido

0-1

Dados para cadastramento do condutor no nddCargo, juntamente com o CPF da tag anterior.

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 transportador. Deve ser informado para a entrega de cartão a um TAC

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

1

11

CPF do transportador

Deverá ser informado este elemento ou o cnpjTransportador

cnpjTransportador

E

informacoes

N

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

endereco

N

0-1

1-15

Número da CNH do condutor.

dataEmissaoCNH

E

endereco

D

0-1

Data de emissão da CNH do condutor.

Formato: AAAA-MM-DD

dataRenovacaoCNH

E

endereco

D

0-1

Data de vencimento da CNH do condutor.

Formato: AAAA-MM-DD

telefone

E

endereco

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

endereco

N

0-1

1-15

Identificação do cartão que foi entregue ao condutor, para que seja feito o vínculo na processadora.

infRota

Raiz

envioOperacaoValePedagio

0-1

Campos contendo os dados da rota para integração

categoriaPedagio

E

infRota

N

1

1-2

Categoria de pedágio.

Valores possíveis disponíveis nos anexos desse documento.

rota

Raiz

infRota

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 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

infRota

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

infRota

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

infRota

N

0-1

1-15

2

Total de quilômetros da rota.

notificarRespContratante

E

infRota

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

valor

E

envioOperacaoValePedagio

N

0-1

1-15

2

Valor de vale-pedágio a ser pago ao condutor da operação de vale-pedágio.

operacaoTransporte

E

envioOperacaoValePedagio

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

envioOperacaoValePedagio

S

0-1

1-500

Observação livre da operação de vale-pedágio. Será exibida na impressão do NDVP.

retOperacaoValePedagio

Raiz

retornoOperacaoValePedagio

0-1

Dados do retorno

ndvp

Raiz

retOperacaoValePedagio

1

Dados do NDVP

numero

E

ndvp

N

1

12

Número do NDVP.

ndvpCodVerificador

E

ndvp

N

1

4

Protocolo de autorização do NDVP.

dataHora

E

retOperacaoValePedagio

D

1

Data da emissão.

Data e hora que o processamento foi realizado. Padrão: AAAA-MM-DD HH:MM:SS

pedagio

Raiz

retOperacaoValePedagio

1

Dados do Pedágio

valor

E

pedagio

N

1

1-15

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-15

2

Valor a ser pago no pedágio.

localizacao

E

praca

S

1

1-200

Localização da praça de pedágio.

idValePedagio

E

retOperacaoValePedagio

N

0-N

28

Identificador do vale pedágio ANTT