DOCUMENTAÇÃO CORPORATIVA

BuscarOperacaoTransporte

Objetivo

Esse método retorna uma Operação de Transporte já cadastrada no Sistema TARGET Frete.


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

BuscaOperacaoTransporteRequest
CampoTipoObrigatórioDescriçãoObservação
1QuantidadeItensPorPaginaintSimQuantidade de itens a serem trazidos em uma página.Quantidade máxima de 99 itens por página 
2NumeroPaginaintSimNúmero da página especificada de retorno.N/A
3IdOperacaointNãoIdentificador único da Operação de Transporte.

Obrigatório informar quando não for informado o Número do CIOT.


Obs. Importante - Conselho: Faça sempre uso do Id da Operação de Transporte.

4CIOTstringNãoCIOT da Operação de Transporte.Obrigatório informar quando não for informado o Id da Operação de Transporte.
5ItemFinanceirostringNãoItem Financeiro cadastrado a ser buscado, caso exista.N/A
6StatusOperacaointNãoStatus das Operações a serem buscadas.Analisar última tabela deste documento - Status Operação de Transporte.

Response

OperacaoTransporteResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Erro.NULO em caso de Sucesso
2IdOperacaoTransporteintSimRetorna o Id Operação Transporte.N/A
3CIOTstringNãoRetorna o código do CIOT.N/A
4CodigoCentroDeCustostringNão

Retorna o Código do Centro de Custo do Cliente no Sistema TARGET Frete.

N/A
5NCMstringSimCódigo de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido
pela ANTT.
6ProprietarioCargastringNãoRetorna o Consignatário/Proprietário da Carga.N/A
7PesoCargadecimalSimRetorna o peso da carga que está sendo transportada entre a origem e destino.N/A
8TipoOperacaostringSimRetorna o tipo da operação de transporte que está sendo contratada.N/A
9MunicipioOrigemCodigoIBGEintSimRetorna o código do IBGE referente ao município de origem.N/A
10MunicipioDestinoCodigoIBGEintSimRetorna o código do IBGE referente ao município de destino.N/A
11DataHoraInicioDatetime (YYYY-MM-DD)SimRetorna a data e hora do início previsto para a realização efetiva da operação de transporte.Exemplo: (2018-08-20T10:05:33)
12DataHoraTerminoDatetime (YYYY-MM-DD)SimRetorna a data e hora do término previsto para a realização efetiva da operação de transporte.Exemplo: (2018-08-20T10:05:33)
13CPFCNPJContratadostringNãoRetorna o CPF ou CNPJ do Contratado para realizar o efetivo transporte.N/A
14ValorFretedecimalNãoRetorna o valor referente ao frete contratado.N/A
15ValorCombustiveldecimalNãoRetorna o valor referente ao combustível calculado.N/A
16ValorPedagiodecimalNãoRetorna o valor referente ao pedágio calculado.N/A
17ValorDespesasdecimalNãoRetorna o valor referente às despesas de viagem.N/A
18ValorImpostoSestSenatdecimalNãoRetorna o valor referente ao imposto SEST SENAT (quando houver).N/A
19ValorImpostoIRRFdecimalNãoRetorna o valor referente ao imposto IRRF (quando houver).N/A
20ValorImpostoINSSdecimalNãoRetorna o valor referente ao imposto INSS (quando houver).N/A
21ValorImpostoIcmsIssqndecimalNãoRetorna o valor referente ao imposto ICMS ISSQN (quando houver).N/A
22ParcelaUnicabool (true || false)SimRetorna a Flag que define se a operação será paga em parcela única.N/A
23ModoCompraValePedagiointSimRetorna o identificador do modo de compra do vale pedágio.N/A
24CategoriaVeiculointSimRetorna o identificador da categoria do veículo.
25NomeMotoristastringNãoRetorna o nome do motorista da operação de transporte.N/A
26CPFMotoristastringNãoRetorna o CPF do motorista da operação de transporte.N/A
27RNTRCMotoristastringNãoRetorna o RNTRC do motorista da operação de transporte.N/A
28Triadabool (true || false)SimTriadaN/A
29ItemFinanceirostringNãoRetorna o número do documento da Operação de Transporte.N/A
30ParcelasList< Operação Transporte Parcelas Response>NãoLista de parcelas - Response.N/A
31VeiculosList< Operação Transporte Veiculo Response>NãoLista de veículos - Response.N/A
32ValorContratadodecimalNãoValor ContratadoN/A
33DispensadoPelaANTTbool (true || false)SimSe o Transportador é Dispensado pela ANTT.N/A
34TarifasBancariasdecimalNãoRetorna o valor referente a Tarifas Bancárias (quando houver).N/A
35ValorImpostoPISdecimalNãoRetorna o valor do Imposto PIS.N/A
36ValorImpostoCofinsdecimalNãoRetorna o valor do Imposto COFINS.N/A
37BaseCalculoPISCofinsdecimalNãoRetorna a base de calculo PIS e COFINS.N/A
38ValorDescontoAntecipadodecimalNãoRetorna o Valor do Desconto Antecipado.N/A
39IdCompraValePedagiointNãoRetorna o Id da compra do Vale Pedágio.N/A
40CPFCNPJParticipanteDestinatariostringNãoRetorna o CPF ou CNPJ do Destinatário caso tenha sido informado.N/A
41CPFCNPJParticipanteContratantestringNãoRetorna o CPF ou CNPJ do Participante Contratante caso tenha sido informado.N/A
42CPFCNPJParticipanteSubcontratantestringNãoRetorna o CPF ou CNPJ do Subcontratante caso tenha sido informado.N/A
43CPFCNPJParticipanteConsignatariostringNãoRetorna o CPF ou CNPJ do Consignatário caso tenha sido informado.N/A
44NumeroLacreTransporteCombustivelstringNãoNúmero Lacre Transporte CombustívelN/A
45ParticipantesDestinatariosstringSimRetorna os Participantes da Operação de Transporte.N/A
46StatusOperacaostringSimStatus da Operação de TransporteN/A
47Quitacaobool (true || false)NãoQuitçãoN/A
48DadosQuitacaoList< Dados Quitação Frete Response>NãoDados para Quitação de FreteN/A
49DocumentoValePedagiostringNãoObservações da compra de Vale-Pedágio Cartão ou TAGN/A
50MensagemRetornostringSimMensagem de RetornoN/A


OperacaoTransporteParcelaResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Código do Erro.NULO em caso de sucesso.
2IdOperacaoTransporteParcelaintSimRetorna o Id da Operação Transporte Parcela.N/A
3CIOTCompletostringNãoCIOT completoN/A
4ValordecimalSimValorN/A
5DataVencimentoDatetime (YYYY-MM-DD)SimRetorna a Data do vencimento da parcela.Exemplo: (2018-08-20T10:05:33)
6DataPagamentoDatetime (YYYY-MM-DD)SimRetorna a Data do Pagamento da Parcela.Exemplo: (2018-08-20T10:05:33)
7NumeroParcelaintSimRetorna o Número da Parcela.N/A
8QuantidadeParcelasintSimRetorna a Quantidade de Parcelas.N/A
9DataHoraRegistroDatetime (YYYY-MM-DD)SimData Hora RegistroExemplo: (2018-08-20T10:05:33)
10DescricaoParcelastringNãoRetorna a descrição da Parcela.N/A
11Canceladabool (true || false)SimRetorna status de cancelamento da Parcela.N/A
12FormaPagamentointSimRetorna a forma de Pagamento da Parcela.N/A
13CartaoPagamentostringNãoCartão PagamentoN/A
14CodigoBancostringNãoCódigo BancoN/A
15AgenciaDepositostringNãoAgência DepósitoN/A
16ContaDepositostringNãoConta DepositoN/A
17DigitoContaDepositostringNãoDigito da Conta DepositoN/A
18StatusParcelaintSimStatus da Parcela

1= Parcela Pendente.

2= Parcela Paga.

3= Parcela Vencida.

19TipoParcelaOperacaoTransporteintNãoTipo Parcela Operação Transporte.N/A
20FlagContaPoupancabool (true || false)NãoFlag Conta PoupançaN/A
21VariacaoContaPoupancastringNãoVariação Conta PoupançaN/A
22ItemFinanceiroParcelastringNãoItem Financeiro ParcelaN/A


OperacaoTransporteVeiculoResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Erro.NULO em caso de sucesso.
2PlacastringNãoRetorna a Placa do veículo.N/A
3RNTRCstringNãoRetorna o RNTRC vinculado ao veículo.N/A


DadosQuitacaoFreteResponse
CampoTipoObrigatórioDescriçãoObservação
1ValorMercadoriadecimalNãoValor da MercadoriaObrigatório somente quando a TAG - 'Quitacao' for true.
2PesoCarregadoMercadoriaintNãoPeso Carregado da MercadoriaObrigatório somente quando a TAG - 'Quitacao' for true.
3QuantidadeCarregadaintNãoQuantidade CarregadaObrigatório somente quando a TAG - 'Quitacao' for true.
4TipoCalculoAvariaintNãoTipo Calculo AvariaObrigatório somente quando a TAG - 'Quitacao' for true.
5EncerraNaANTTbool (true || false)NãoEncerrar Operação de Transporte na ANTT.Obrigatório somente quando a TAG - 'Quitacao' for true.
6PorcentagemToleranciaPesodecimalNãoPorcentagem Tolerância PesoObrigatório somente quando a TAG - 'Quitacao' for true.
7TipoToleranciaPesointNãoTipo Tolerância PesoObrigatório somente quando a TAG - 'Quitacao' for true.
8PorcetagemPesoAMaiordecimalNãoPorcentagem Peso MaiorObrigatório somente quando a TAG - 'Quitacao' for true.
9DocumentosQuitacaoList< Dados Quitação Frete Documentos Response>SimDocumentos QuitaçãoObrigatório somente quando a TAG - 'Quitacao' for true.
10IdsTerminaisCarregamento List(int)NãoIds Terminais de CarregamentoObrigatório somente quando a TAG - 'Quitacao' for true.
11QuitaEmTodosTerminaisbool (true || false)NãoQuita em todos os TerminaisObrigatório somente quando a TAG - 'Quitacao' for true.


DadosQuitacaoFreteDocumentosResponse
CampoTipoObrigatórioDescriçãoObservação
1NomeDocumentostringNãoNome DocumentoObrigatório somente quando a TAG - 'Quitacao' for true.
2NumeroIdentificadorDocumentostringNãoNúmero Identificador DocumentoObrigatório somente quando a TAG - 'Quitacao' for true.
3Obrigatoriobool (true || false)NãoDocumento ObrigatórioObrigatório somente quando a TAG - 'Quitacao' for true.



Status Operação de Transporte

Status
StatusObservação
1Em PreenchimentoN/A
2DeclaradaN/A
3EncerradaViagem que foi encerrada sem nenhuma pendência utilizando serviço da ANTT.
4FinalizadaN/A
5PendenteViagem que foi encerrada pelo sistema automaticamente e necessita ser encerrada pelo cliente
6Aguardando ContingênciaN/A
7CanceladaOperação cancelada pelo usuário na ANTT.
8Declarada Sem ANTTOperação de Transporte declarada sem ANTT. ETC +3 veículos
9Cancelada Sem ANTTOperação de Transporte cancelada sem ANTT. ETC +3 veículos
10AnuladaN/A

Método

BuscarOperacaoTransporteRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:BuscarOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:buscaOperacao>
            <tms:QuantidadeItensPorPagina>?</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>?</tms:NumeroPagina>
            <tms:IdOperacao>?</tms:IdOperacao>
            <tms:CIOT>?</tms:CIOT>
            <tms:ItemFinanceiro>?</tms:ItemFinanceiro>
            <tms:StatusOperacao>?</tms:StatusOperacao>
         </tms:buscaOperacao>
      </tms:BuscarOperacaoTransporte>
   </soapenv:Body>
</soapenv:Envelope>

Buscar Operação de Transporte

Abaixo, segue exemplo para realizar a buscar de uma Operação de Transporte.

BuscaOperacaoTransporteRequest
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:BuscarOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>tms.exemplo</tms:Usuario>
            <tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
            <tms:Token i:nil="true" />
         </tms:auth>
         <tms:buscaOperacao>
            <tms:QuantidadeItensPorPagina>1</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>1</tms:NumeroPagina>
            <tms:IdOperacao>5938</tms:IdOperacao>
            <tms:CIOT i:nil="true" />
            <tms:ItemFinanceiro i:nil="true" />
            <tms:StatusOperacao i:nil="true" />
         </tms:buscaOperacao>
      </tms:BuscarOperacaoTransporte>
   </soapenv:Body>
</soapenv:Envelope>

Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <BuscarOperacaoTransporteResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
         <BuscarOperacaoTransporteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Erro i:nil="true"/>
            <Itens>
               <OperacaoTransporteResponse>
                  <Erro i:nil="true"/>
                  <IdOperacaoTransporte>5938</IdOperacaoTransporte>
                  <CIOT>/</CIOT>
                  <CodigoCentroDeCusto i:nil="true"/>
                  <NCM>2710</NCM>
                  <ProprietarioCarga>R</ProprietarioCarga>
                  <PesoCarga>5225.00</PesoCarga>
                  <TipoOperacao>1</TipoOperacao>
                  <MunicipioOrigemCodigoIBGE>4322004</MunicipioOrigemCodigoIBGE>
                  <MunicipioDestinoCodigoIBGE>4300406</MunicipioDestinoCodigoIBGE>
                  <DataHoraInicio>2018-08-24T09:58:15</DataHoraInicio>
                  <DataHoraTermino>2018-08-29T09:58:15</DataHoraTermino>
                  <CPFCNPJContratado>05575361000180</CPFCNPJContratado>
                  <ValorFrete>330.00</ValorFrete>
                  <ValorCombustivel>0.00</ValorCombustivel>
                  <ValorPedagio>73.20</ValorPedagio>
                  <ValorDespesas>0.00</ValorDespesas>
                  <ValorImpostoSestSenat>0.00</ValorImpostoSestSenat>
                  <ValorImpostoIRRF>0.00</ValorImpostoIRRF>
                  <ValorImpostoINSS>0.00</ValorImpostoINSS>
                  <ValorImpostoIcmsIssqn>0.00</ValorImpostoIcmsIssqn>
                  <ParcelaUnica>true</ParcelaUnica>
                  <ModoCompraValePedagio>2</ModoCompraValePedagio>
                  <CategoriaVeiculo>7</CategoriaVeiculo>
                  <NomeMotorista>VANDERLEIEDUARDOPDASILVA</NomeMotorista>
                  <CPFMotorista>05542052622</CPFMotorista>
                  <RNTRCMotorista>002074900</RNTRCMotorista>
                  <Triada>false</Triada>
                  <ItemFinanceiro>30</ItemFinanceiro>
                  <Parcelas>
                     <OperacaoTransporteParcelasResponse>
                        <Erro i:nil="true"/>
                        <IdOperacaoTransporteParcela>7871</IdOperacaoTransporteParcela>
                        <CIOTCompleto>/</CIOTCompleto>
                        <Valor>330.00</Valor>
                        <DataVencimento>2018-08-28T00:00:00</DataVencimento>
                        <DataPagamento i:nil="true"/>
                        <NumeroParcela>1</NumeroParcela>
                        <QuantidadeParcelas>1</QuantidadeParcelas>
                        <DataHoraRegistro>2018-08-20T11:40:57.02</DataHoraRegistro>
                        <DescricaoParcela>SALDO</DescricaoParcela>
                        <Cancelada>false</Cancelada>
                        <FormaPagamento>2</FormaPagamento>
                        <CartaoPagamento i:nil="true"/>
                        <CodigoBanco>237</CodigoBanco>
                        <AgenciaDeposito>2351</AgenciaDeposito>
                        <ContaDeposito>35225</ContaDeposito>
                        <DigitoContaDeposito>1</DigitoContaDeposito>
                        <StatusParcela>1</StatusParcela>
                        <TipoParcelaOperacaoTransporte>3</TipoParcelaOperacaoTransporte>
                        <FlagContaPoupanca>false</FlagContaPoupanca>
                        <VariacaoContaPoupanca i:nil="true"/>
                        <ItemFinanceiroParcela>30</ItemFinanceiroParcela>
                     </OperacaoTransporteParcelasResponse>
                  </Parcelas>
                  <Veiculos>
                     <OperacaoTransporteVeiculoResponse>
                        <Erro i:nil="true"/>
                        <Placa>JAM7774</Placa>
                        <RNTRC>000025256</RNTRC>
                     </OperacaoTransporteVeiculoResponse>
                  </Veiculos>
                  <ValorContratado>330.00</ValorContratado>
                  <DispensadoPelaANTT>false</DispensadoPelaANTT>
                  <TarifasBancarias>0.00</TarifasBancarias>
                  <ValorImpostoPIS>3.06</ValorImpostoPIS>
                  <ValorImpostoCofins>14.10</ValorImpostoCofins>
                  <BaseCalculoPISCofins>247.50</BaseCalculoPISCofins>
                  <ValorDescontoAntecipado>0.00</ValorDescontoAntecipado>
                  <IdCompraValePedagio i:nil="true"/>
                  <CPFCNPJParticipanteDestinatario>16828868000114</CPFCNPJParticipanteDestinatario>
                  <CPFCNPJParticipanteContratante i:nil="true"/>
                  <CPFCNPJParticipanteSubcontratante i:nil="true"/>
                  <CPFCNPJParticipanteConsignatario i:nil="true"/>
                  <NumeroLacreTransporteCombustivel i:nil="true"/>
                  <ParticipantesDestinatarios>CNPJ: 16828868000114 / Destinatário Final? Sim;</ParticipantesDestinatarios>
                  <StatusOperacao>Anulada</StatusOperacao>
                  <Quitacao>false</Quitacao>
                  <DadosQuitacao i:nil="true"/>
				  <DocumentoValePedagio>Teste</DocumentoValePedagio>
                  <MensagemRetorno i:nil="true"/>
               </OperacaoTransporteResponse>
            </Itens>
            <NumeroPagina>1</NumeroPagina>
            <QuantidadeItensPorPagina>20</QuantidadeItensPorPagina>
            <QuantidadeTotalItens>1</QuantidadeTotalItens>
            <QuantidadeTotalPaginas>1</QuantidadeTotalPaginas>
         </BuscarOperacaoTransporteResult>
      </BuscarOperacaoTransporteResponse>
   </s:Body>
</s:Envelope>