Objetivo

Realizar compras de Vale Pedágio Cartão ou TAG - 'Sem Parar'.

Observações Importantes

Antes de realizar uma compra de vale pedágio, será necessário realizar o cadastro de uma rota em nossa Plataforma Web ou através do método - CadastrarRoteiro.
Caso o usuário queira efetuar a compra de um Vale Pedágio Cartão, e o cartão for do tipo VTG 100 ou VTG 200, será necessário associar o mesmo a um portador através do método - AssociarSubstituirCartao.

Fluxo

Request

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
CompraValePedagioRequest
1	IdModoCompraValePedagio	int	Sim	Id de em que meio de pagamento será feita a carga.	1= Cartão Target 2= TAG
2	IdRotaModelo	int	Sim	ID da Rota cadastrada no Sistema TARGET Frete através da Plataforma Web ou do método - CadastrarRoteiro.	N/A
3	CodigoCategoriaVeiculo	int	Sim	Código de Categoria do Veículo para qual a compra será feita.
4	MunicipioOrigemCodigoIBGE	int	Não	Código IBGE de Origem da Viagem.	Não é necessário informar o Código de Origem quando o Id da Rota for informado.
5	MunicipioDestinoCodigoIBGE	int	Não	Código IBGE de Destino da Viagem.	Não é necessário informar o Código de Destino quando o Id da Rota for informado.
6	Placa	string	Sim	Placa do Veículo que será feita a compra.	N/A
7	NumeroCartao	string	Não	Número do Cartão	Obrigatório somente quando o IdModoCompraValePedagio for igual a 1.
8	MotoristaNome	string	Sim	Nome do Motorista que será feita a compra.	N/A
9	MotoristaCPF	string	Sim	CPF do Motorista que será feita a compra.	N/A
10	MotoristaRNTRC	string	Sim	RNTRC do Motorista que será feita a compra.	N/A
11	IdIntegrador	string	Sim	Id do Integrador	ID único do sistema de TMS da transportadora. Campo validador, não aceitamos código iguais em compras diferentes.
12	CodigoCentroDeCusto	int	Não	Código do Centro de Custo no Sistema TARGET Frete caso utilizado.	N/A
13	NumeroDocumentoEmbarque	string	Não	Número do CT-e ou conhecimento caso deseje ser informado.	N/A
14	ItemFinanceiro	string	Não	Campo livre para registro de documentos que desejem ser associado à compra do VP.	N/A
15	InicioVigencia	DateTime(YYYY-MM-DD)	Sim	Início da Vigência	Obrigatório somente quando o IdModoCompraValePedagio for igual a 2.
16	FimVigencia	DateTime(YYYY-MM-DD)	Sim	Fim da Vigência	Obrigatório somente quando o IdModoCompraValePedagio for igual a 2.
17	ValorPrevioCalculado	int	Não	Caso tenha utilizado o método - ObterCustoRota, pode ser informado o valor aqui. Será feita uma validação, se os valores divergirem, a compra será feita de qualquer forma, mas no Objeto de retorno, será informado na mensagem que os valores diferem.	N/A
18	Simples	bool(true \|\| false)	Sim	Serve para definir se a compra a ser registrada é a completa, com mais campos obrigatórios para cadastro, ou simples, com uma quantidade menor de campos a serem informados obrigatoriamente.	Se a TAG for enviada como NULL, será considerado como se a mesma fosse false.
19	IdOperacaoTransporte	int	Não	Caso deseja associar a Operação de Trasporte TAC-Agregado com a compra do Vale Pedágio avulso, basta inserir o id da Operação de Transporte.	Apenas para Cadastros de Operações de Transporte do tipo TAC-Agregado.
20	DadosComplementares	List< Dados Complementares>	Não	DadosComplementares - Request	N/A

Request

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosComplementaresRequest
1	NomeUsuarioOperador	string	Não	Nome do Usuário - Operador	N/A
2	CpfUsuarioOperador	string	Não	CPF do usuário - Operador	N/A
3	NomeFilialOperador	string	Não	Nome da filial do Operador	N/A
4	CnpjFilialOperador	string	Não	CNPJ da Filial do Operador	N/A
5	LoginUsuarioOperador	string	Não	Login do Usuário Operador	N/A

Response

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
CompraValePedagioResponse
1	Erro	ErroResponse - string	Não	Retorna o Erro	NULO em caso de sucesso.
2	MensagemRetorno	string	sim	Mensagem indicando o tipo de retorno da função.	N/A
3	IdCompraValePedagio	int	sim	Id da Compra de Vale Pedágio	Esse ID deve ser armazenado. Pode ser utilizado depois para obter o valor da compra do Vale Pedágio no método ComprarPedagioAvulso e no ConfirmarPedagioTAG.
4	ValorCompra	decimal	sim		N/A

Método

CompraValePedagioRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:ComprarPedagioAvulso>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:compraRequest>
            <tms:IdModoCompraValePedagio>?</tms:IdModoCompraValePedagio>
            <tms:IdRotaModelo>?</tms:IdRotaModelo>
            <tms:CodigoCategoriaVeiculo>?</tms:CodigoCategoriaVeiculo>
            <tms:MunicipioOrigemCodigoIBGE>?</tms:MunicipioOrigemCodigoIBGE>
            <tms:MunicipioDestinoCodigoIBGE>?</tms:MunicipioDestinoCodigoIBGE>
            <tms:Placa>?</tms:Placa>
            <tms:NumeroCartao>?</tms:NumeroCartao>
            <tms:MotoristaNome>?</tms:MotoristaNome>
            <tms:MotoristaCPF>?</tms:MotoristaCPF>
            <tms:MotoristaRNTRC>?</tms:MotoristaRNTRC>
            <tms:IdIntegrador>?</tms:IdIntegrador>
            <tms:CodigoCentroDeCusto>?</tms:CodigoCentroDeCusto>
            <tms:NumeroDocumentoEmbarque>?</tms:NumeroDocumentoEmbarque>
            <tms:ItemFinanceiro>?</tms:ItemFinanceiro>
            <tms:InicioVigencia>?</tms:InicioVigencia>
            <tms:FimVigencia>?</tms:FimVigencia>
            <tms:ValorPrevioCalculado>?</tms:ValorPrevioCalculado>
            <tms:CompraSimples>?</tms:CompraSimples>
            <tms:IdOperacaoTransporte>?</tms:IdOperacaoTransporte>
            <tms:DadosComplementares>
               <tms:NomeUsuarioOperador>?</tms:NomeUsuarioOperador>
               <tms:CpfUsuarioOperador>?</tms:CpfUsuarioOperador>
               <tms:NomeFilialOperador>?</tms:NomeFilialOperador>
               <tms:CnpjFilialOperador>?</tms:CnpjFilialOperador>
               <tms:LoginUsuarioOperador>?</tms:LoginUsuarioOperador>
            </tms:DadosComplementares>
            <tms:CargaDiferencial>?</tms:CargaDiferencial>
         </tms:compraRequest>
      </tms:ComprarPedagioAvulso>
   </soapenv:Body>
</soapenv:Envelope>