...
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 Target Conta Digital ou Bradesco 2= Via Fácil (Sem Parar) 4= Nenhum 5= Veloe | ||||||
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. 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á Adcionado ao 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 mesmo se a compra não acontecer o IdIntegrador já não poderá ser mais utilizado. | ||||||
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 | Sim | CNPJ do destinatário. | Para realizar o cadastro de um Participante, e será necessário invocar o Método - CadastrarAtualizarParticipante É Obrigatório informar ao menos o CPFCNPJParticipanteDestinatario para operação tipo padrão. | ||||||
37 | CPFCNPJParticipanteContratante | string | Não | CNPJ do Contratante caso deseje ser informado. | N/A | ||||||
38 | CPFCNPJParticipanteSubcontratante | string | Não | CNPJ do Subcontratante caso deseje ser informado. | N/A | ||||||
39 | CPFCNPJParticipanteConsignatario | string | Não | CNPJ do Consignatário caso deseje ser informado. | N/A | ||||||
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. | ||||||
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 | ValorImpostoISS | 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 | Sim | Cep de Origem da viagem | N/A | ||||||
49 | CepDestino | string | Sim | Cep de destino da viagem | N/A | ||||||
50 | TipoCargaANTT | int | Não | Tipo Carga ANTT | GranelSolido = 1 PerigosaCargaPressurizada = 12 | ||||||
51 | DistanciaPercorrida | int | Não | Distancia total a ser percorrida na viagem | N/A | ||||||
52 | AltoDesempenho | bool(true || false) | Não | Indica se sera uma viagem de alto desempenho. | N/A | ||||||
53 | DestinacaoComercial | bool(true || false) | Não | Indica se sera uma viagem com destinação comercial. | N/A | ||||||
54 | FreteRetorno | List<DadosFrete RetornoRequest> | Não | Distancia (em km) percorrida entre o CEP destino e o CEP retorno informado. | N/A | ||||||
55 | CnpjPagamentoOutraIPEF | string | Não | 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 Target Conta Digital ou Bradesco 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 *Disponivel apenas para Cartões Target Conta Digital Pessoa Fisica, Juridica e Cartões Bradesco PF e PJ *Não disponivel para cartões exclusivo Pedágio | ||
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 | ||
17 | FlagContaPagamento | bool (true || false) | Flag que indica se é uma conta Pagamento ou não. | N/A | |||
18 | ChavePix | string |
|
| N/A | ||
19 | TipoChavePIX | string | sim |
| 1- CPF/CNPJ 2 -Email 3 - Celular 4 - Aleatória 5 - Manual (dados bancários da conta) | ||
20 | CPFCNPJBeneficiarioContaDestino | string | Sim | CPF ou CNPJ do titular da conta que possui a chave PIX |
| ||
21 | CodigoBanco | string | Não | Código do banco do titular da conta que possui a chave PIX somente para "TipoChavePix Manual =5” | Somente para "TipoChavePix=5" | ||
22 | NumeroConta | string | Não |
|
| ||
23 | DigitoConta | string | Não |
| Somente para "TipoChavePix=5" | ||
24 | NumeroAgencia | string | Não |
| Somente para "TipoChavePix=5" | ||
25 | TipoContaDestinoFinanceiro | string | Não |
|
| ||
26 | NomeBeneficiarioContaDestino | string | Sim |
|
|
OperacaoTransporteVeiculoRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Placa | string (7) | Sim | Placa do veículo | É obrigatório informar a Placa do veículo que irá realizar o transporte para a ANTT. A Placa do veículo, deve pertencer ao mesmo RNTRC do contratado(Transportador). |
2 | RNTRC | string (8) | Sim | RNTRC vinculado ao veículo | É obrigatório informar a RNTRC que a Placa está associada.
|
...