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

Objetivo

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


Observações Importantes

  1. Os valores das Operações de Transporte do Tipo Padrão não poderão ser modificados de acordo com a nova legislação da ANTT.
  2. É obrigatório Encerrar a Operação de Transporte ao final da viagem (Padrão ou TAC-Agregado).
  3. Deve-se respeitar os valores da Operação de Transporte ao encerrar, o cálculo deve estar correto, caso contrário a Operação não será encerrada.
  4. Caso esteja Encerrando uma Operação de Transporte do Tipo TAC-Agregado, todas as viagens realizadas dentro desse CIOT devem ser declaradas no encerramento, e se parcelas adicionais foram criadas no período em que o CIOT estava aberto, as mesmas também devem ser declaradas no encerramento.
  5. 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

EncerramentoOperacaoTransporteRequest
CampoTipoObrigatórioDescriçãoObservação
1CodigoOperacaointSimID retornado da criação da Operação de Transportes.Método que retorna o IdOperacaoTransporte - CadastrarAtualizarOperacaoTransporte
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.

CIOT Padrão: Informar o Objeto viagens apenas 1 vez - 1 unica viagem um único destino.


CIOT TAC Agregado: Poderá informar até 5 Objetos viagens diferentes - Poderá haver N viagens, porém apenas 5 destinos diferentes.

4RetificacaoObject<Retificação Encerramento Operação Transporte Request>SimObjeto da viagem.N/A
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.Ministério da Fazenda - NCM
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
6CEPOrigemstringNãoCEP OrigemN/A
7CEPDestinostringNãoCEP DestinoN/A
RetificacaoEncerramentoOperacaoTransporteRequest
CampoTipoObrigatórioDescriçãoObservação
1PesoCargadecimalNãoPeso da CargaN/A
2ValoresObject<Retificação Valores Request>SimValoresN/A
RetificacaoValoresRequest
CampoTipoObrigatórioDescriçãoObservação
1ValorFretedecimalSimValor do FreteN/A
2ValorCombustiveldecimalSimValor do CombustívelN/A
3ValorPedagiodecimalSimValor do PedágioN/A
4ValorDespesasdecimalSimValor das DespesasN/A
5ValorImpostoSestSenatdecimalSimValor Imposto SEST SENATN/A
6ValorImpostoIRRFdecimalSimValor Imposto IRRFN/A
7ValorImpostoINSSdecimalSimValor Imposto INSSN/A
8ValorImpostoIcmsIssqndecimalSimValor Imposto ICMS ISSQNN/A
9ValorDescontoAntecipadodecimalSimValor de Desconto AntecipadoN/A
10ValorAjusteCombustiveldecimalSimValor Ajuste CombustívelN/A
11ValorAjusteServicosdecimalSimValor Ajuste ServiçosN/A
12ValorAjusteManutencaodecimalSimValor Ajuste ManutençãoN/A
13ValorAjusteOutrosdecimalSimValor Ajuste Outros

Utilizado para desconto de avaria na carga, por exemplo.


Esse valor é subtraído automaticamente da Parcela de Saldo que ainda será paga.

14DeduzirImpostosbool(true || false)SimDeduzir Impostos

Aconselhamos informar True.


Os valores dos Impostos devem ser informados, a TARGET apenas subtrai tais valores do valor total contratado.

Cálculo:

ValorFrete - (A soma de todos os Impostos)

O Resultado, deverá ser pago através das Parcelas de Pagamento.

Objeto Parcelas - List< Operação Transporte Parcela Request>

Impostos:

  1. ValorImpostoSestSenat
  2. ValorImpostoIRRF
  3. ValorImpostoINSS
  4. ValorImpostoIcmsIssqn
15TarifasBancariasdecimalSimTarifas BancáriasO valor total das tarifas bancárias será subtraído do valor total do frete.
16QuantidadeTarifasBancariasintNãoQuantidade Tarifas Bancárias

Deve ser informado 8 como dizem as regras da ANTT conforme resolução abaixo na página 14.

17ParcelasList<OperacaoTransporteParcelaRequest>SimLista de parcelas (consulte especificação de lista de parcelas).CIOT Padrão ou TAC-Agregado: Só poderá haver uma Parcela de Adiantamento (Tipo: 1), uma Parcela de Saldo (Tipo: 3) e N Parcelas Intermediárias (Tipo: 2) ou Adicionais (Tipo: 4).
OperacaoTransporteParcelaRequest
CampoTipoObrigatórioDescriçãoObservação
1DescricaoParcelastringSimDescrição da ParcelaN/A
2ValordecimalSimValor da ParcelaN/A
3NumeroParcelaintSimNúmero da ParcelaO campo foi descontinuado. Favor informar zero.
4DataVencimentoDatetime(YYYY-MM-DD)SimData Vencimento da ParcelaExemplo: (2018-08-20T10:05:33)
5TipoDaParcelaintSimTipo da Parcela1= Adiantamento
2= Intermediária
3= Saldo
4= Adicional
6FormaPagamentointSimForma de Pagamento escolhida para a Parcela de Operação de Transporte.1= Cartão
2= Depósito Conta
7CartaoPagamentostringNãoNúmero do Cartão para destino do pagamento da Operação de Transporte.Obrigatório se Forma Pagamento = 1
8CodigoBancostringNãoCódigo do banco de compensaçãoObrigatório Se Forma Pagamento = 2
9AgenciaDepositostringNãoAgência da rede bancária onde será realizado o pagamento.Obrigatório Se Forma Pagamento = 2
10ContaDepositostringNãoConta da agência onde será realizado o pagamento.Obrigatório Se Forma Pagamento = 2
11DigitoContaDepositostringNãoDigito verificador da conta que será realizado o pagamento.Obrigatório Se Forma Pagamento = 2
12ProcessarAutomaticamentebool(true || false)NãoIndica se a parcela em questão será processada automaticamente na data de vencimento informada ou será paga manualmente
no Sistema TARGET Frete.
N/A
13IdOperacaoTransporteParcelaintSimIdentificador de Parcela de Operação de Transporte no Sistema TARGET Frete.N/A
14FlagContaPoupancabool (true || false)SimFlag que indica se é uma conta Poupança ou não.Caso a forma de pagamento seja através do Cartão TARGET Bradesco, deverá ser informado false nesta TAG.
15VariacaoContaPoupancastringNãoVariação da Conta Poupança (caso seja uma).N/A
16ItemFinanceiroParcelastringNãoItem Financeiro ParcelaN/A

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çãoExemplo: (2018-08-20T10:05:33)
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:CEPOrigem>?</tms:CEPOrigem>
                  <tms:CEPDestino>?</tms:CEPDestino>
               </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.

Para uma Operação de Transporte do Tipo: Padrão, caso não tenha sido alterado nenhum dado desde o cadastro e declaração da mesma, a Operação de Transporte poderá ser encerrada como o exemplo abaixo, apenas informando o Id da Operação de Transporte.

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.

  1. Operação de Transporte Tipo: Padrão:
    1. Caso tenha ocorrido alguma alteração na Operação de Transporte, deverá ser enviado TODO o Request, informando: As Alterações, Parcelas Criadas (As parcelas criadas no cadastro da Operação de Transporte), Desconto de Avaria de Carga (Caso tenha).
    2. Parcelas: Só poderá haver uma Parcela de Adiantamento (Tipo: 1), uma Parcela de Saldo (Tipo: 3) e N Parcelas Intermediárias (Tipo: 2) ou Adicionais (Tipo: 4).
    3. Viagens: Apenas 1 viagem (1 destino).
  2. Operação de Transporte Tipo: TAC-Agregado:
    1. Sempre deverá ser informado TODO o Request.
    2. Parcelas: Só poderá haver uma Parcela de Adiantamento (Tipo: 1), uma Parcela de Saldo (Tipo: 3) e N Parcelas Intermediárias (Tipo: 2) ou Adicionais (Tipo: 4).
    3. Viagens: Poderá ter N viagens ,porém com apenas 5 destinos diferentes.
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