Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

OperacaoTransporteRequest
CampoTipoObrigatórioDescriçãoObservação
1InstrucaointSimInstrucao para criação de uma nova Operacao.

1= Inserir ou Atualizar

2= Inserir se não existe

4= Desativar/Anular Operação de Transporte

2IdOperacaoTransporteintNãoId da Operação de TransporteObrigatório apenas para Atualizar (1= Inserir ou Atualizar) ou Anular (4=Desativar/Anular Operação de Transporte) o cadastro da Operação de Transporte.
3CodigoCentroDeCustostringNãoCódigo do Centro de Custo do Cliente no Sistema TARGET Frete.Para realizar o Cadastro de um Centro de Custo, será necessário invocar o Método - CadastrarAtualizarCentroDeCusto
4NCMstringSimCódigo de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido
pela ANTT.
Ministério da Fazenda - NCM
5ProprietarioCargaintSimIndica quem é o Consignatário/Proprietário da Carga.

1= Remetente

2= Destinatário

6PesoCargadecimal (12.2)SimIndica o peso da carga que está sendo transportada entre a origem e destino.É obrigatório informar o peso da carga, a ANTT solicita essa informação para a emissão do CIOT.
7TipoOperacaostringSimTipo da operação de transporte que está sendo contratada.1= Padrão
3= TAC-Agregado
8MunicipioOrigemCodigoIBGEintNãoCódigo do IBGE referente ao município de origem.Obrigatório informar, quando não existe compra de Vale-Pedágio (Cartão ou TAG) dentro do CIOT.
9MunicipioDestinoCodigoIBGEintNãoCódigo do IBGE referente ao município de destino.Obrigatório informar, quando não existe compra de Vale-Pedágio (Cartão ou TAG) dentro do CIOT.
10DataHoraInicioDatetime (YYYY-MM-DD)SimData e hora do início previsto para a realização efetiva da operação de transporte.

Exemplo: (2018-08-20T10:05:33)


O usuário que deve informar a Data e Hora do início da viagem.

Existem duas validações importantes para essas TAGs:

  1. A data e hora que for informada, não pode ser DateTime Now, caso contrário, iremos dar um retorno de negócio.
  2. A data e hora deve ter no mínimo 1h de intervalo (DataHoraInicio - DataHoraTermino).
11DataHoraTerminoDatetime (YYYY-MM-DD)SimData e hora do término previsto para a realização efetiva da operação de transporte.

Exemplo: (2018-08-20T10:05:33)


O usuário que deve informar a Data e Hora do fim da viagem.

Existem duas validações importantes para essas TAGs:

  1. A data e hora que for informada, não pode ser DateTime Now, caso contrário, iremos dar um retorno de negócio.
  2. A data e hora deve ter no mínimo 1h de intervalo (DataHoraInicio - DataHoraTermino).
12CPFCNPJContratadostring (14)SimCPF ou CNPJ do Contratado para realizar a Operação de Transporte.Para realizar o cadastro de um transportador, será necessário invocar o Método - CadastrarAtualizarTransportador
13ValorFretedecimal (12.2)SimValor referente ao frete contratado.N/A
14ValorCombustiveldecimal (12.2)SimValor referente ao combustível calculado.Ao inserir um valor nesse campo, iremos somar o valor informado com o valor do frete.

O pagamento desse valor será somado ao ValorFrete.
15ValorPedagiodecimal (12.2)SimValor referente ao pedágio calculado.Campo meramente informativo, não fazemos nada com ele.
16ValorDespesasdecimal (12.2)SimValor referente às despesas de viagem.O pagamento desse valor será somado ao ValorFrete.
17ValorImpostoSestSenatdecimal (12.2)SimValor referente ao imposto SEST SENAT (quando houver).N/A
18ValorImpostoIRRFdecimal (12.2)SimValor referente ao imposto IRRF (quando houver).N/A
19ValorImpostoINSSdecimal (12.2)SimValor referente ao imposto INSS (quando houver).N/A
20ValorImpostoIcmsIssqndecimal (12.2)SimValor referente ao imposto ICMS ISSQN (quando houver).N/A
21ParcelaUnicabool (true || false)SimFlag que define se a operação será paga em parcela única.

N/A

22ModoCompraValePedagiointSimIdentificador do modo de compra do vale pedágio.

1= Cartão Transporte Bradesco TARGET

2= Via Fácil (Sem Parar)

4= Nenhum

23CategoriaVeiculointSimIdentificador da categoria do veículo.
View file
nameCategoriaDeVeículos.xlsx
height150
24NomeMotoristastring (100)SimNome do motorista da operação de transporte.Para realizar o cadastro de um Motorista, será necessário invocar o Método - CadastrarAtualizarMotorista
25CPFMotoristastring (11)SimCPF do motorista da operação de transporte.Para realizar o cadastro de um Motorista, será necessário invocar o Método - CadastrarAtualizarMotorista
26RNTRCMotoristastring (8)NãoRNTRC do motorista da operação de transporte.Para realizar o cadastro de um Motorista, será necessário invocar o Método - CadastrarAtualizarMotorista
27ItemFinanceirostring (255)NãoNúmero do documento da Operação de Transporte.N/A
28ParcelasList< Operação Transporte Parcela Request>SimLista de parcelas (consulte especificação de lista de 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).
29VeiculosList< Operação Transporte Veiculo Request>SimLista de VeículosN/A
30IdRotaModelointNãoId da rota modelo, caso queira associar uma rota à operação. Ao colocar a rota, o valor do vale pedágio é automaticamente
recalculado e ajustado na operação de transporte.

Pode ser utilizado mesmo se não houver pedágio na Operação de Transporte, caso o mesmo seja informado, não é necessário informar os Códigos IBGEs de Origem e Destino.


As Rotas são cadastradas previamente através da Plataforma Web TARGET Frete.

31DeduzirImpostosbool (true || false)NãoDeduzir Impostos do valor total contratado.

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


Cálculo:

  1. ValorFrete - (Valor bruto do frete)
  2. Soma de todos os Impostos
  3. 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
32TarifasBancariasdecimal (12.2)SimTarifas BancáriasO valor total das tarifas bancárias será subtraído do valor total do frete.
33QuantidadeTarifasBancariasintSimQuantidade Tarifas Bancárias

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

View file
nameresolução_3.658_compilada_em_10.3.16.pdf
height150

34IdIntegradorstringSimId Integrador

ID único do sistema de TMS da transportadora.

Campo validador, não aceitamos código iguais em compras diferentes.

Prezado integrador, esse Id é você quem gera e informa para a TARGET, é para o seu controle.

35ValorDescontoAntecipadodecimal (12.2)NãoValor a ser aplicado no CIOT no valor bruto, não influenciando nas parcelas do CIOT.Favor, passar esse campo o valor 0 ou NULL.
36CPFCNPJParticipanteDestinatariostringNãoCNPJ do destinatário caso deseje ser informado.

Para realizar o cadastro de um Participante, e será necessário invocar o Método - CadastrarAtualizarParticipante


É Obrigatório informar ao menos um dos tipos de participantes:

  • CPFCNPJParticipanteDestinatario
  • CPFCNPJParticipanteContratante
  • CPFCNPJParticipanteSubcontratante
  • CPFCNPJParticipanteConsignatario
37CPFCNPJParticipanteContratantestringNãoCNPJ do Contratante caso deseje ser informado.

Para realizar o cadastro de um Participante, e será necessário invocar o Método - CadastrarAtualizarParticipante


É Obrigatório informar ao menos um dos tipos de participantes:

  • CPFCNPJParticipanteDestinatario
  • CPFCNPJParticipanteContratante
  • CPFCNPJParticipanteSubcontratante
  • CPFCNPJParticipanteConsignatario
38CPFCNPJParticipanteSubcontratantestringNãoCNPJ do Subcontratante caso deseje ser informado.

Para realizar o cadastro de um Participante, e será necessário invocar o Método - CadastrarAtualizarParticipante


É Obrigatório informar ao menos um dos tipos de participantes:

  • CPFCNPJParticipanteDestinatario
  • CPFCNPJParticipanteContratante
  • CPFCNPJParticipanteSubcontratante
  • CPFCNPJParticipanteConsignatario
39CPFCNPJParticipanteConsignatariostringNãoCNPJ do Consignatário caso deseje ser informado.

Para realizar o cadastro de um Participante, e será necessário invocar o Método - CadastrarAtualizarParticipante


É Obrigatório informar ao menos um dos tipos de participantes:

  • CPFCNPJParticipanteDestinatario
  • CPFCNPJParticipanteContratante
  • CPFCNPJParticipanteSubcontratante
  • CPFCNPJParticipanteConsignatario
40NumeroLacreTransporteCombustivelstringNãoNúmero Lacre Transportes CombustívelN/A
41ListaDestinatariosAdicionaisList< Participante Destinatário Adicional Request>NãoLista de Destinatários ()

O Usuário poderá informar uma lista de Destinatário Adicionais.


Mas usado em CIOT TAC-Agregado.

TipoOperacao = 3

42NumeroCartaoValePedagiostringNãoNúmero Cartão Vale PedágioPoderá fazer uso da mesma quando for informado 1 na TAG - 'ModoCompraValePedagio'. Só poderá ser utilizado cartões
do Tipo VTG 900 (Cartões exclusivos Vale Pedágio).
43Quitacaobool (true || false)NãoQuitaçãoN/A
44DadosQuitacaoList< Dados Quitação Frete Request>SimDados para Quitação de Frete

N/A


45DocumentoValePedagiostringNãoObservações da compra de Vale-Pedágio Cartão ou TAGN/A
46CEPOrigemValorImpostoISSdecimalNãoValor do Imposto ISSN/A
47
TipoFormaPagamento
enumNãoTipo de pagamento do Frete

BaseadoNasParcelas = 1

OutraIPEF = 2

Outro = 3

48CepOrigemstringNãoSimCEP Cep de Origem da viagem

N/A

4749CEPDestinoCepDestinostringNãoCEP DestinoSimCep de destino da viagemN/A
4850TipoCargaANTTintNãoTipo Carga ANTT

GranelSolido = 1
GranelLiquido = 2
Frigorificada = 3
Conteinerizada = 4
CargaGeral = 5
Neogranel = 6
PerigosaGranelSolido = 7
PerigosaGranelLiquido = 8
PerigosaCargaFrigorificada = 9
PerigosaConteinerizada = 10
PerigosaCargaGeral = 11

PerigosaCargaPressurizada = 12

4951DistanciaPercorridaintNãoDistância PercorridaDistancia total a ser percorrida na viagemN/A
5052AltoDesempenhobool(true || false)NãoIndica se o veículo é sera uma viagem de alto desempenho ou não.N/A
5153DestinaçãoComercialDestinacaoComercialbool(true || false)NãoNão Indica se o transporte da carga tem sera uma viagem com destinação comercial.N/A
5254FreteRetornobool(true || false)NãoIndica se existe frete de retorno.N/A
53CepRetornostringNão CEP de retorno da cargaN/A
54DistanciaRetornostring

List<DadosFrete

RetornoRequest>

NãoDistancia (em km) percorrida entre o CEP destino e o CEP retorno informado.N/A
55ValorImpostoISSCnpjPagamentoOutraIPEFdecimalstringNãoValor do Imposto ISSCNPJ da IPEF na qual sera realizada o pagamentoN/A


OperacaoTransporteParcelaRequest
CampoTipoObrigatórioDescriçãoObservação
1DescricaoParcelastring (50)SimDescrição da parcela
  • Adiantamento
  • Saldo
  • Intermediária
  • Adicional
2Valordecimal (12.2)SimValor da parcelaN/A
3NumeroParcelaintSimNúmero da parcelaO campo foi descontinuado. Favor informar zero.
4DataVencimentoDatetime (YYYY-MM-DD)SimData do vencimento da parcela.Exemplo: (2018-08-20T10:05:33)
5TipoDaParcelaintSimTipo da parcela

1= 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 FormaPagamento = 1
8CodigoBancostringSimCódigo do banco de compensaçãoObrigatório Se FormaPagamento = 2 (Vide Capítulo deAnexos).
9AgenciaDepositostring (15)SimAgência da rede bancária onde será realizado o pagamento.Obrigatório se FormaPagamento = 2
10ContaDepositostring (15)SimConta da agência onde será realizado o pagamento.Obrigatório se FormaPagamento = 2
11DigitoContaDepositostring (15)SimDigito verificador da conta que será realizado o pagamento.Obrigatório se FormaPagamento = 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 ou através da integração.
Caso o Pagamento da mesma seja Manual, deverá ser invocado o método - 'PagarParcelaIndividual'.
13IdOperacaoTransporteParcelaintNãoIdentificador 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.
15VariacaoContaPoupancastring (10)SimVariação da Conta Poupança (caso seja uma).N/A
16ItemFinanceiroParcelastringN/AItem Financeiro ParcelaN/A

...

DadosQuitacaoFreteDocumentosRequest
CampoTipoObrigatórioDescriçãoObservação
1NomeDocumentostringNãoTipo do DocumentoCT-e, NF-e, DACTE e etc
2NumeroIdentificadorDocumentostringSimId de Controle do Cliente/IntegradorO Cliente ou Integrador que deverá informar esse Id.
3Obrigatoriobool(true || false)SimO Documento é Obrigatório para Quitação?N/A
4DocumentoGeradoDestinobool(true || false)NãoO Documento só será gerado no Destino?Ex: Terminal de Carregamento


CampoTipoObrigatorioDescriçãoObservação
1DistanciaRetoronointSimDistancia de retorno da viagemN/A
2


Cep de retorno da viagemN/A






Response

OperacaoTransporteResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Erro.NULO em caso de Sucesso
2IdOperacaoTransporteintSimRetorna o Id Operação Transporte.N/A
3CIOTstringNãoRetorna o código do CIOT.N/A
4CodigoCentroDeCustostringNão

Retorna o Código do Centro de Custo do Cliente no Sistema TARGET Frete.

N/A
5NCMstringSimCódigo de 4 caracteres que identifica a Natureza carga posição previsto pelo SH (Sistema Harmonizado) exigido
pela ANTT.
Ministério da Fazenda - NCM
6ProprietarioCargastringNãoRetorna o Consignatário/Proprietário da Carga.N/A
7PesoCargadecimalSimRetorna o peso da carga que está sendo transportada entre a origem e destino.N/A
8TipoOperacaostringSimRetorna o tipo da operação de transporte que está sendo contratada.N/A
9MunicipioOrigemCodigoIBGEintSimRetorna o código do IBGE referente ao município de origem.N/A
10MunicipioDestinoCodigoIBGEintSimRetorna o código do IBGE referente ao município de destino.N/A
11DataHoraInicioDatetime (YYYY-MM-DD)SimRetorna a data e hora do início previsto para a realização efetiva da operação de transporte.Exemplo: (2018-08-20T10:05:33)
12DataHoraTerminoDatetime (YYYY-MM-DD)SimRetorna a data e hora do término previsto para a realização efetiva da operação de transporte.Exemplo: (2018-08-20T10:05:33)
13CPFCNPJContratadostringNãoRetorna o CPF ou CNPJ do Contratado para realizar o efetivo transporte.N/A
14ValorFretedecimalNãoRetorna o valor referente ao frete contratado.N/A
15ValorCombustiveldecimalNãoRetorna o valor referente ao combustível calculado.N/A
16ValorPedagiodecimalNãoRetorna o valor referente ao pedágio calculado.N/A
17ValorDespesasdecimalNãoRetorna o valor referente às despesas de viagem.N/A
18ValorImpostoSestSenatdecimalNãoRetorna o valor referente ao imposto SEST SENAT (quando houver).N/A
19ValorImpostoIRRFdecimalNãoRetorna o valor referente ao imposto IRRF (quando houver).N/A
20ValorImpostoINSSdecimalNãoRetorna o valor referente ao imposto INSS (quando houver).N/A
21ValorImpostoIcmsIssqndecimalNãoRetorna o valor referente ao imposto ICMS ISSQN (quando houver).N/A
22ParcelaUnicabool (true || false)SimRetorna a Flag que define se a operação será paga em parcela única.N/A
23ModoCompraValePedagiointSimRetorna o identificador do modo de compra do vale pedágio.N/A
24CategoriaVeiculointSimRetorna o identificador da categoria do veículo.
View file
nameCategoriaDeVeículos.xlsx
height150
25NomeMotoristastringNãoRetorna o nome do motorista da operação de transporte.N/A
26CPFMotoristastringNãoRetorna o CPF do motorista da operação de transporte.N/A
27RNTRCMotoristastringNãoRetorna o RNTRC do motorista da operação de transporte.N/A
28Triadabool (true || false)SimTriadaN/A
29ItemFinanceirostringNãoRetorna o número do documento da Operação de Transporte.N/A
30ParcelasList< Operação Transporte Parcelas Response>NãoLista de parcelas - Response.N/A
31VeiculosList< Operação Transporte Veiculo Response>NãoLista de veículos - Response.N/A
32ValorContratadodecimalNãoValor ContratadoN/A
33DispensadoPelaANTTbool (true || false)SimSe o Transportador é Dispensado pela ANTT.N/A
34TarifasBancariasdecimalNãoRetorna o valor referente a Tarifas Bancárias (quando houver).N/A
35ValorImpostoPISdecimalNãoRetorna o valor do Imposto PIS.N/A
36ValorImpostoCofinsdecimalNãoRetorna o valor do Imposto COFINS.N/A
37BaseCalculoPISCofinsdecimalNãoRetorna a base de calculo PIS e COFINS.N/A
38ValorDescontoAntecipadodecimalNãoRetorna o Valor do Desconto Antecipado.N/A
39IdCompraValePedagiointNãoRetorna o Id da compra do Vale Pedágio.N/A
40CPFCNPJParticipanteDestinatariostringNãoRetorna o CPF ou CNPJ do Destinatário caso tenha sido informado.N/A
41CPFCNPJParticipanteContratantestringNãoRetorna o CPF ou CNPJ do Participante Contratante caso tenha sido informado.N/A
42CPFCNPJParticipanteSubcontratantestringNãoRetorna o CPF ou CNPJ do Subcontratante caso tenha sido informado.N/A
43CPFCNPJParticipanteConsignatariostringNãoRetorna o CPF ou CNPJ do Consignatário caso tenha sido informado.N/A
44NumeroLacreTransporteCombustivelstringNãoNúmero Lacre Transporte CombustívelN/A
45ParticipantesDestinatariosstringSimRetorna os Participantes da Operação de Transporte.N/A
46StatusOperacaostringSimStatus da Operação de TransporteN/A
47Quitacaobool (true || false)NãoQuitçãoN/A
48DadosQuitacaoList< Dados Quitação Frete Response>NãoDados para Quitação de FreteN/A
49DocumentoValePedagiostringNãoObservações da compra de Vale-Pedágio Cartão ou TAGN/A
50ChaveQuitacaostringNãoChave para realizar QuitaçõesN/A
51MensagemRetornostringSimMensagem de RetornoN/A
52
CEPOrigem
stringNãoCEP OrigemN/A
53
CEPDestino
stringNãoCEP DestinoN/A
54
TipoCargaANTT
intNãoTipo Carga ANTTGranelSolido = 1
GranelLiquido = 2
Frigorificada = 3
Conteinerizada = 4
CargaGeral = 5
Neogranel = 6
PerigosaGranelSolido = 7
PerigosaGranelLiquido = 8
PerigosaCargaFrigorificada = 9
PerigosaConteinerizada = 10
PerigosaCargaGeral = 11
55
DistanciaPercorrida
intNãoDistância PercorridaN/A

...