Objetivo
Esse método tem como objetivo realizar o encerramento da Operação de Transporte na ANTT.
Observações Importantes
- É obrigatório Encerrar a Operação de Transporte ao final da viagem (Padrão ou TAC-Agregado).
- 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.
- 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.
- 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 | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | CodigoOperacao | int | Sim | ID retornado da criação da Operação de Transportes. | Método que retorna o IdOperacaoTransporte - CadastrarAtualizarOperacaoTransporte |
2 | ObservacaoAvariaContratante | string | Sim | Descrição do desconto de Avaria. | Utilizado quando a TAG - 'ValorAjusteOutros' é preenchida. |
3 | Viagens | List<Operação Transporte Viagem Request> | Sim | Lista 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. |
4 | Retificacao | Object<Retificação Encerramento Operação Transporte Request> | Sim | Objeto da viagem. | N/A |
OperacaoTransporteViagemRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | MunicipioOrigemCodigoIBGE | int | Sim | Código IBGE de origem da viagem. | N/A |
2 | MunicipioDestinoCodigoIBGE | int | Sim | Código IBGE de destino da viagem. | N/A |
3 | NCM | string | Sim | Código de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido pela ANTT. | Ministério da Fazenda - NCM |
4 | PesoCarga | decimal | Sim | Peso total de todas as viagens realizadas com essa origem e destino. | N/A |
5 | QuantidadeViagens | int | Sim | Número total de viagens realizadas com essa origem e destino. | N/A |
6 | CEPOrigem | string | Não | CEP Origem | N/A |
7 | CEPDestino | string | Não | CEP Destino | N/A |
RetificacaoEncerramentoOperacaoTransporteRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | PesoCarga | decimal | Não | Peso da Carga | N/A |
2 | Valores | Object<Retificação Valores Request> | Sim | Valores | N/A |
RetificacaoValoresRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | ValorFrete | decimal | Sim | Valor do Frete | N/A |
2 | ValorCombustivel | decimal | Sim | Valor do Combustível | N/A |
3 | ValorPedagio | decimal | Sim | Valor do Pedágio | N/A |
4 | ValorDespesas | decimal | Sim | Valor das Despesas | N/A |
5 | ValorImpostoSestSenat | decimal | Sim | Valor Imposto SEST SENAT | N/A |
6 | ValorImpostoIRRF | decimal | Sim | Valor Imposto IRRF | N/A |
7 | ValorImpostoINSS | decimal | Sim | Valor Imposto INSS | N/A |
8 | ValorImpostoIcmsIssqn | decimal | Sim | Valor Imposto ICMS ISSQN | N/A |
9 | ValorDescontoAntecipado | decimal | Sim | Valor de Desconto Antecipado | N/A |
10 | ValorAjusteCombustivel | decimal | Sim | Valor Ajuste Combustível | N/A |
11 | ValorAjusteServicos | decimal | Sim | Valor Ajuste Serviços | N/A |
12 | ValorAjusteManutencao | decimal | Sim | Valor Ajuste Manutenção | N/A |
13 | ValorAjusteOutros | decimal | Sim | Valor Ajuste Outros | Utilizado para desconto de avaria na carga, por exemplo. Esse valor é subtraído automaticamente da Parcela de Saldo que ainda será paga. |
14 | DeduzirImpostos | bool(true || false) | Sim | Deduzir Impostos | Aconselhamos informar True.
|
15 | TarifasBancarias | decimal | Sim | Tarifas Bancárias | O valor total das tarifas bancárias será subtraído do valor total do frete. |
16 | QuantidadeTarifasBancarias | int | Não | Quantidade Tarifas Bancárias | Deve ser informado 8 como dizem as regras da ANTT conforme resolução abaixo na página 14. |
17 | Parcelas | List<OperacaoTransporteParcelaRequest> | Sim | Lista 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 | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | DescricaoParcela | string | Sim | Descrição da Parcela | N/A |
2 | Valor | decimal | Sim | Valor da Parcela | N/A |
3 | NumeroParcela | int | Sim | Número da Parcela | O campo foi descontinuado. Favor informar zero. |
4 | DataVencimento | Datetime(YYYY-MM-DD) | Sim | Data Vencimento da Parcela | Exemplo: (2018-08-20T10:05:33) |
5 | TipoDaParcela | int | Sim | Tipo da Parcela | 1= Adiantamento 2= Intermediária 3= Saldo 4= Adicional |
6 | FormaPagamento | int | Sim | Forma de Pagamento escolhida para a Parcela de Operação de Transporte. | 1= Cartão 2= Depósito Conta |
7 | CartaoPagamento | string | Não | Número do Cartão para destino do pagamento da Operação de Transporte. | Obrigatório se Forma Pagamento = 1 |
8 | CodigoBanco | string | Não | Código do banco de compensação | Obrigatório Se Forma Pagamento = 2 |
9 | AgenciaDeposito | string | Não | Agência da rede bancária onde será realizado o pagamento. | Obrigatório Se Forma Pagamento = 2 |
10 | ContaDeposito | string | Não | Conta da agência onde será realizado o pagamento. | Obrigatório Se Forma Pagamento = 2 |
11 | DigitoContaDeposito | string | Não | Digito verificador da conta que será realizado o pagamento. | Obrigatório Se Forma Pagamento = 2 |
12 | ProcessarAutomaticamente | bool(true || false) | Não | Indica se a parcela em questão será processada automaticamente na data de vencimento informada ou será paga manualmente no Sistema TARGET Frete. | N/A |
13 | IdOperacaoTransporteParcela | int | Sim | Identificador de Parcela de Operação de Transporte no Sistema TARGET Frete. | N/A |
14 | FlagContaPoupanca | bool (true || false) | Sim | Flag 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. |
15 | VariacaoContaPoupanca | string | Não | Variação da Conta Poupança (caso seja uma). | N/A |
16 | ItemFinanceiroParcela | string | Não | Item Financeiro Parcela | N/A |
Response
EncerramentoOperacaoTransporteResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso. |
2 | IdEncerramentoOperacaoTransporte | int | Sim | ID único de encerramento. | N/A |
3 | DataEncerramento | Datetime(YYYY-MM-DD) | Sim | Data do encerramento da Operação | Exemplo: (2018-08-20T10:05:33) |
4 | ProtocoloEncerramento | string | Não | Número de protocolo da ANTT sobre o Encerramento do CIOT. | N/A |
5 | TipoOperacao | string | Não | String com o tipo da operação encerrada. | N/A |
Método
Abaixo, segue método - '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.
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.
- Operação de Transporte Tipo: Padrão:
- 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).
- 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).
- Viagens: Apenas 1 viagem (1 destino).
- Operação de Transporte Tipo: TAC-Agregado:
- Sempre deverá ser informado TODO o Request.
- 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).
- Viagens: Poderá ter N viagens ,porém com apenas 5 destinos diferentes.
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>