Versions Compared

Version Old Version 9 New Version Current
Changes made by

Gabriel Nisã Brandão Casaes Monteiro

Gabriel Nisã Brandão Casaes Monteiro

Saved on

Key

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

...

CadastroAtualizacaoDadosQuitacaoRequest
NºCampoTipoObrigatórioDescriçãoObservação
1IdOperacaoTransporteintSimId da Operação de Transporte.N/ARetorno do Id no Response do método - 'CadastrarAtualizarOperacaoTransporte'
2DadosQuitacaoDadosQuitacaoFreteRequestSimDados de QuitaçãoN/A

...

DadosQuitacaoFreteRequest
NºCampoTipoObrigatórioDescriçãoObservação
1ValorMercadoriadecimalSimValor Total da Mercadoria em Nota
  1. Quando a Operação de Transporte conter Quitação e o usuário quiser atualizar os dados de Quitação, o usuário não poderá atualizar os seguintes dados:
    1. ValorMercadoria - Valor da Mercadoria em Nota
    2. PesoCarregadoMercadoria - Peso da Mercadoria
N/A
    1. Carregada
    2. QuantidadeCarregada - Quantidade Carregada (Unidade)
2PesoCarregadoMercadoriadecimalSimPeso Carregado da MercadoriaN/A
  1. Quando a Operação de Transporte conter Quitação e o usuário quiser atualizar os dados de Quitação, o usuário não poderá atualizar os seguintes dados:
    1. ValorMercadoria - Valor da Mercadoria em Nota
    2. PesoCarregadoMercadoria - Peso da Mercadoria Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
3QuantidadeCarregadaintSimQuantidade CarregadaN/ACarregada (Unidade)
  1. Quando a Operação de Transporte conter Quitação e o usuário quiser atualizar os dados de Quitação, o usuário não poderá atualizar os seguintes dados:
    1. ValorMercadoria - Valor da Mercadoria em Nota
    2. PesoCarregadoMercadoria - Peso da Mercadoria Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
4TipoCalculoAvariaintNãoTipo Cálculo Avaria

Informar:

  • Por Valor = 1
  • Por Peso = 2
  • Por Unidade = 3 (Desconto na 'QuantidadeCarregada')
  • Nenhum = 4
5EncerraNaANTTbool(true || false)SimEncerra automaticamente a Operação de Transporte na ANTT no final da Quitação?N/A
6PorcentagemToleranciaPesodecimalNãoPorcentagem Tolerância PesoN/A

Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2.


Tolerância para a perda da carga.

7TipoToleranciaPesointSimNãoTipo Tolerância Peso

Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2.


Informar:

  • Integral =
1
  • 1 
  • Excedente =
2
  • 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).

8PorcetagemPesoAMaiordecimalNãoPorcentagem Peso A MaiorN/AÀ Maior

Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2.


Tolerância para aumento da carga.

9DocumentosQuitacaoList<DadosQuitacaoFreteDocumentosResponse>SimDocumentos de QuitaçãoN/AObrigatório somente quando a TAG - 'TipoCalculoAvaria' for igual a 2(Por Peso)
10IdsTerminaisCarregamentoList<int>Sim

Ids Terminais de Carregamento


Retorno dos Ids no método - 'BuscarTerminaisCarregamentoAutorizados'

N/AOs Terminais autorizados deverão ser cadastrados pelo Cliente através da Plataforma Web.
11QuitaEmTodosTerminaisbool(true || false)SimQuita Em Permite Quitação em todos os TerminaisN/A?

Sim - Não será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento'

Não - Será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento'


DadosQuitacaoFreteDocumentosRequest
NºCampoTipoObrigatórioDescriçãoObservação
1NomeDocumentostringNãoNome DocumentoN/ATipo do DocumentoCT-e, NF-e, DACTE e etc
2NumeroIdentificadorDocumentostringSimNúmero Identificador DocumentoN/AId 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 Gerado só será gerado no DestinoN/A?Ex: Terminal de Carregamento


Response

DadosQuitacaoFreteResponse
NºCampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Erro.NULO em caso de sucesso.
2MensagemRetornointSimMensagem de RetornoN/A
3IdOperacaointSimRetorna o Id da Operação de TransporteN/ARetorno do Id no Response do método - 'CadastrarAtualizarOperacaoTransporte'
4dadosQuitacaoDadosQuitacaoFreteResponseSimDados de QuitaçãoN/A

...

CadastroAtualizacaoDadosQuitacaoResponse
NºCampoTipoObrigatórioDescriçãoObservação
1ValorMercadoriadecimalSimRetorna o Valor da MercadoriaN/AValor Total da Mercadoria em Nota
  1. Quando a Operação de Transporte conter Quitação e o usuário quiser atualizar os dados de Quitação, o usuário não poderá atualizar os seguintes dados:
    1. ValorMercadoria - Valor da Mercadoria em Nota
    2. PesoCarregadoMercadoria - Peso da Mercadoria Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
2PesoCarregadoMercadoriadecimalSimRetorna o Peso Carregado da MercadoriaN/APeso Carregado da Mercadoria
  1. Quando a Operação de Transporte conter Quitação e o usuário quiser atualizar os dados de Quitação, o usuário não poderá atualizar os seguintes dados:
    1. ValorMercadoria - Valor da Mercadoria em Nota
    2. PesoCarregadoMercadoria - Peso da Mercadoria Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
3QuantidadeCarregadaintSimRetorna a Quantidade CarregadaN/AQuantidade Carregada (Unidade)
  1. Quando a Operação de Transporte conter Quitação e o usuário quiser atualizar os dados de Quitação, o usuário não poderá atualizar os seguintes dados:
    1. ValorMercadoria - Valor da Mercadoria em Nota
    2. PesoCarregadoMercadoria - Peso da Mercadoria Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
4TipoCalculoAvariaintNãoRetorna o Tipo Cálculo AvariaN/A

Informar:

  • Por Valor = 1
  • Por Peso = 2
  • Por Unidade = 3 (Desconto na 'QuantidadeCarregada')
  • Nenhum = 4
5EncerraNaANTTbool(true || false)SimRetorna - Encerra automaticamente a Operação de Transporte na ANTT no final da Quitação?N/A
6PorcentagemToleranciaPesodecimalNãoRetorna a Porcentagem Tolerância PesoN/A

Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2.


Tolerância para a perda da carga.

7TipoToleranciaPesointSimNãoRetorna o Tipo Tolerância PesoN/A

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).

8PorcetagemPesoAMaiordecimalNãoRetorna Porcentagem Peso A MaiorN/AÀ Maior

Obs. Informar apenas quando a TAG - 'TipoCalculoAvaria' = 2.


Tolerância para aumento da carga.

9DocumentosQuitacaoList<DadosQuitacaoFreteDocumentosResponse>SimRetorna Documentos de QuitaçãoN/AObrigatório somente quando a TAG - 'TipoCalculoAvaria' for igual a 2(Por Peso)
10IdsTerminaisCarregamentoList<int>SimRetorna

Ids Terminais de Carregamento

N/A


Retorno dos Ids no método - 'BuscarTerminaisCarregamentoAutorizados'

Os Terminais autorizados deverão ser cadastrados pelo Cliente através da Plataforma Web.
11QuitaEmTodosTerminaisbool(true || false)SimRetorna Quita Em Permite Quitação em todos os TerminaisN/A?

Sim - Não será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento'

Não - Será necessário informar os Ids na TAG - 'IdsTerminaisCarregamento'


DadosQuitacaoFreteDocumentosResponse
NºCampoTipoObrigatórioDescriçãoObservação
1NomeDocumentostringNãoNome DocumentoN/ATipo do DocumentoCT-e, NF-e, DACTE e etc
2NumeroIdentificadorDocumentostringSimNúmero Identificador DocumentoN/AId 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


Método

Abaixo, segue o método - 'CadastrarAtualizarDadosQuitacaoOperacaoTransporte'.

...