...
Info | ||
---|---|---|
|
Request
...
Request
...
|
Request
EncerramentoOperacaoTransporteRequest | ||||||||||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | MunicipioOrigemCodigoIBGECodigoOperacao | int | Sim | Código IBGE de origem da viagem. | N/AID retornado da criação da Operação de Transportes. | Método que retorna o IdOperacaoTransporte - CadastrarAtualizarOperacaoTransporte | ||||||
2 | MunicipioDestinoCodigoIBGEObservacaoAvariaContratante | intstring | Sim | Código IBGE de destino da viagem. | N/ADescrição do desconto de Avaria. | Utilizado quando a TAG - 'ValorAjusteOutros' é preenchida. | ||||||
3 | NCM | stringViagens | List<Operação Transporte Viagem Request> | Sim | Código de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido pela ANTT. |
| ||||||
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 destinoLista 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 | RetificacaoEncerramentoOperacaoTransporteRequestMunicipioDestinoCodigoIBGE | Nºint | 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 | ValoresSim | 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 | RetificacaoValoresRequestQuantidadeViagens | Nºint | Campo | Tipo | Obrigatório | Descrição | Observação | 1 | ValorFrete | decimal | Sim | Valor do Frete | Sim | Número total de viagens realizadas com essa origem e destino. | N/A |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
6 | CEPOrigem | string | Não | CEP Origem | N/A | ||||||||||
27 | ValorCombustivelCEPDestino | decimalstring | Sim | Valor do CombustívelNão | CEP Destino | N/A3 |
RetificacaoEncerramentoOperacaoTransporteRequest | ValorPedagio|||||||||
Nº | decimalCampo | Sim | Valor do Pedágio | N/A | 4 | ValorDespesasTipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|---|---|---|---|
1 | PesoCarga | decimal | Sim | Valor das DespesasNão | Peso da Carga | N/A | |||
52 | ValorImpostoSestSenatValoresdecimal | Object<Retificação Valores Request> | Sim | Valor Imposto SEST SENATValores | N/A |
RetificacaoValoresRequest | 6|||||||||||
Nº | ValorImpostoIRRFCampo | decimalTipo | SimObrigatório | Valor Imposto IRRF | N/A | 7 | ValorImpostoINSSDescrição | Observação | |||
---|---|---|---|---|---|---|---|---|---|---|---|
1 | ValorFrete | decimal | Sim | Valor Imposto INSSdo Frete | N/A | ||||||
82 | ValorImpostoIcmsIssqnValorCombustivel | decimal | Sim | Valor Imposto ICMS ISSQNdo Combustível | N/A | ||||||
93 | ValorDescontoAntecipadoValorPedagio | decimal | Sim | Valor de Desconto Antecipadodo Pedágio | N/A | ||||||
104 | ValorAjusteCombustivelValorDespesas | decimal | Sim | Valor Ajuste Combustíveldas Despesas | N/A | ||||||
115 | ValorAjusteServicosValorImpostoSestSenat | decimal | Sim | Valor Ajuste ServiçosImposto SEST SENAT | N/A | ||||||
126 | ValorAjusteManutencaoValorImpostoIRRF | decimal | Sim | Valor Ajuste ManutençãoImposto IRRF | N/A | ||||||
137 | ValorAjusteOutrosValorImpostoINSS | decimal | Sim | Valor Ajuste Outros | Utilizado para desconto de avaria na carga, por exemplo. | 14 | DeduzirImpostos | bool(true || false) | Sim | Deduzir ImpostosImposto INSS | N/A |
8 | ValorImpostoIcmsIssqn | decimal | Sim | Valor Imposto ICMS ISSQN | N/A | ||||||
159 | TarifasBancariasValorDescontoAntecipado | 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). | N/A |
Request
OperacaoTransporteParcelaRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | DescricaoParcela | string | Sim | Descrição da Parcela | N/A |
2 | ValorValor 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 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 | N/A |
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
...
Método
Abaixo, segue método - 'EncerramentoOperacaoTransporteRequest'.
...
language | xml |
---|---|
theme | RDark |
firstline | 1 |
title | EncerramentoOperacaoTransporteRequest |
linenumbers | true |
...
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). | ||||||
18 | ValorImpostoISS | decimal | Não | Valor Imposto ISS | N/A |
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 Target Conta Digital ou Bradesco 3= Pix |
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'.
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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:Viagens> auth> <tms:OperacaoTransporteViagemRequest>Usuario>?</tms:Usuario> <tms:MunicipioOrigemCodigoIBGE>Senha>?</tms:MunicipioOrigemCodigoIBGE> Senha> <tms:MunicipioDestinoCodigoIBGE>Token>?</tms:MunicipioDestinoCodigoIBGE>Token> </tms:auth> <tms:NCM>?</tms:NCM> encerramentoRequest> <tms:PesoCarga>CodigoOperacao>?</tms:PesoCarga> CodigoOperacao> <tms:QuantidadeViagens>ObservacaoAvariaContratante>?</tms:QuantidadeViagens>ObservacaoAvariaContratante> <tms:Viagens> </tms:OperacaoTransporteViagemRequest> </tms<tms:Viagens>OperacaoTransporteViagemRequest> <tms:Retificacao> <tms:PesoCarga>MunicipioOrigemCodigoIBGE>?</tms:PesoCarga>MunicipioOrigemCodigoIBGE> <tms:Valores>:MunicipioDestinoCodigoIBGE>?</tms:MunicipioDestinoCodigoIBGE> <tms:ValorFrete>NCM>?</tms:ValorFrete>NCM> <tms:ValorCombustivel>PesoCarga>?</tms:ValorCombustivel>PesoCarga> <tms:QuantidadeViagens>?</tms:QuantidadeViagens> <tms:ValorPedagio>CEPOrigem>?</tms:ValorPedagio>CEPOrigem> <tms:ValorDespesas>CEPDestino>?</tms:ValorDespesas> CEPDestino> <tms:ValorImpostoSestSenat>?</tms:ValorImpostoSestSenat>OperacaoTransporteViagemRequest> </tms:Viagens> <tms:ValorImpostoIRRF>?</tms:ValorImpostoIRRF> <tms:Retificacao> <tms:ValorImpostoINSS>PesoCarga>?</tms:ValorImpostoINSS> PesoCarga> <tms:ValorImpostoIcmsIssqn>?</tms:ValorImpostoIcmsIssqn>Valores> <tms:ValorDescontoAntecipado>ValorFrete>?</tms:ValorDescontoAntecipado>ValorFrete> <tms:ValorAjusteCombustivel>ValorCombustivel>?</tms:ValorAjusteCombustivel>ValorCombustivel> <tms:ValorAjusteServicos>ValorPedagio>?</tms:ValorAjusteServicos>ValorPedagio> <tms:ValorAjusteManutencao>ValorDespesas>?</tms:ValorAjusteManutencao>ValorDespesas> <tms:ValorAjusteOutros>ValorImpostoSestSenat>?</tms:ValorAjusteOutros>ValorImpostoSestSenat> <tms:DeduzirImpostos>ValorImpostoIRRF>?</tms:DeduzirImpostos>ValorImpostoIRRF> <tms:TarifasBancarias>ValorImpostoINSS>?</tms:TarifasBancarias>ValorImpostoINSS> <tms:QuantidadeTarifasBancarias>ValorImpostoIcmsIssqn>?</tms:QuantidadeTarifasBancarias>ValorImpostoIcmsIssqn> <tms:Parcelas>:ValorDescontoAntecipado>?</tms:ValorDescontoAntecipado> <tms:OperacaoTransporteParcelaRequest> ValorAjusteCombustivel>?</tms:ValorAjusteCombustivel> <tms:DescricaoParcela>ValorAjusteServicos>?</tms:DescricaoParcela> ValorAjusteServicos> <tms:Valor>ValorAjusteManutencao>?</tms:Valor> ValorAjusteManutencao> <tms:NumeroParcela>ValorAjusteOutros>?</tms:NumeroParcela> ValorAjusteOutros> <tms:DataVencimento>DeduzirImpostos>?</tms:DataVencimento>DeduzirImpostos> <tms:TipoDaParcela>TarifasBancarias>?</tms:TipoDaParcela> TarifasBancarias> <tms:FormaPagamento>QuantidadeTarifasBancarias>?</tms:FormaPagamento>QuantidadeTarifasBancarias> <tms:Parcelas> <tms:CartaoPagamento>?</tms:CartaoPagamento> <tms:OperacaoTransporteParcelaRequest> <tms:CodigoBanco>DescricaoParcela>?</tms:CodigoBanco>DescricaoParcela> <tms:AgenciaDeposito>Valor>?</tms:AgenciaDeposito>Valor> <tms:ContaDeposito>NumeroParcela>?</tms:ContaDeposito>NumeroParcela> <tms:DigitoContaDeposito>DataVencimento>?</tms:DigitoContaDeposito>DataVencimento> <tms:ProcessarAutomaticamente>TipoDaParcela>?</tms:ProcessarAutomaticamente>TipoDaParcela> <tms:IdOperacaoTransporteParcela>FormaPagamento>?</tms:IdOperacaoTransporteParcela>FormaPagamento> <tms:FlagContaPoupanca>CartaoPagamento>?</tms:FlagContaPoupanca>CartaoPagamento> <tms:VariacaoContaPoupanca>CodigoBanco>?</tms:VariacaoContaPoupanca>CodigoBanco> <tms:ItemFinanceiroParcela>AgenciaDeposito>?</tms:ItemFinanceiroParcela>AgenciaDeposito> <tms:ContaDeposito>?</tms:OperacaoTransporteParcelaRequest>ContaDeposito> <tms:DigitoContaDeposito>?</tms:Parcelas>DigitoContaDeposito> <tms:ProcessarAutomaticamente>?</tms:Valores>ProcessarAutomaticamente> <tms:IdOperacaoTransporteParcela>?</tms:Retificacao>IdOperacaoTransporteParcela> <tms:FlagContaPoupanca>?</tms:encerramentoRequest>FlagContaPoupanca> </tms:EncerrarOperacaoTransporte> </soapenv:Body> </soapenv:Envelope> |
Encerrar Operação de Transporte - Exemplo 1
Abaixo, segue exemplo 1 do método de Encerramento.
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
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:VariacaoContaPoupanca>?</tms:VariacaoContaPoupanca> <tms:EncerrarOperacaoTransporte>:ItemFinanceiroParcela>?</tms:ItemFinanceiroParcela> <tms:auth> <tms:Usuario>tms.exemplo<</tms:Usuario>OperacaoTransporteParcelaRequest> <tms:Senha>v0hXPrwerKblaBs=</tms:Senha> </tms:Parcelas> <tms:Token i:nil="true" /> </tms:auth>Valores> <tms:encerramentoRequest> <tms:CodigoOperacao>136138<</tms:CodigoOperacao>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>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
...
Encerrar Operação de Transporte - Exemplo 1
Abaixo, segue exemplo 1 do método de Encerramento.
Info | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
|
Encerrar Operação de Transporte - Exemplo 2
Abaixo, segue exemplo 2 do método de Encerramento.
Info | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|