DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Objetivo

Esse método tem como objetivo realizar uma busca por transações financeiras realizadas em nossa base de dados.


Observações Importantes

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

Request

BuscaTransacoesFinanceirasRequest
CampoTipoObrigatórioDescriçãoObservação
1QuantidadeItensPorPaginaintSimQuantidade de itens a serem trazidos em uma página.N/A
2NumeroPaginaintSimNúmero da página especificada de retorno.N/A
3TipoTransacaoFinanceiraintSim

Especifique aqui em qual tabela iremos buscar o resultado.

Caso seja utilziado a opção 7, TipoBuscaUnitaria e IdEntidadeTransacaoFinanceira não são obrigatórios.

1= OperacaoTransporteParcelas
2= ParcelaUnitaria
3= PagamentoAvulso
4= CombustivelAvulso
5= CompraValePedagio
6= CompraPedagioTAG
7= Todos
4TipoBuscaUnitariaintNãoEspecifique aqui o tipo da busca desejada e preencha o campo.1= PorIdEntidade
2= PorIdIntegrador
3= PorDocumentoRelacionado
5IdEntidadeTransacaoFinanceiraintSimID de Entidade da Transacao.N/A
6DataInicioPeriodoDateTime(YYYY-MM-DD)SimPeríodo de início de busca das transções.N/A
7DataFimPeriodoDateTime(YYYY-MM-DD)SimPeríodo final de busca das transções.N/A
8IdIntegradorstringNãoID Integrador único da compra.N/A
9DocumentoRelacionadostringNãoDocumento único relacionado à compraN/A
10Pagobool (true || false)SimEstá pago ou não.Quando Pago igual a true, a busca é feita pela data de pagamento e não através da data de registro.

Response

BuscaTransacoesFinanceirasResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o ErroNULO em caso de Sucesso
2TipoTransacaoFinanceirastringSimRetorna o Tipo da Transação Financeira.N/A
3IdEntidadeTransacaoFinanceiraintNãoRetorna o Id de Entidade da Transação Financeira.N/A
4IdOperacaoTransporteRelacionadaintSimRetorna o Id da Operação de CIOT, caso exista.N/A
5ValordecimalSimValor da OperaçãoN/A
6SituacaostringSimStatus da Operação no momento da busca.N/A
7ModoPagamentostringSimModo de pagamento para essa transação: Cartão, TAG e Depósito.N/A
8ComentariostringNãoComentário registrado na transação caso exista.N/A
9DataRegistroDateTime(YYYY-MM-DD)NãoData em que a transação foi registrada.N/A
10DataPagamentoDateTime(YYYY-MM-DD)NãoData em que a transação foi paga.N/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 método - 'BuscarTransacoesFinanceiras'.

BuscarTransacoesFinanceirasRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:BuscarTransacoesFinanceiras>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:buscaTransacoes>
            <tms:QuantidadeItensPorPagina>?</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>?</tms:NumeroPagina>
            <tms:TipoBuscaUnitaria>?</tms:TipoBuscaUnitaria>
            <tms:TipoTransacaoFinanceira>?</tms:TipoTransacaoFinanceira>
            <tms:IdEntidadeTransacaoFinanceira>?</tms:IdEntidadeTransacaoFinanceira>
            <tms:DataInicioPeriodo>?</tms:DataInicioPeriodo>
            <tms:DataFimPeriodo>?</tms:DataFimPeriodo>
            <tms:IdIntegrador>?</tms:IdIntegrador>
            <tms:DocumentoRelacionado>?</tms:DocumentoRelacionado>
            <tms:Pago>?</tms:Pago>
         </tms:buscaTransacoes>
      </tms:BuscarTransacoesFinanceiras>
   </soapenv:Body>
</soapenv:Envelope>


Buscar Transações Financeiras

Abaixo, segue um exemplo do método - 'BuscarTransacoesFinanceiras'.

Exemplo - BuscarTransacoesFinanceiras
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:BuscarTransacoesFinanceiras>
         <tms:auth>
            <tms:Usuario>tms.exemplo</tms:Usuario>
            <tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
            <tms:Token i:nil="true" />
         </tms:auth>
         <tms:buscaTransacoes>
            <tms:QuantidadeItensPorPagina>99</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>1</tms:NumeroPagina>
            <tms:TipoBuscaUnitaria i:nil="true" />
            <tms:TipoTransacaoFinanceira>7</tms:TipoTransacaoFinanceira>
            <tms:IdEntidadeTransacaoFinanceira i:nil="true" />
            <tms:DataInicioPeriodo>2018-09-03T00:00:00</tms:DataInicioPeriodo>
            <tms:DataFimPeriodo>2018-09-04T23:59:59</tms:DataFimPeriodo>
            <tms:IdIntegrador i:nil="true" />
            <tms:DocumentoRelacionado i:nil="true" />
            <tms:Pago>true</tms:Pago>
         </tms:buscaTransacoes>
      </tms:BuscarTransacoesFinanceiras>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <BuscarTransacoesFinanceirasResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
         <BuscarTransacoesFinanceirasResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Erro i:nil="true"/>
            <Itens>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2759505</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1850433</IdOperacaoTransporteRelacionada>
                  <Valor>80.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario>Teste</Comentario>
                  <DataRegistro>2023-06-01T17:12:37.457</DataRegistro>
                  <DataPagamento>2024-01-24T05:14:28.8</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.02</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2556910</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1716669</IdOperacaoTransporteRelacionada>
                  <Valor>1.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario/>
                  <DataRegistro>2023-02-14T18:43:03.59</DataRegistro>
                  <DataPagamento>2024-01-04T06:12:26.127</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.00</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2758900</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1850018</IdOperacaoTransporteRelacionada>
                  <Valor>30.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario>Teste</Comentario>
                  <DataRegistro>2023-06-01T14:37:31.967</DataRegistro>
                  <DataPagamento>2024-01-24T05:14:28.737</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.01</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2765659</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1854595</IdOperacaoTransporteRelacionada>
                  <Valor>200.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario>Teste</Comentario>
                  <DataRegistro>2023-06-05T13:09:11.71</DataRegistro>
                  <DataPagamento>2024-01-05T05:21:23.787</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.04</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2639521</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1774735</IdOperacaoTransporteRelacionada>
                  <Valor>7.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario/>
                  <DataRegistro>2023-03-30T10:50:02.487</DataRegistro>
                  <DataPagamento>2024-01-04T06:12:28.523</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.00</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>3219233</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>2142085</IdOperacaoTransporteRelacionada>
                  <Valor>5.50</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Pix</ModoPagamento>
                  <Comentario/>
                  <DataRegistro>2024-01-12T21:12:05.797</DataRegistro>
                  <DataPagamento>2024-01-12T21:14:23.58</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.00</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>3218516</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>2141631</IdOperacaoTransporteRelacionada>
                  <Valor>6.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Cartão</ModoPagamento>
                  <Comentario/>
                  <DataRegistro>2024-01-12T16:07:34.243</DataRegistro>
                  <DataPagamento>2024-01-12T20:27:41.087</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.00</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2761476</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1851680</IdOperacaoTransporteRelacionada>
                  <Valor>80.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario>Teste</Comentario>
                  <DataRegistro>2023-06-02T15:08:38.243</DataRegistro>
                  <DataPagamento>2024-01-24T05:14:28.63</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.02</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>3218432</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>2141577</IdOperacaoTransporteRelacionada>
                  <Valor>7.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Cartão</ModoPagamento>
                  <Comentario/>
                  <DataRegistro>2024-01-12T15:47:59.18</DataRegistro>
                  <DataPagamento>2024-01-26T00:03:13.2</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.00</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
               <BuscaTransacoesFinanceirasResponse>
                  <Erro i:nil="true"/>
                  <TipoTransacaoFinanceira>Parcela de Operação de Transporte</TipoTransacaoFinanceira>
                  <IdEntidadeTransacaoFinanceira>2731270</IdEntidadeTransacaoFinanceira>
                  <IdOperacaoTransporteRelacionada>1832677</IdOperacaoTransporteRelacionada>
                  <Valor>55.00</Valor>
                  <Situacao>Paga</Situacao>
                  <ModoPagamento>Depósito em Conta</ModoPagamento>
                  <Comentario>TesteDeploy</Comentario>
                  <DataRegistro>2023-05-18T14:52:34.527</DataRegistro>
                  <DataPagamento>2024-01-04T06:12:30.72</DataPagamento>
                  <PlacaVeiculo>AWN0143</PlacaVeiculo>
                  <OrigemUsuarioPagamento>Portal Target</OrigemUsuarioPagamento>
                  <ValorTaxa>0.01</ValorTaxa>
               </BuscaTransacoesFinanceirasResponse>
            </Itens>
            <NumeroPagina>1</NumeroPagina>
            <QuantidadeItensPorPagina>10</QuantidadeItensPorPagina>
            <QuantidadeTotalItens>42</QuantidadeTotalItens>
            <QuantidadeTotalPaginas>5</QuantidadeTotalPaginas>
         </BuscarTransacoesFinanceirasResult>
      </BuscarTransacoesFinanceirasResponse>
   </s:Body>
</s:Envelope>
  • No labels