DOCUMENTAÇÃO CORPORATIVA
BuscarCompraValePedagio
Objetivo
Esse método tem como objetivo, realizar a busca de 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.
BuscaCompraValePedagioRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | IdStatusValePedagio | int | Não | Status atual da compra de VP | 1= Aguardando 2= Confirmada 3= Cancelada |
2 | DataInicioPeriodo | Datetime (YYYY-MM-DD) | Não | Data de Início das compras a serem buscadas. | N/A |
3 | DataFimPeriodo | Datetime (YYYY-MM-DD) | Não | Data Fim das compras a serem buscadas. | N/A |
4 | IdCompraValePedagio | int | Não | ID de transação emitido no momento da compra. | N/A |
5 | IdModoCompraValePedagio | int | Sim | Informa se deseja buscar modos de compra específicos. | 1= Cartão Target Bradesco 5= Veloe |
BuscarCompraValePedagioResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
0 | Sucesso | bool (true || false) | Não | Confirmação se o cadastro foi efetivado com sucesso. | N/A |
0 | MensagemRetorno | string | Não | Mensagem indicando o tipo de retorno da função. | N/A |
1 | ComprasValePedagioPendentes | List< CompraValePedagioGeralResponse> | N/A | Response - Compras Vale Pedágio Pendentes | N/A |
CompraValePedagioGeralResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | TipoCompra | int | Sim | Tipo da Compra Pendente | 1= Cartão Target Bradesco 2= Via-Fácil |
2 | IdCompra | int | Sim | Código identificador da Compra no Sistema Target Frete | N/A |
3 | DataHoraCompra | Datetime (YYYY-MM-DD) | Sim | Data e Hora da Compra | N/A |
4 | TagOuCartao | string | Sim | Indica se a Compra foi por Tag ou Cartão | N/A |
5 | Valor | decimal | Sim | Valor do Compra | N/A |
6 | CiotFormatadoOperacaoTransporte | string | Não | CIOT da Operação de Transporte relacionada. | Caso Exista |
7 | Avulso | bool (true || false) | Sim | Indica se a Compra foi Avulsa ou não | N/A |
8 | PodeCancelarCompra | bool (true || false) | Sim | Indica se a Compra pode ser Cancelada | N/A |
9 | NomePortador | string | Sim | Nome do Portador do Cartão | N/A |
10 | NumeroCartão | string | Sim | Número do Cartão | N/A |
11 | NomeFantasia | string | Não | Nome Fantasia do Cliente da Operação de Transporte | N/A |
12 | DataHoraCargaConfirmacao | Datetime (YYYY-MM-DD) | Não | Data e Hora da Confirmação da Carga | N/A |
Método
Abaixo, segue o método - 'BuscarCompraValePedagio'.
BuscaCompraValePedagioRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:tar="http://schemas.datacontract.org/2004/07/TARGET.VectioFrete.Application.WCF.Contracts.External"> <soapenv:Header/> <soapenv:Body> <tem:BuscarCompraValePedagio> <tem:buscaCompraValePedagio> <tar:IdStatusValePedagio>?</tar:IdStatusValePedagio> <tar:DataInicioPeriodo>?</tar:DataInicioPeriodo> <tar:DataFimPeriodo>?</tar:DataFimPeriodo> <tar:IdCompraValePedagio>?</tar:IdCompraValePedagio> <tar:IdModoCompraValePedagio>?</tar:IdModoCompraValePedagio> </tem:buscaCompraValePedagio> </tem:BuscarCompraValePedagio> </soapenv:Body> </soapenv:Envelope>