DOCUMENTAÇÃO CORPORATIVA
BuscarOperacaoTransporte
Objetivo
Esse método retorna uma Operação de Transporte já cadastrada no Sistema TARGET Frete.
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.
Request
BuscaOperacaoTransporteRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | QuantidadeItensPorPagina | int | Sim | Quantidade de itens a serem trazidos em uma página. | Quantidade máxima de 99 itens por página |
2 | NumeroPagina | int | Sim | Número da página especificada de retorno. | N/A |
3 | IdOperacao | int | Não | Identificador ú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. |
4 | CIOT | string | Não | CIOT da Operação de Transporte. | Obrigatório informar quando não for informado o Id da Operação de Transporte. |
5 | ItemFinanceiro | string | Não | Item Financeiro cadastrado a ser buscado, caso exista. | N/A |
6 | StatusOperacao | int | Não | Status das Operações a serem buscadas. | Analisar última tabela deste documento - Status Operação de Transporte. |
Response
OperacaoTransporteResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro. | NULO em caso de Sucesso |
2 | IdOperacaoTransporte | int | Sim | Retorna o Id Operação Transporte. | N/A |
3 | CIOT | string | Não | Retorna o código do CIOT. | N/A |
4 | CodigoCentroDeCusto | string | Não | Retorna o Código do Centro de Custo do Cliente no Sistema TARGET Frete. | N/A |
5 | NCM | string | Sim | Código de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido pela ANTT. | |
6 | ProprietarioCarga | string | Não | Retorna o Consignatário/Proprietário da Carga. | N/A |
7 | PesoCarga | decimal | Sim | Retorna o peso da carga que está sendo transportada entre a origem e destino. | N/A |
8 | TipoOperacao | string | Sim | Retorna o tipo da operação de transporte que está sendo contratada. | N/A |
9 | MunicipioOrigemCodigoIBGE | int | Sim | Retorna o código do IBGE referente ao município de origem. | N/A |
10 | MunicipioDestinoCodigoIBGE | int | Sim | Retorna o código do IBGE referente ao município de destino. | N/A |
11 | DataHoraInicio | Datetime (YYYY-MM-DD) | Sim | Retorna a data e hora do início previsto para a realização efetiva da operação de transporte. | Exemplo: (2018-08-20T10:05:33) |
12 | DataHoraTermino | Datetime (YYYY-MM-DD) | Sim | Retorna a data e hora do término previsto para a realização efetiva da operação de transporte. | Exemplo: (2018-08-20T10:05:33) |
13 | CPFCNPJContratado | string | Não | Retorna o CPF ou CNPJ do Contratado para realizar o efetivo transporte. | N/A |
14 | ValorFrete | decimal | Não | Retorna o valor referente ao frete contratado. | N/A |
15 | ValorCombustivel | decimal | Não | Retorna o valor referente ao combustível calculado. | N/A |
16 | ValorPedagio | decimal | Não | Retorna o valor referente ao pedágio calculado. | N/A |
17 | ValorDespesas | decimal | Não | Retorna o valor referente às despesas de viagem. | N/A |
18 | ValorImpostoSestSenat | decimal | Não | Retorna o valor referente ao imposto SEST SENAT (quando houver). | N/A |
19 | ValorImpostoIRRF | decimal | Não | Retorna o valor referente ao imposto IRRF (quando houver). | N/A |
20 | ValorImpostoINSS | decimal | Não | Retorna o valor referente ao imposto INSS (quando houver). | N/A |
21 | ValorImpostoIcmsIssqn | decimal | Não | Retorna o valor referente ao imposto ICMS ISSQN (quando houver). | N/A |
22 | ParcelaUnica | bool (true || false) | Sim | Retorna a Flag que define se a operação será paga em parcela única. | N/A |
23 | ModoCompraValePedagio | int | Sim | Retorna o identificador do modo de compra do vale pedágio. | N/A |
24 | CategoriaVeiculo | int | Sim | Retorna o identificador da categoria do veículo. | |
25 | NomeMotorista | string | Não | Retorna o nome do motorista da operação de transporte. | N/A |
26 | CPFMotorista | string | Não | Retorna o CPF do motorista da operação de transporte. | N/A |
27 | RNTRCMotorista | string | Não | Retorna o RNTRC do motorista da operação de transporte. | N/A |
28 | Triada | bool (true || false) | Sim | Triada | N/A |
29 | ItemFinanceiro | string | Não | Retorna o número do documento da Operação de Transporte. | N/A |
30 | Parcelas | List< Operação Transporte Parcelas Response> | Não | Lista de parcelas - Response. | N/A |
31 | Veiculos | List< Operação Transporte Veiculo Response> | Não | Lista de veículos - Response. | N/A |
32 | ValorContratado | decimal | Não | Valor Contratado | N/A |
33 | DispensadoPelaANTT | bool (true || false) | Sim | Se o Transportador é Dispensado pela ANTT. | N/A |
34 | TarifasBancarias | decimal | Não | Retorna o valor referente a Tarifas Bancárias (quando houver). | N/A |
35 | ValorImpostoPIS | decimal | Não | Retorna o valor do Imposto PIS. | N/A |
36 | ValorImpostoCofins | decimal | Não | Retorna o valor do Imposto COFINS. | N/A |
37 | BaseCalculoPISCofins | decimal | Não | Retorna a base de calculo PIS e COFINS. | N/A |
38 | ValorDescontoAntecipado | decimal | Não | Retorna o Valor do Desconto Antecipado. | N/A |
39 | IdCompraValePedagio | int | Não | Retorna o Id da compra do Vale Pedágio. | N/A |
40 | CPFCNPJParticipanteDestinatario | string | Não | Retorna o CPF ou CNPJ do Destinatário caso tenha sido informado. | N/A |
41 | CPFCNPJParticipanteContratante | string | Não | Retorna o CPF ou CNPJ do Participante Contratante caso tenha sido informado. | N/A |
42 | CPFCNPJParticipanteSubcontratante | string | Não | Retorna o CPF ou CNPJ do Subcontratante caso tenha sido informado. | N/A |
43 | CPFCNPJParticipanteConsignatario | string | Não | Retorna o CPF ou CNPJ do Consignatário caso tenha sido informado. | N/A |
44 | NumeroLacreTransporteCombustivel | string | Não | Número Lacre Transporte Combustível | N/A |
45 | ParticipantesDestinatarios | string | Sim | Retorna os Participantes da Operação de Transporte. | N/A |
46 | StatusOperacao | string | Sim | Status da Operação de Transporte | N/A |
47 | Quitacao | bool (true || false) | Não | Quitção | N/A |
48 | DadosQuitacao | List< Dados Quitação Frete Response> | Não | Dados para Quitação de Frete | N/A |
49 | DocumentoValePedagio | string | Não | Observações da compra de Vale-Pedágio Cartão ou TAG | N/A |
50 | MensagemRetorno | string | Sim | Mensagem de Retorno | N/A |
OperacaoTransporteParcelaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Código do Erro. | NULO em caso de sucesso. |
2 | IdOperacaoTransporteParcela | int | Sim | Retorna o Id da Operação Transporte Parcela. | N/A |
3 | CIOTCompleto | string | Não | CIOT completo | N/A |
4 | Valor | decimal | Sim | Valor | N/A |
5 | DataVencimento | Datetime (YYYY-MM-DD) | Sim | Retorna a Data do vencimento da parcela. | Exemplo: (2018-08-20T10:05:33) |
6 | DataPagamento | Datetime (YYYY-MM-DD) | Sim | Retorna a Data do Pagamento da Parcela. | Exemplo: (2018-08-20T10:05:33) |
7 | NumeroParcela | int | Sim | Retorna o Número da Parcela. | N/A |
8 | QuantidadeParcelas | int | Sim | Retorna a Quantidade de Parcelas. | N/A |
9 | DataHoraRegistro | Datetime (YYYY-MM-DD) | Sim | Data Hora Registro | Exemplo: (2018-08-20T10:05:33) |
10 | DescricaoParcela | string | Não | Retorna a descrição da Parcela. | N/A |
11 | Cancelada | bool (true || false) | Sim | Retorna status de cancelamento da Parcela. | N/A |
12 | FormaPagamento | int | Sim | Retorna a forma de Pagamento da Parcela. | N/A |
13 | CartaoPagamento | string | Não | Cartão Pagamento | N/A |
14 | CodigoBanco | string | Não | Código Banco | N/A |
15 | AgenciaDeposito | string | Não | Agência Depósito | N/A |
16 | ContaDeposito | string | Não | Conta Deposito | N/A |
17 | DigitoContaDeposito | string | Não | Digito da Conta Deposito | N/A |
18 | StatusParcela | int | Sim | Status da Parcela | 1= Parcela Pendente. 2= Parcela Paga. 3= Parcela Vencida. |
19 | TipoParcelaOperacaoTransporte | int | Não | Tipo Parcela Operação Transporte. | N/A |
20 | FlagContaPoupanca | bool (true || false) | Não | Flag Conta Poupança | N/A |
21 | VariacaoContaPoupanca | string | Não | Variação Conta Poupança | N/A |
22 | ItemFinanceiroParcela | string | Não | Item Financeiro Parcela | N/A |
OperacaoTransporteVeiculoResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro. | NULO em caso de sucesso. |
2 | Placa | string | Não | Retorna a Placa do veículo. | N/A |
3 | RNTRC | string | Não | Retorna o RNTRC vinculado ao veículo. | N/A |
DadosQuitacaoFreteResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | ValorMercadoria | decimal | Não | Valor da Mercadoria | Obrigatório somente quando a TAG - 'Quitacao' for true. |
2 | PesoCarregadoMercadoria | int | Não | Peso Carregado da Mercadoria | Obrigatório somente quando a TAG - 'Quitacao' for true. |
3 | QuantidadeCarregada | int | Não | Quantidade Carregada | Obrigatório somente quando a TAG - 'Quitacao' for true. |
4 | TipoCalculoAvaria | int | Não | Tipo Calculo Avaria | Obrigatório somente quando a TAG - 'Quitacao' for true. |
5 | EncerraNaANTT | bool (true || false) | Não | Encerrar Operação de Transporte na ANTT. | Obrigatório somente quando a TAG - 'Quitacao' for true. |
6 | PorcentagemToleranciaPeso | decimal | Não | Porcentagem Tolerância Peso | Obrigatório somente quando a TAG - 'Quitacao' for true. |
7 | TipoToleranciaPeso | int | Não | Tipo Tolerância Peso | Obrigatório somente quando a TAG - 'Quitacao' for true. |
8 | PorcetagemPesoAMaior | decimal | Não | Porcentagem Peso Maior | Obrigatório somente quando a TAG - 'Quitacao' for true. |
9 | DocumentosQuitacao | List< Dados Quitação Frete Documentos Response> | Sim | Documentos Quitação | Obrigatório somente quando a TAG - 'Quitacao' for true. |
10 | IdsTerminaisCarregamento | List(int) | Não | Ids Terminais de Carregamento | Obrigatório somente quando a TAG - 'Quitacao' for true. |
11 | QuitaEmTodosTerminais | bool (true || false) | Não | Quita em todos os Terminais | Obrigatório somente quando a TAG - 'Quitacao' for true. |
DadosQuitacaoFreteDocumentosResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | NomeDocumento | string | Não | Nome Documento | Obrigatório somente quando a TAG - 'Quitacao' for true. |
2 | NumeroIdentificadorDocumento | string | Não | Número Identificador Documento | Obrigatório somente quando a TAG - 'Quitacao' for true. |
3 | Obrigatorio | bool (true || false) | Não | Documento Obrigatório | Obrigatório somente quando a TAG - 'Quitacao' for true. |
Status Operação de Transporte
Status | ||
Nº | Status | Observação |
---|---|---|
1 | Em Preenchimento | N/A |
2 | Declarada | N/A |
3 | Encerrada | Viagem que foi encerrada sem nenhuma pendência utilizando serviço da ANTT. |
4 | Finalizada | N/A |
5 | Pendente | Viagem que foi encerrada pelo sistema automaticamente e necessita ser encerrada pelo cliente |
6 | Aguardando Contingência | N/A |
7 | Cancelada | Operação cancelada pelo usuário na ANTT. |
8 | Declarada Sem ANTT | Operação de Transporte declarada sem ANTT. ETC +3 veículos |
9 | Cancelada Sem ANTT | Operação de Transporte cancelada sem ANTT. ETC +3 veículos |
10 | Anulada | N/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>