...
OperacaoTransporteRequest | |||||||||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
1 | Instrucao | int | Sim | Instrucao para criação de uma nova Operacao. | 1= Inserir ou Atualizar 2= Inserir se não existe 4= Desativar/Anular Operação de Transporte | ||||||
2 | IdOperacaoTransporte | int | Não | Id da Operação de Transporte | Obrigatório apenas para Atualizar (1= Inserir ou Atualizar) ou Anular (4=Desativar/Anular Operação de Transporte) o cadastro da Operação de Transporte. | ||||||
3 | CodigoCentroDeCusto | string | Não | Có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 | ||||||
4 | 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 | ||||||
5 | ProprietarioCarga | int | Sim | Indica quem é o Consignatário/Proprietário da Carga. | 1= Remetente 2= Destinatário | ||||||
6 | PesoCarga | decimal (12.2) | Sim | Indica 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. | ||||||
7 | TipoOperacao | string | Sim | Tipo da operação de transporte que está sendo contratada. | 1= Padrão 3= TAC-Agregado | ||||||
8 | MunicipioOrigemCodigoIBGE | int | Não | Có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. | ||||||
9 | MunicipioDestinoCodigoIBGE | int | Não | Có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. | ||||||
10 | DataHoraInicio | Datetime (YYYY-MM-DD) | Sim | Data 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:
| ||||||
11 | DataHoraTermino | Datetime (YYYY-MM-DD) | Sim | Data 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:
| ||||||
12 | CPFCNPJContratado | string (14) | Sim | CPF 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 | ||||||
13 | ValorFrete | decimal (12.2) | Sim | Valor referente ao frete contratado. | N/A | ||||||
14 | ValorCombustivel | decimal (12.2) | Sim | Valor 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. | ||||||
15 | ValorPedagio | decimal (12.2) | Sim | Valor referente ao pedágio calculado. | Campo meramente informativo, não fazemos nada com ele. | ||||||
16 | ValorDespesas | decimal (12.2) | Sim | Valor referente às despesas de viagem. | O pagamento desse valor será somado ao ValorFrete. | ||||||
17 | ValorImpostoSestSenat | decimal (12.2) | Sim | Valor referente ao imposto SEST SENAT (quando houver). | N/A | ||||||
18 | ValorImpostoIRRF | decimal (12.2) | Sim | Valor referente ao imposto IRRF (quando houver). | N/A | ||||||
19 | ValorImpostoINSS | decimal (12.2) | Sim | Valor referente ao imposto INSS (quando houver). | N/A | ||||||
20 | ValorImpostoIcmsIssqn | decimal (12.2) | Sim | Valor referente ao imposto ICMS ISSQN (quando houver). | N/A | ||||||
21 | ParcelaUnica | bool (true || false) | Sim | Flag que define se a operação será paga em parcela única. | N/A | ||||||
22 | ModoCompraValePedagio | int | Sim | Identificador do modo de compra do vale pedágio. | 1= Cartão Transporte Bradesco TARGET 2= Via Fácil (Sem Parar) 4= Nenhum | ||||||
23 | CategoriaVeiculo | int | Sim | Identificador da categoria do veículo. |
| ||||||
24 | NomeMotorista | string (100) | Sim | Nome do motorista da operação de transporte. | Para realizar o cadastro de um Motorista, será necessário invocar o Método - CadastrarAtualizarMotorista | ||||||
25 | CPFMotorista | string (11) | Sim | CPF do motorista da operação de transporte. | Para realizar o cadastro de um Motorista, será necessário invocar o Método - CadastrarAtualizarMotorista | ||||||
26 | RNTRCMotorista | string (8) | Não | RNTRC do motorista da operação de transporte. | Para realizar o cadastro de um Motorista, será necessário invocar o Método - CadastrarAtualizarMotorista | ||||||
27 | ItemFinanceiro | string (255) | Não | Número do documento da Operação de Transporte. | N/A | ||||||
28 | Parcelas | List< Operação Transporte Parcela Request> | Sim | Lista 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). | ||||||
29 | Veiculos | List< Operação Transporte Veiculo Request> | Sim | Lista de Veículos | N/A | ||||||
30 | IdRotaModelo | int | Não | Id 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. | ||||||
31 | DeduzirImpostos | bool (true || false) | Não | Deduzir 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:
Objeto Parcelas - List< Operação Transporte Parcela Request> Impostos:
| ||||||
32 | TarifasBancarias | decimal (12.2) | Sim | Tarifas Bancárias | O valor total das tarifas bancárias será subtraído do valor total do frete. | ||||||
33 | QuantidadeTarifasBancarias | int | Sim | Quantidade Tarifas Bancárias | Deve ser informado 8 como dizem as regras da ANTT conforme resolução abaixo na página 14.
| ||||||
34 | IdIntegrador | string | Sim | Id Integrador | ID único do sistema de TMS da transportadora. Campo validador, não aceitamos código iguais em compras diferentes. | ||||||
35 | ValorDescontoAntecipado | decimal (12.2) | Não | Valor a ser aplicado no CIOT no valor bruto, não influenciando nas parcelas do CIOT. | Favor, passar esse campo o valor 0 ou NULL. | ||||||
36 | CPFCNPJParticipanteDestinatario | string | Não | CNPJ 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:
| ||||||
37 | CPFCNPJParticipanteContratante | string | Não | CNPJ 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:
| ||||||
38 | CPFCNPJParticipanteSubcontratante | string | Não | CNPJ 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:
| ||||||
39 | CPFCNPJParticipanteConsignatario | string | Não | CNPJ 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:
| ||||||
40 | NumeroLacreTransporteCombustivel | string | Não | Número Lacre Transportes Combustível | N/A | ||||||
41 | ListaDestinatariosAdicionais | List< Participante Destinatário Adicional Request> | Não | Lista de Destinatários () | O Usuário poderá informar uma lista de Destinatário Adicionais. Mas usado em CIOT TAC-Agregado. TipoOperacao = 3 | ||||||
42 | NumeroCartaoValePedagio | string | Não | Número Cartão Vale Pedágio | Poderá 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). | ||||||
43 | Quitacao | bool (true || false) | Não | Quitação | N/A | ||||||
44 | DadosQuitacao | List< Dados Quitação Frete Request> | Sim | Dados para Quitação de Frete | N/A | ||||||
45 | DocumentoValePedagio | string | Não | Observações da compra de Vale-Pedágio Cartão ou TAG | N/A | ||||||
46 | CEPOrigemValorImpostoISS | decimal | Não | Valor do Imposto ISS | N/A | ||||||
47 | TipoFormaPagamento | enum | Não | Tipo de pagamento do Frete | BaseadoNasParcelas = 1 OutraIPEF = 2 Outro = 3 | ||||||
48 | CepOrigem | string | NãoSim | CEP Cep de Origem da viagem | N/A | ||||||
4749 | CEPDestinoCepDestino | string | Não | CEP DestinoSim | Cep de destino da viagem | N/A | |||||
4850 | TipoCargaANTT | int | Não | Tipo Carga ANTT | GranelSolido = 1 PerigosaCargaPressurizada = 12 | ||||||
4951 | DistanciaPercorrida | int | NãoDistância Percorrida | Distancia total a ser percorrida na viagem | N/A | ||||||
5052 | AltoDesempenho | bool(true || false) | Não | Indica se o veículo é sera uma viagem de alto desempenho ou não. | N/A | ||||||
5153 | DestinaçãoComercialDestinacaoComercial | bool(true || false) | NãoNão | Indica se o transporte da carga tem sera uma viagem com destinação comercial. | N/A | ||||||
5254 | FreteRetorno | bool(true || false) | Não | Indica se existe frete de retorno. | N/A | ||||||
53 | CepRetorno | string | Não | CEP de retorno da carga | N/A | ||||||
54 | DistanciaRetorno | string | List<DadosFrete RetornoRequest> | Não | Distancia (em km) percorrida entre o CEP destino e o CEP retorno informado. | N/A | |||||
55 | ValorImpostoISSCnpjPagamentoOutraIPEF | decimalstring | NãoValor do Imposto ISS | CNPJ da IPEF na qual sera realizada o pagamento | N/A |
OperacaoTransporteParcelaRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | DescricaoParcela | string (50) | Sim | Descrição da parcela |
|
2 | Valor | decimal (12.2) | 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 do 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 FormaPagamento = 1 |
8 | CodigoBanco | string | Sim | Código do banco de compensação | Obrigatório Se FormaPagamento = 2 (Vide Capítulo deAnexos). |
9 | AgenciaDeposito | string (15) | Sim | Agência da rede bancária onde será realizado o pagamento. | Obrigatório se FormaPagamento = 2 |
10 | ContaDeposito | string (15) | Sim | Conta da agência onde será realizado o pagamento. | Obrigatório se FormaPagamento = 2 |
11 | DigitoContaDeposito | string (15) | Sim | Digito verificador da conta que será realizado o pagamento. | Obrigatório se FormaPagamento = 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 ou através da integração. | Caso o Pagamento da mesma seja Manual, deverá ser invocado o método - 'PagarParcelaIndividual'. |
13 | IdOperacaoTransporteParcela | int | Não | 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 (10) | Sim | Variação da Conta Poupança (caso seja uma). | N/A |
16 | ItemFinanceiroParcela | string | N/A | Item Financeiro Parcela | N/A |
...
DadosQuitacaoFreteDocumentosRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | NomeDocumento | string | Não | Tipo do Documento | CT-e, NF-e, DACTE e etc |
2 | NumeroIdentificadorDocumento | string | Sim | Id de Controle do Cliente/Integrador | O Cliente ou Integrador que deverá informar esse Id. |
3 | Obrigatorio | bool(true || false) | Sim | O Documento é Obrigatório para Quitação? | N/A |
4 | DocumentoGeradoDestino | bool(true || false) | Não | O Documento só será gerado no Destino? | Ex: Terminal de Carregamento |
N° | Campo | Tipo | Obrigatorio | Descrição | Observação |
---|---|---|---|---|---|
1 | DistanciaRetorono | int | Sim | Distancia de retorno da viagem | N/A |
2 | Cep de retorno da viagem | N/A | |||
Response
OperacaoTransporteResponse | |||||||||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro. | NULO em caso de Sucesso | ||||||
2 | IdOperacaoTransporte | int | Sim | Retorna o Id Operação Transporte. | N/A | ||||||
3 | CIOT | string | Não | Retorna o código do CIOT. | N/A | ||||||
4 | CodigoCentroDeCusto | string | Não | Retorna o Código do Centro de Custo do Cliente no Sistema TARGET Frete. | N/A | ||||||
5 | 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 | ||||||
6 | ProprietarioCarga | string | Não | Retorna o Consignatário/Proprietário da Carga. | N/A | ||||||
7 | PesoCarga | decimal | Sim | Retorna o peso da carga que está sendo transportada entre a origem e destino. | N/A | ||||||
8 | TipoOperacao | string | Sim | Retorna o tipo da operação de transporte que está sendo contratada. | N/A | ||||||
9 | MunicipioOrigemCodigoIBGE | int | Sim | Retorna o código do IBGE referente ao município de origem. | N/A | ||||||
10 | MunicipioDestinoCodigoIBGE | int | Sim | Retorna o código do IBGE referente ao município de destino. | N/A | ||||||
11 | DataHoraInicio | Datetime (YYYY-MM-DD) | Sim | Retorna a data e hora do início previsto para a realização efetiva da operação de transporte. | Exemplo: (2018-08-20T10:05:33) | ||||||
12 | DataHoraTermino | Datetime (YYYY-MM-DD) | Sim | Retorna a data e hora do término previsto para a realização efetiva da operação de transporte. | Exemplo: (2018-08-20T10:05:33) | ||||||
13 | CPFCNPJContratado | string | Não | Retorna o CPF ou CNPJ do Contratado para realizar o efetivo transporte. | N/A | ||||||
14 | ValorFrete | decimal | Não | Retorna o valor referente ao frete contratado. | N/A | ||||||
15 | ValorCombustivel | decimal | Não | Retorna o valor referente ao combustível calculado. | N/A | ||||||
16 | ValorPedagio | decimal | Não | Retorna o valor referente ao pedágio calculado. | N/A | ||||||
17 | ValorDespesas | decimal | Não | Retorna o valor referente às despesas de viagem. | N/A | ||||||
18 | ValorImpostoSestSenat | decimal | Não | Retorna o valor referente ao imposto SEST SENAT (quando houver). | N/A | ||||||
19 | ValorImpostoIRRF | decimal | Não | Retorna o valor referente ao imposto IRRF (quando houver). | N/A | ||||||
20 | ValorImpostoINSS | decimal | Não | Retorna o valor referente ao imposto INSS (quando houver). | N/A | ||||||
21 | ValorImpostoIcmsIssqn | decimal | Não | Retorna o valor referente ao imposto ICMS ISSQN (quando houver). | N/A | ||||||
22 | ParcelaUnica | bool (true || false) | Sim | Retorna a Flag que define se a operação será paga em parcela única. | N/A | ||||||
23 | ModoCompraValePedagio | int | Sim | Retorna o identificador do modo de compra do vale pedágio. | N/A | ||||||
24 | CategoriaVeiculo | int | Sim | Retorna o identificador da categoria do veículo. |
| ||||||
25 | NomeMotorista | string | Não | Retorna o nome do motorista da operação de transporte. | N/A | ||||||
26 | CPFMotorista | string | Não | Retorna o CPF do motorista da operação de transporte. | N/A | ||||||
27 | RNTRCMotorista | string | Não | Retorna o RNTRC do motorista da operação de transporte. | N/A | ||||||
28 | Triada | bool (true || false) | Sim | Triada | N/A | ||||||
29 | ItemFinanceiro | string | Não | Retorna o número do documento da Operação de Transporte. | N/A | ||||||
30 | Parcelas | List< Operação Transporte Parcelas Response> | Não | Lista de parcelas - Response. | N/A | ||||||
31 | Veiculos | List< Operação Transporte Veiculo Response> | Não | Lista de veículos - Response. | N/A | ||||||
32 | ValorContratado | decimal | Não | Valor Contratado | N/A | ||||||
33 | DispensadoPelaANTT | bool (true || false) | Sim | Se o Transportador é Dispensado pela ANTT. | N/A | ||||||
34 | TarifasBancarias | decimal | Não | Retorna o valor referente a Tarifas Bancárias (quando houver). | N/A | ||||||
35 | ValorImpostoPIS | decimal | Não | Retorna o valor do Imposto PIS. | N/A | ||||||
36 | ValorImpostoCofins | decimal | Não | Retorna o valor do Imposto COFINS. | N/A | ||||||
37 | BaseCalculoPISCofins | decimal | Não | Retorna a base de calculo PIS e COFINS. | N/A | ||||||
38 | ValorDescontoAntecipado | decimal | Não | Retorna o Valor do Desconto Antecipado. | N/A | ||||||
39 | IdCompraValePedagio | int | Não | Retorna o Id da compra do Vale Pedágio. | N/A | ||||||
40 | CPFCNPJParticipanteDestinatario | string | Não | Retorna o CPF ou CNPJ do Destinatário caso tenha sido informado. | N/A | ||||||
41 | CPFCNPJParticipanteContratante | string | Não | Retorna o CPF ou CNPJ do Participante Contratante caso tenha sido informado. | N/A | ||||||
42 | CPFCNPJParticipanteSubcontratante | string | Não | Retorna o CPF ou CNPJ do Subcontratante caso tenha sido informado. | N/A | ||||||
43 | CPFCNPJParticipanteConsignatario | string | Não | Retorna o CPF ou CNPJ do Consignatário caso tenha sido informado. | N/A | ||||||
44 | NumeroLacreTransporteCombustivel | string | Não | Número Lacre Transporte Combustível | N/A | ||||||
45 | ParticipantesDestinatarios | string | Sim | Retorna os Participantes da Operação de Transporte. | N/A | ||||||
46 | StatusOperacao | string | Sim | Status da Operação de Transporte | N/A | ||||||
47 | Quitacao | bool (true || false) | Não | Quitção | N/A | ||||||
48 | DadosQuitacao | List< Dados Quitação Frete Response> | Não | Dados para Quitação de Frete | N/A | ||||||
49 | DocumentoValePedagio | string | Não | Observações da compra de Vale-Pedágio Cartão ou TAG | N/A | ||||||
50 | ChaveQuitacao | string | Não | Chave para realizar Quitações | N/A | ||||||
51 | MensagemRetorno | string | Sim | Mensagem de Retorno | N/A | ||||||
52 | CEPOrigem | string | Não | CEP Origem | N/A | ||||||
53 | CEPDestino | string | Não | CEP Destino | N/A | ||||||
54 | TipoCargaANTT | int | Não | Tipo Carga ANTT | GranelSolido = 1 GranelLiquido = 2 Frigorificada = 3 Conteinerizada = 4 CargaGeral = 5 Neogranel = 6 PerigosaGranelSolido = 7 PerigosaGranelLiquido = 8 PerigosaCargaFrigorificada = 9 PerigosaConteinerizada = 10 PerigosaCargaGeral = 11 | ||||||
55 | DistanciaPercorrida | int | Não | Distância Percorrida | N/A |
...