...

Info

title	Observações Importantes

As Operações de Transporte do tipo viagem padrão poderão ser declaradas com até trinta dias de antecedência da data de início da viagem e não poderão ter duração maior que noventa dias.
As Operações de Transporte do tipo viagem TAC-agregado deverão ser declaradas na data de início da operação e não poderão ter duração maior que trinta dias.
Nos casos de Operação de Transporte de Alto Desempenho deve-se informar que se trata desse tipo de operação e declarar como viagem do tipo padrão.
Este método não registra a operação na ANTT, o mesmo somente cadastra as informações no sistema TARGET Frete.

Info

title	CIOT- Frota Própria

Para fazer uso do CIOT-Frota Própria , o Cliente deverá estar parametrizado para tal (O Cliente deverá entrar em contato com o Time Comercial da TARGET).
O CIOT-Frota Própria só poderá ser realizada dentro de Operações de Transportes do Tipo Padrão.
Considerações sobre Parcela de Pagamento:
1. Mediante a informação da Tag 'TipoFormaPagamento' como Outro ou então OutraIPEF a necessidade de informar parcelas se torna não obrigatória, ou seja, não existira a necessidade de informar os campos relacionados a parcelas

Info

title	CIOT Sem Pagamento

O CIOT-Sem Pagamento só poderá ser realizada dentro de Operações de Transportes do Tipo Padrão.
Considerações sobre Parcela de Pagamento:
1. Mediante a informação da Tag 'TipoFormaPagamento' como Outro ou então OutraIPEF a necessidade de informar parcelas se torna não obrigatória, ou seja, não existira a necessidade de informar os campos relacionados a parcelas

Info

title	Quitação - Observações Importantes

Para fazer uso do Módulo de Quitação, o Cliente deverá estar parametrizado para tal (O Cliente deverá entrar em contato com o Time Comercial da TARGET).
A Quitação só poderá ser realizada dentro de Operações de Transportes do Tipo Padrão.
Considerações sobre Parcela de Pagamento:
1. A Quitação sempre será deduzida na Parcela de Pagamento do Tipo: Saldo.
2. Não tem como fazer uso da Quitação se a Operação de Transporte não conter uma Parcela de Pagamento do Tipo: Saldo.
3. A Parcela de Pagamento do Tipo: Saldo, não pode ser automática, ela deverá ser cadastrada como manual - Método - 'CadastrarAtualizarOperacaoTransporte', TAG - 'ProcessarAutomaticamente'.
Observações sobre o Pagamento mínimo da Parcela de Saldo (O Bradesco permite apenas o pagamento mínimo nos cartões no valor de R$5,00.):
1. Se o valor for 0 ou negativo:
  1. A Parcela de Pagamento do Tipo: Saldo, será dada como paga (Obs: O controle financeiro ficará com o cliente).
2. Se o valor for de R$0,01 até R$4,99:
  1. A Parcela será paga no valor mínimo de R$5,00(Obs: O controle financeiro ficará com o cliente).

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

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:

A data e hora que for informada, não pode ser DateTime Now, caso contrário, iremos dar um retorno de negócio.
A data e hora deve ter no mínimo 1h de intervalo (DataHoraInicio - DataHoraTermino).

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:

A data e hora que for informada, não pode ser DateTime Now, caso contrário, iremos dar um retorno de negócio.
A data e hora deve ter no mínimo 1h de intervalo (DataHoraInicio - DataHoraTermino).

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

6= ConectCar

7= MoveMais

8= Cartão Débito

23

CategoriaVeiculo

int

Sim

Identificador da categoria do veículo.

View file

name	CategoriaDeVeículos.xlsx
height	150

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:

ValorFrete - (Valor bruto do frete)
Soma de todos os Impostos
O Resultado, deverá ser pago através das Parcelas de Pagamento.

Objeto Parcelas - List< Operação Transporte Parcela Request>

Impostos:

ValorImpostoSestSenat
ValorImpostoIRRF
ValorImpostoINSS
ValorImpostoIcmsIssqn

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.

View file

name	resolução_3.658_compilada_em_10.3.16.pdf
height	150

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.

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

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
GranelLiquido = 2
Frigorificada = 3
Conteinerizada = 4
CargaGeral = 5
Neogranel = 6
PerigosaGranelSolido = 7
PerigosaGranelLiquido = 8
PerigosaCargaFrigorificada = 9
PerigosaConteinerizada = 10
PerigosaCargaGeral = 11

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

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
OperacaoTransporteParcelaRequest
1	DescricaoParcela	string (50)	Sim	Descrição da parcela	Adiantamento Saldo Intermediária Adicional
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 3= Pix 4= Vale-Abastecimento
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	DadosPix	List< Dados Pix Request >	Sim	Dados de Pix para preenchimento	N/A

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosPixRequest
1	ChavePix	string	Sim	Informar a chave Pix conforme a seleção do tipo no parâmetro “TipoChavePix"	N/A

19

2

TipoChavePIX

TipoChavePix

string

sim

Sim

Tag que direciona a forma de identificação que será realizado o pagamento PIX, conforme tipos disponíveis na observação.

1- CPF/CNPJ
2 - Email
3 - Celular
4 - Aleatória
5 - Manual (dados bancários da conta)

20

3

CPFCNPJBeneficiarioContaDestino

CPFCNPJBeneficiarioConta

string

Sim

CPF ou CNPJ do titular da conta que possui a chave

PIX

Pix

N/A

21

4

CodigoBanco

string

Não

Código

Código do banco do titular da conta que possui a chave

PIX

Pix somente para "TipoChavePix Manual =5”

Somente

Obrigatório para "TipoChavePix=5"

22

5

NumeroConta

string

Não

Número da conta do titular da conta que possui a chave

PIX

Pix, somente para "TipoChavePix Manual =5”

Somente

Obrigatório para "TipoChavePix=5"

23

6

DigitoConta

string

Não

Digito da conta do titular da conta que possui a chave

PIX

Pix, somente para "TipoChavePix Manual =5”

Somente

Obrigatório para "TipoChavePix=5"

24

7

NumeroAgencia

string

Não

Número da agência do titular da conta que possui a chave

PIX

Pix, somente para "TipoChavePix Manual =5”

Somente

Obrigatório para "TipoChavePix=5"

25

8

TipoContaDestinoFinanceiro

string

Não

Somente para "TipoChavePix=5"

1 -

conta

Conta corrente
2 -

conta

Conta pagamento
3 -

conta

Conta poupança

26

9

NomeBeneficiarioContaDestino

string

Sim

Nome do titular da conta que possui a chave

PIX

Pix

N/A

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.

O RNTRC no qual a Placa está associada, deve pertencer ao contratado(Transportador).

ParticipanteDestinatarioAdicionalRequest

Nº

Campo

Tipo

Obrigatório

Descrição

Observação

1

IdParticipante

int

Não

Id do Participante

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

É obrigatório informar o IdParticipante, caso não tenha informado o CPF/CNPJ.

2

CPFCNPJ

string

Não

CPF ou CNPJ do Participante

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

É obrigatório informar o CPF/CNPJ, caso não tenha informado o IdParticipante.

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosQuitacaoFreteRequest
1	ValorMercadoria	decimal	Sim	Valor Total da Mercadoria em Nota	Não pode ser informado com 0.
2	PesoCarregadoMercadoria	decimal	Sim	Peso Carregado da Mercadoria	Não pode ser informado com 0.
3	QuantidadeCarregada	int	Sim	Quantidade Carregada (Unidade)	Não pode ser informado com 0.
4	TipoCalculoAvaria	int	Não	Tipo Cálculo Avaria	Informar: Por Valor = 1 Por Unidade = 2 (Desconto na 'QuantidadeCarregada') Por Peso = 3 Nenhum = 4
5	EncerraNaANTT	bool (true \|\| false)	Sim	Encerra automaticamente a Operação de Transporte na ANTT no final da Quitação?	N/A
6	PorcentagemToleranciaPeso	decimal	Não	Porcentagem Tolerância Peso	Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 3. Tolerância para a perda da carga.
7	TipoToleranciaPeso	int	Não	Tipo Tolerância Peso	Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 3. Informar: Integral = 1 Excedente = 2 Nenhum = 3 Exemplo: PorcentagemToleranciaPeso = 10% PorcetagemPesoAMaior = 10% Integral → Será pago a porcentagem total excedida, referente ao valor total da carga.(Excedeu 1%, será pago os 11% excedido) Excedente → Só será pago a porcentagem excedente aos 10% do valor total da carga.(Excedeu 1%, será pago apenas o 1% excedido).
8	PorcetagemPesoAMaior	decimal	Não	Porcentagem Peso À Maior	Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 3. Tolerância para aumento da carga.
9	DocumentosQuitacao	List<DadosQuitacaoFreteDocumentosResponse>	Sim	Documentos de Quitação	Obrigatório somente quando a TAG - 'TipoCalculoAvaria' for igual a 3(Por Peso)
10	IdsTerminaisCarregamento	List<int>	Sim	Ids Terminais de Carregamento Retorno dos Ids no método - 'BuscarTerminaisCarregamentoAutorizados'	Os Terminais autorizados deverão ser cadastrados pelo Cliente através da Plataforma Web.
11	QuitaEmTodosTerminais	bool (true \|\| false)	Sim	Permite Quitação em todos os Terminais?	Sim - Não será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento' Não - Será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento'

...

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosQuitacaoFreteDocumentosRequest
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	DistanciaRetorno	int	Sim	Distancia de retorno da viagem	N/A
2	CepRetorno	string	Sim	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.

View file

name	CategoriaDeVeículos.xlsx
height	150

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

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
OperacaoTransporteParcelaResponse
1	Erro	ErroResponse - string	Não	Retorna o Código do Erro.	NULO em caso de sucesso.
2	IdOperacaoTransporteParcela	int	Sim	Retorna o Id da Operação Transporte Parcela.	Esse Id pode ser usado nos seguintes métodos: PagarParcelaIndividual EncerrarOperacaoTransporte RetificarOperacaoTransporte
3	CIOTCompleto	string	Não	CIOT completo	N/A
4	Valor	decimal	Sim	Valor	N/A
5	DataVencimento	Datetime (YYYY-MM-DD)	Sim	Retorna a Data do vencimento da parcela.	Exemplo: (2018-08-20T10:05:33)
6	DataPagamento	Datetime (YYYY-MM-DD)	Sim	Retorna a Data do Pagamento da Parcela.	Exemplo: (2018-08-20T10:05:33)
7	NumeroParcela	int	Sim	Retorna o Número da Parcela.	N/A
8	QuantidadeParcelas	int	Sim	Retorna a Quantidade de Parcelas.	N/A
9	DataHoraRegistro	Datetime (YYYY-MM-DD)	Sim	Data Hora Registro	Exemplo: (2018-08-20T10:05:33)
10	DescricaoParcela	string	Não	Retorna a descrição da Parcela.	N/A
11	Cancelada	bool (true \|\| false)	Sim	Retorna status de cancelamento da Parcela.	N/A
12	FormaPagamento	int	Sim	Retorna a forma de Pagamento da Parcela.	N/A
13	CartaoPagamento	string	Não	Cartão Pagamento	N/A
14	CodigoBanco	string	Não	Código Banco	N/A
15	AgenciaDeposito	string	Não	Agência Depósito	N/A
16	ContaDeposito	string	Não	Conta Deposito	N/A
17	DigitoContaDeposito	string	Não	Digito da Conta Deposito	N/A
18	StatusParcela	int	Sim	Status da Parcela	1= Parcela Pendente. 2= Parcela Paga. 3= Parcela Vencida.
19	TipoParcelaOperacaoTransporte	int	Não	Tipo Parcela Operação Transporte.	N/A
20	FlagContaPoupanca	bool (true \|\| false)	Não	Flag Conta Poupança	N/A
21	VariacaoContaPoupanca	string	Não	Variação Conta Poupança	N/A
22	ItemFinanceiroParcela	string	Não	Item Financeiro Parcela	N/A

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
OperacaoTransporteVeiculoResponse
1	Erro	ErroResponse - string	Não	Retorna o Erro.	NULO em caso de sucesso.
2	Placa	string	Não	Retorna a Placa do veículo.	N/A
3	RNTRC	string	Não	Retorna o RNTRC vinculado ao veículo.	N/A

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosQuitacaoFreteResponse
1	ValorMercadoria	decimal	Sim	Valor Total da Mercadoria em Nota	N/A
2	PesoCarregadoMercadoria	decimal	Sim	Peso Carregado da Mercadoria	N/A
3	QuantidadeCarregada	int	Sim	Quantidade Carregada (Unidade)	N/A
4	TipoCalculoAvaria	int	Não	Tipo Cálculo Avaria	Informar: Por Valor = 1 Por Peso = 2 Por Unidade = 3 (Desconto na 'QuantidadeCarregada') Nenhum = 4
5	EncerraNaANTT	bool(true \|\| false)	Sim	Encerra automaticamente a Operação de Transporte na ANTT no final da Quitação?	N/A
6	PorcentagemToleranciaPeso	decimal	Não	Porcentagem Tolerância Peso	Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2. Tolerância para a perda da carga.
7	TipoToleranciaPeso	int	Não	Tipo Tolerância Peso	Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2. Informar: Integral = 1 Excedente = 2 Nenhum = 3 Exemplo: PorcentagemToleranciaPeso = 10% PorcetagemPesoAMaior = 10% Integral → Será pago a porcentagem total excedida, referente ao valor total da carga.(Excedeu 1%, será pago os 11% excedido) Excedente → Só será pago a porcentagem excedente aos 10% do valor total da carga.(Excedeu 1%, será pago apenas o 1% excedido).
8	PorcetagemPesoAMaior	decimal	Não	Porcentagem Peso À Maior	Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 3. Tolerância para aumento da carga.
9	DocumentosQuitacao	List<DadosQuitacaoFreteDocumentosResponse>	Sim	Documentos de Quitação	Obrigatório somente quando a TAG - 'TipoCalculoAvaria' for igual a 3(Por Peso)
10	IdsTerminaisCarregamento	List<int>	Sim	Ids Terminais de Carregamento Retorno dos Ids no método - 'BuscarTerminaisCarregamentoAutorizados'	Os Terminais autorizados deverão ser cadastrados pelo Cliente através da Plataforma Web.
11	QuitaEmTodosTerminais	bool(true \|\| false)	Sim	Permite Quitação em todos os Terminais?	Sim - Não será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento' Não - Será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento'

...

Version	Old Version 120	New Version 121
Changes made by	thiago.morais	thiago.morais
Saved on	Aug 13, 2024	Dec 23, 2024

Versions Compared

Key

Request

Impostos:

Response

Page Comparison

Versions Compared

Key

Request

Impostos:

Response