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 3 Next »

Objetivo

Esse método tem como objetivo realizar o encerramento da Operação de Transporte na ANTT.


Observações Importantes



Request

EncerramentoOperacaoTransporteRequest
CampoTipoObrigatórioDescriçãoObservação
1CodigoOperacaointSimID retornado da criação da Operação de Transportes.
2ObservacaoAvariaContratantestringSimDescrição do desconto de Avaria.Utilizado quando a TAG - 'ValorAjusteOutros' é preenchida.
3ViagensList<Operação Transporte Viagem Request>SimLista de Viagens realizadas em caso de operação de TAC-Agregado.N/A
4RetificacaoObject<Retificação Encerramento Operação Transporte Request>SimObjeto da viagem.N/A

Request

OperacaoTransporteViagemRequest
CampoTipoObrigatórioDescriçãoObservação
1MunicipioOrigemCodigoIBGEintSimCódigo IBGE de origem da viagem.N/A
2MunicipioDestinoCodigoIBGEintSimCódigo IBGE de destino da viagem.N/A
3NCMstringSimCódigo de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido pela ANTT.
4PesoCargadecimalSimPeso total de todas as viagens realizadas com essa origem e destino.N/A
5QuantidadeViagensintSimNúmero total de viagens realizadas com essa origem e destino.N/A


Request

RetificacaoEncerramentoOperacaoTransporteRequest
CampoTipoObrigatórioDescriçãoObservação
1PesoCargadecimalNãoPeso da CargaN/A
2ValoresObject<Retificação Valores Request>SimValoresN/A

Request

RetificacaoValoresRequest
CampoTipoObrigatórioDescriçãoObservação
1




2




3




4




5




6




7




8




9




10




11




12




13




14




15




16




17




Request

OperacaoTransporteParcelaRequest
CampoTipoObrigatórioDescriçãoObservação
1




2




3




4




5




6




7




8




9




10




11




12




13




14




15




16




Response

EncerramentoOperacaoTransporteResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o ErroNULO em caso de sucesso.
2IdEncerramentoOperacaoTransporteintSimID único de encerramento.N/A
3DataEncerramentoDatetime(YYYY-MM-DD)SimData do encerramento da OperaçãoN/A
4ProtocoloEncerramentostringNãoNúmero de protocolo da ANTT sobre o Encerramento do CIOT.N/A
5TipoOperacaostringNãoString com o tipo da operação encerrada.N/A

Método

Abaixo, segue método - 'EncerramentoOperacaoTransporteRequest'.

EncerramentoOperacaoTransporteRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:EncerrarOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:encerramentoRequest>
            <tms:CodigoOperacao>?</tms:CodigoOperacao>
            <tms:ObservacaoAvariaContratante>?</tms:ObservacaoAvariaContratante>
            <tms:Viagens>
               <tms:OperacaoTransporteViagemRequest>
                  <tms:MunicipioOrigemCodigoIBGE>?</tms:MunicipioOrigemCodigoIBGE>
                  <tms:MunicipioDestinoCodigoIBGE>?</tms:MunicipioDestinoCodigoIBGE>
                  <tms:NCM>?</tms:NCM>
                  <tms:PesoCarga>?</tms:PesoCarga>
                  <tms:QuantidadeViagens>?</tms:QuantidadeViagens>
               </tms:OperacaoTransporteViagemRequest>
            </tms:Viagens>
            <tms:Retificacao>
               <tms:PesoCarga>?</tms:PesoCarga>
               <tms:Valores>
                  <tms:ValorFrete>?</tms:ValorFrete>
                  <tms:ValorCombustivel>?</tms:ValorCombustivel>
                  <tms:ValorPedagio>?</tms:ValorPedagio>
                  <tms:ValorDespesas>?</tms:ValorDespesas>
                  <tms:ValorImpostoSestSenat>?</tms:ValorImpostoSestSenat>
                  <tms:ValorImpostoIRRF>?</tms:ValorImpostoIRRF>
                  <tms:ValorImpostoINSS>?</tms:ValorImpostoINSS>
                  <tms:ValorImpostoIcmsIssqn>?</tms:ValorImpostoIcmsIssqn>
                  <tms:ValorDescontoAntecipado>?</tms:ValorDescontoAntecipado>
                  <tms:ValorAjusteCombustivel>?</tms:ValorAjusteCombustivel>
                  <tms:ValorAjusteServicos>?</tms:ValorAjusteServicos>
                  <tms:ValorAjusteManutencao>?</tms:ValorAjusteManutencao>
                  <tms:ValorAjusteOutros>?</tms:ValorAjusteOutros>
                  <tms:DeduzirImpostos>?</tms:DeduzirImpostos>
                  <tms:TarifasBancarias>?</tms:TarifasBancarias>
                  <tms:QuantidadeTarifasBancarias>?</tms:QuantidadeTarifasBancarias>
                  <tms:Parcelas>
                     <tms:OperacaoTransporteParcelaRequest>
                        <tms:DescricaoParcela>?</tms:DescricaoParcela>
                        <tms:Valor>?</tms:Valor>
                        <tms:NumeroParcela>?</tms:NumeroParcela>
                        <tms:DataVencimento>?</tms:DataVencimento>
                        <tms:TipoDaParcela>?</tms:TipoDaParcela>
                        <tms:FormaPagamento>?</tms:FormaPagamento>
                        <tms:CartaoPagamento>?</tms:CartaoPagamento>
                        <tms:CodigoBanco>?</tms:CodigoBanco>
                        <tms:AgenciaDeposito>?</tms:AgenciaDeposito>
                        <tms:ContaDeposito>?</tms:ContaDeposito>
                        <tms:DigitoContaDeposito>?</tms:DigitoContaDeposito>
                        <tms:ProcessarAutomaticamente>?</tms:ProcessarAutomaticamente>
                        <tms:IdOperacaoTransporteParcela>?</tms:IdOperacaoTransporteParcela>
                        <tms:FlagContaPoupanca>?</tms:FlagContaPoupanca>
                        <tms:VariacaoContaPoupanca>?</tms:VariacaoContaPoupanca>
                        <tms:ItemFinanceiroParcela>?</tms:ItemFinanceiroParcela>
                     </tms:OperacaoTransporteParcelaRequest>
                  </tms:Parcelas>
               </tms:Valores>
            </tms:Retificacao>
         </tms:encerramentoRequest>
      </tms:EncerrarOperacaoTransporte>
   </soapenv:Body>
</soapenv:Envelope>


Encerrar Operação de Transporte - Exemplo 1

Abaixo, segue exemplo 1 do método de Encerramento.

EncerramentoOperacaoTransporteRequest
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:EncerrarOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>tms.exemplo</tms:Usuario>
            <tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
            <tms:Token i:nil="true" />
         </tms:auth>
         <tms:encerramentoRequest>
            <tms:CodigoOperacao>136138</tms:CodigoOperacao>
         </tms:encerramentoRequest>
      </tms:EncerrarOperacaoTransporte>
   </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/EncerrarOperacaoTransporteResponse</Action>
  </s:Header>
  <s:Body>
    <EncerrarOperacaoTransporteResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
      <EncerrarOperacaoTransporteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Erro i:nil="true" />
        <IdEncerramentoOperacaoTransporte>114334</IdEncerramentoOperacaoTransporte>
        <DataEncerramento>2018-08-30T13:53:10.0288164</DataEncerramento>
        <ProtocoloEncerramento>T18000000090025</ProtocoloEncerramento>
        <TipoOperacao i:nil="true" />
      </EncerrarOperacaoTransporteResult>
    </EncerrarOperacaoTransporteResponse>
  </s:Body>
</s:Envelope>


Encerrar Operação de Transporte  - Exemplo 2

Abaixo, segue exemplo 2 do método de Encerramento.

EncerramentoOperacaoTransporteRequest
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:EncerrarOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>tms.exemplo</tms:Usuario>
            <tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
            <tms:Token i:nil="true" />
         </tms:auth>
         <tms:encerramentoRequest>
            <tms:CodigoOperacao>125398</tms:CodigoOperacao>
            <tms:ObservacaoAvariaContratante i:nil="true" />
            <tms:Viagens>
               <tms:OperacaoTransporteViagemRequest>
                  <tms:MunicipioOrigemCodigoIBGE>3518800</tms:MunicipioOrigemCodigoIBGE>
                  <tms:MunicipioDestinoCodigoIBGE>3518800</tms:MunicipioDestinoCodigoIBGE>
                  <tms:NCM>0001</tms:NCM>
                  <tms:PesoCarga>480.29</tms:PesoCarga>
                  <tms:QuantidadeViagens>4</tms:QuantidadeViagens>
               </tms:OperacaoTransporteViagemRequest>
            </tms:Viagens>
            <tms:Retificacao>
               <tms:PesoCarga>599.04</tms:PesoCarga>
               <tms:Valores>
                  <tms:ValorFrete>1831.58</tms:ValorFrete>
                  <tms:ValorCombustivel>0.00</tms:ValorCombustivel>
                  <tms:ValorPedagio>0.00</tms:ValorPedagio>
                  <tms:ValorDespesas>0.00</tms:ValorDespesas>
                  <tms:ValorImpostoSestSenat>8.48</tms:ValorImpostoSestSenat>
                  <tms:ValorImpostoIRRF>0.00</tms:ValorImpostoIRRF>
                  <tms:ValorImpostoINSS>37.29</tms:ValorImpostoINSS>
                  <tms:ValorImpostoIcmsIssqn>0.00</tms:ValorImpostoIcmsIssqn>
                  <tms:ValorDescontoAntecipado>0.00</tms:ValorDescontoAntecipado>
                  <tms:ValorAjusteCombustivel>0.00</tms:ValorAjusteCombustivel>
                  <tms:ValorAjusteServicos>0.00</tms:ValorAjusteServicos>
                  <tms:ValorAjusteManutencao>0.00</tms:ValorAjusteManutencao>
                  <tms:ValorAjusteOutros>0.00</tms:ValorAjusteOutros>
                  <tms:DeduzirImpostos>true</tms:DeduzirImpostos>
                  <tms:TarifasBancarias>0.00</tms:TarifasBancarias>
                  <tms:QuantidadeTarifasBancarias>4</tms:QuantidadeTarifasBancarias>
                  <tms:Parcelas>
                     <tms:OperacaoTransporteParcelaRequest>
                        <tms:DescricaoParcela>Saldo do Frete</tms:DescricaoParcela>
                        <tms:Valor>1785.81</tms:Valor>
                        <tms:NumeroParcela>0</tms:NumeroParcela>
                        <tms:DataVencimento>2018-09-05T00:00:00</tms:DataVencimento>
                        <tms:TipoDaParcela>3</tms:TipoDaParcela>
                        <tms:FormaPagamento>1</tms:FormaPagamento>
                        <tms:CartaoPagamento>4417811608348024</tms:CartaoPagamento>
                        <tms:CodigoBanco i:nil="true" />
                        <tms:AgenciaDeposito i:nil="true" />
                        <tms:ContaDeposito i:nil="true" />
                        <tms:DigitoContaDeposito i:nil="true" />
                        <tms:ProcessarAutomaticamente>false</tms:ProcessarAutomaticamente>
                        <tms:IdOperacaoTransporteParcela>193680</tms:IdOperacaoTransporteParcela>
                        <tms:FlagContaPoupanca>false</tms:FlagContaPoupanca>
                        <tms:VariacaoContaPoupanca i:nil="true" />
                        <tms:ItemFinanceiroParcela>63</tms:ItemFinanceiroParcela>
                     </tms:OperacaoTransporteParcelaRequest>
                  </tms:Parcelas>
               </tms:Valores>
            </tms:Retificacao>
         </tms:encerramentoRequest>
      </tms:EncerrarOperacaoTransporte>
   </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/EncerrarOperacaoTransporteResponse</Action>
  </s:Header>
  <s:Body>
    <EncerrarOperacaoTransporteResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
      <EncerrarOperacaoTransporteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Erro i:nil="true" />
        <IdEncerramentoOperacaoTransporte>114306</IdEncerramentoOperacaoTransporte>
        <DataEncerramento>2018-08-30T12:24:09.5949869-03:00</DataEncerramento>
        <ProtocoloEncerramento>T18000000090026</ProtocoloEncerramento>
        <TipoOperacao i:nil="true" />
      </EncerrarOperacaoTransporteResult>
    </EncerrarOperacaoTransporteResponse>
  </s:Body>
</s:Envelope>
  • No labels