Objetivo
Esse método tem como objetivo Buscar uma ou mais compras de Vale Pedágio.
Observações Importantes
- Não é possível realizar rajadas para esse método, a TARGET limita 50 requisições por minuto, aconselhamos requisições por demanda, caso o limite de 50 requisições seja ultrapassado, iremos bloquear as requisições apenas para o método que ultrapassou o limite durante 5 minutos.
- A busca por período só retornará as compras realizadas no máximo nos últimos 90 dias.
Request
BuscaCompraValePedagioRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | QuantidadeItensPorPagina | int | Sim | Quantidade de itens por página a serem retornadas. | O máximo são 99 itens por página |
2 | NumeroPagina | int | Sim | Numero da pagina da lista a ser retornada. | N/A |
3 | IdModoCompraValePedagio | int | Sim | Informa se deseja buscar modos de compra específicos. | 1= Cartão 3= Veloe |
4 | IdStatusValePedagio | int | Não | Status das compras a serem buscadas. | 1= Aguardando 2= Confirmada 3= Cancelada |
5 | DataInicioPeriodo | Datetime (YYYY-MM-DD) | Não | Data de Início das compras a serem buscadas. | Exemplo: (2018-08-20T10:05:33) |
6 | DataFimPeriodo | Datetime (YYYY-MM-DD) | Não | Data Fim das compras a serem buscadas. | Exemplo: (2018-08-20T10:05:33) |
7 | IdCompraValePedagio | int | Não | ID de transação emitido no momento da compra. | N/A |
8 | IdIntegrador | int | Não | Id do Integrador | Id de controle do Integrador. |
9 | TipoBuscaUnitaria | int | Não | Tipo Busca Unitária | 1= PorIdEntidade (IdCompraValePedagio) 2= PorIdIntegrador (IdIntegrador) |
Response
BuscaCompraValePedagioResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse | Não | Retorna o Erro | Nulo em caso de sucesso |
2 | TipoCompra | string | Sim | Tipo da Compra | N/A |
3 | IdCompra | int | Sim | Id da Compra | N/A |
4 | DataHoraCompra | Datetime (YYYY-MM-DD) | Sim | Data e Hora da Compra. | Exemplo: (2018-08-20T10:05:33) |
5 | DataHoraCargaConfirmacao | Datetime (YYYY-MM-DD) | Não | Data e Hora da confirmação da carga. | Exemplo: (2018-08-20T10:05:33) |
6 | TagOuCartao | string | Sim | TAG ou Cartão | N/A |
7 | Valor | decimal | Sim | Valor da Compra | N/A |
8 | CIOT | string | Não | Número do CIOT, caso tenha sido comprado pode dentro do CIOT. | N/A |
9 | Varejo | bool (true || false) | Sim | Caso tenha sido comprado de forma avulsa. | N/A |
10 | NomePortador | string | Sim | Nome do Portador do Cartão. | N/A |
11 | OrigemCompra | string | Sim | Se foi feito fia portal ou integração WS. | N/A |
12 | PodeEmitirRecibo | bool (true || false) | Sim | Se está pronto para emissão de recibo. | N/A |
13 | PodeCarregar | bool (true || false) | Sim | Se está pronto para ser carregado. | N/A |
14 | IdStatusCompraValePedagio | int | Não | Status da Compra de Vale Pedágio | 1= Aguardando 2= Confirmada 3= Cancelada |
15 | OrigemCarga | string | Não | Local de onde a carga foi feita. | N/A |
16 | IdOperacaoTransporte | int | Não | ID da viagem caso tenha sido comprado pode dentro do CIOT. | N/A |
17 | DocumentoRelacionado | string | Não | Número de algum documento relacionado à compra. | N/A |
18 | NomeFantasia | string | Não | Nome Fantasia do comprador em caso de CNPJ. | N/A |
19 | CPFCondutor | string | Não | CPF do Motorista portador. | N/A |
20 | PodeCancelarCompra | bool (true || false) | Sim | Se ainda está apto para cancelamento. No caso, se ainda não foi carregado. | N/A |
21 | UsuarioComprador | string | Sim | Usuário que realizou a compra do VP. Em caso de integração será utilizado o usuário de WS do cliente. | N/A |
22 | NomeRota | string | Sim | Nome da Rota utilizada para definir o custo. | N/A |
23 | IdRota | int | Não | ID da Rota utilizada para definir o custo. | N/A |
24 | Simples | bool (true || false) | Não | 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. | N/A |
25 | NumeroRecibo | string | Não | Número do Recibo do Vale Pedágio | N/A |
26 | IdIntegrador | string | Não | Id Integrador | N/A |
27 | SaldoAnteriorCartao | decimal | Não | Saldo Anterior do Cartão | N/A |
28 | SaldoPosteriorCartao | decimal | Não | Saldo Posterior do Cartão | N/A |
29 | ValorCarregadoCartao | decimal | Não | Valor Carregado no Cartão | N/A |
ResultadoPaginadoResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
2 | Itens | N/A | N/A | Itens | N/A |
3 | NumeroPagina | int | Sim | Número da Página | N/A |
4 | QuantidadeItensPorPagina | int | Sim | Quantidade de Itens por Página | N/A |
5 | QuantidadeTotalItens | int | Sim | Quantidade Total de Itens | N/A |
6 | QuantidadeTotalPaginas | int | Sim | Quantidade Total de Páginas | N/A |
Método
Abaixo, segue o método - 'BuscaCompraValePedagioRequest'.
BuscaCompraValePedagioRequest
<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>
Buscar Compra Vale Pedágio
Abaixo, segue exemplo do método Buscar Compra Vale Pedágio.
BuscaCompraValePedagioRequest
Request <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header/> <soapenv:Body> <tms:BuscarCompraValePedagio> <tms:auth> <tms:Usuario>tms.exemplo</tms:Usuario> <tms:Senha>v0hXPrwerKblaBs=</tms:Senha> <tms:Token i:nil="true" /> </tms:auth> <tms:buscaCompraValePedagio> <tms:IdStatusValePedagio i:nil="true" /> <tms:QuantidadeItensPorPagina>1</tms:QuantidadeItensPorPagina> <tms:NumeroPagina>1</tms:NumeroPagina> <tms:IdModoCompraValePedagio>2</tms:IdModoCompraValePedagio> <tms:DataInicioPeriodo i:nil="true" /> <tms:DataFimPeriodo i:nil="true" /> <tms:IdCompraValePedagio>178130</tms:IdCompraValePedagio> <tms:IdIntegrador i:nil="true" /> <tms:TipoBuscaUnitaria i:nil="true" /> </tms:buscaCompraValePedagio> </tms:BuscarCompraValePedagio> </soapenv:Body> </soapenv:Envelope> Response <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tmsfrete.v2.targetmp.com.br/FreteTMSService/BuscarCompraValePedagioResponse</Action> </s:Header> <s:Body> <BuscarCompraValePedagioResponse xmlns="http://tmsfrete.v2.targetmp.com.br"> <BuscarCompraValePedagioResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Erro i:nil="true" /> <Itens> <BuscaCompraValePedagioResponse> <Erro i:nil="true" /> <TipoCompra>ViaFacil</TipoCompra> <IdCompra>178130</IdCompra> <DataHoraCompra>2018-08-29T09:53:38.72</DataHoraCompra> <DataHoraCargaConfirmacao>2018-08-29T10:53:38.72</DataHoraCargaConfirmacao> <TagOuCartao>0710349620</TagOuCartao> <Valor>65.60</Valor> <CIOT>N/A</CIOT> <Varejo>true</Varejo> <NomePortador i:nil="true" /> <OrigemCompra i:nil="true" /> <PodeEmitirRecibo>false</PodeEmitirRecibo> <PodeCarregar>true</PodeCarregar> <IdStatusCompraValePedagio>2</IdStatusCompraValePedagio> <OrigemCarga i:nil="true" /> <IdOperacaoTransporte i:nil="true" /> <DocumentoRelacionado i:nil="true" /> <NomeFantasia>ADIMAX</NomeFantasia> <CPFCondutor i:nil="true" /> <PodeCancelarCompra>true</PodeCancelarCompra> <UsuarioComprador>adimax.tms</UsuarioComprador> <NomeRota>TOCO-CAMPINAS-PAULINIA</NomeRota> <IdRota>37161</IdRota> <Simples i:nil="true" /> <NumeroRecibo>000000024234463</NumeroRecibo> <IdIntegrador>37187</IdIntegrador> <SaldoAnteriorCartao>0.00</SaldoAnteriorCartao> <SaldoPosteriorCartao>65.60</SaldoPosteriorCartao> <ValorCarregadoCartao>65.60</ValorCarregadoCartao> </BuscaCompraValePedagioResponse> </Itens> <NumeroPagina>1</NumeroPagina> <QuantidadeItensPorPagina>20</QuantidadeItensPorPagina> <QuantidadeTotalItens>1</QuantidadeTotalItens> <QuantidadeTotalPaginas>1</QuantidadeTotalPaginas> </BuscarCompraValePedagioResult> </BuscarCompraValePedagioResponse> </s:Body> </s:Envelope>