...

Info
titleObservações Importantes
  1. Não é possível realizar rajadas para esse método, a TARGET limita uma quantidade X de requisições por minuto, aconselhamos requisições por demanda.
  2. A busca por período só retornará as compras realizadas no máximo nos últimos 90 dias.

...


Request

BuscaCompraValePedagioRequest
CampoTipoObrigatórioDescriçãoObservação
1QuantidadeItensPorPaginaintSimQuantidade de itens por página a serem retornadas.O máximo são 100 itens por página
2NumeroPaginaintSimNumero da pagina da lista a ser retornada.N/A
3IdModoCompraValePedagiointSimInforma se deseja buscar modos de compra específicos.1= Cartão
2= TAG
4IdStatusValePedagiointNãoStatus das compras a serem buscadas.1= Aguardando
2= Confirmada
3= Cancelada
5DataInicioPeriodoDatetime (YYYY-MM-DD)NãoData de Início das compras a serem buscadas.N/A
6DataFimPeriodoDatetime (YYYY-MM-DD)NãoData Fim das compras a serem buscadas.N/A
7IdCompraValePedagiointNãoID de transação emitido no momento da compra.N/A
8IdIntegradorintNãoId do IntegradorId de controle do Integrador.
9TipoBuscaUnitariaintNãoTipo Busca Unitária

1= PorIdEntidade (IdCompraValePedagio)

2= PorIdIntegrador (IdIntegrador)


Response

BuscaCompraValePedagioResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponseNãoRetorna o ErroNulo em caso de sucesso
2TipoComprastringSimTipo da CompraN/A
3IdCompraintSimId da CompraN/A
4DataHoraCompraDatetime (YYYY-MM-DD)SimData e Hora da Compra.N/A
5DataHoraCargaConfirmacaoDatetime (YYYY-MM-DD)NãoData e Hora da confirmação da carga.N/A
6TagOuCartaostringSimTAG ou CartãoN/A
7ValordecimalSimValor da CompraN/A
8CIOTstringNãoNúmero do CIOT, caso tenha sido comprado pode dentro do CIOT.N/A
9Varejobool (true || false)SimCaso tenha sido comprado de forma avulsa.N/A
10NomePortadorstringSimNome do Portador do Cartão.N/A
11OrigemComprastringSimSe foi feito fia portal ou integração WS.N/A
12PodeEmitirRecibobool (true || false)SimSe está pronto para emissão de recibo.N/A
13PodeCarregarbool (true || false)SimSe está pronto para ser carregado.N/A
14IdStatusCompraValePedagiointNãoStatus da Compra de Vale Pedágio1= Aguardando
2= Confirmada
3= Cancelada
15OrigemCargastringNãoLocal de onde a carga foi feita.N/A
16IdOperacaoTransporteintNãoID da viagem caso tenha sido comprado pode dentro do CIOT.N/A
17DocumentoRelacionadostringNãoNúmero de algum documento relacionado à compra.N/A
18NomeFantasiastringNãoNome Fantasia do comprador em caso de CNPJ.N/A
19CPFCondutorstringNãoCPF do Motorista portador.N/A
20PodeCancelarComprabool (true || false)Sim

Se ainda está apto para cancelamento.

No caso, se ainda não foi carregado.

N/A
21UsuarioCompradorstringSimUsuário que realizou a compra do VP. Em caso de integração será utilizado o usuário de WS do cliente.N/A
22NomeRotastringSimNome da Rota utilizada para definir o custo.N/A
23IdRotaintNãoID da Rota utilizada para definir o custo.N/A
24Simplesbool (true || false)NãoServe 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.N/A
25NumeroRecibostringNãoNúmero do Recibo do Vale PedágioN/A
26IdIntegradorstringNãoId IntegradorN/A
27SaldoAnteriorCartaodecimalNãoSaldo Anterior do CartãoN/A
28SaldoPosteriorCartaodecimalNãoSaldo Posterior do CartãoN/A
29ValorCarregadoCartaodecimalNãoValor Carregado no CartãoN/A


ResultadoPaginadoResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o ErroNULO em caso de sucesso
2ItensN/AN/AItensN/A
3NumeroPaginaintSimNúmero da PáginaN/A
4QuantidadeItensPorPaginaintSimQuantidade de Itens por PáginaN/A
5QuantidadeTotalItensintSimQuantidade Total de ItensN/A
6QuantidadeTotalPaginasintSimQuantidade Total de PáginasN/A

Método

Abaixo, segue o método - 'BuscaCompraValePedagioRequest'.

Code Block
languagexml
themeRDark
firstline1
titleBuscaCompraValePedagioRequest
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:BuscarCompraValePedagio>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:buscaCompraValePedagio>
            <tms:IdStatusValePedagio>?</tms:IdStatusValePedagio>
            <tms:QuantidadeItensPorPagina>?</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>?</tms:NumeroPagina>
            <tms:IdModoCompraValePedagio>?</tms:IdModoCompraValePedagio>
            <tms:DataInicioPeriodo>?</tms:DataInicioPeriodo>
            <tms:DataFimPeriodo>?</tms:DataFimPeriodo>
            <tms:IdCompraValePedagio>?</tms:IdCompraValePedagio>
            <tms:IdIntegrador>?</tms:IdIntegrador>
            <tms:TipoBuscaUnitaria>?</tms:TipoBuscaUnitaria>
         </tms:buscaCompraValePedagio>
      </tms:BuscarCompraValePedagio>
   </soapenv:Body>
</soapenv:Envelope>

...