Versions Compared

Version Old Version 2 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.

...

Esse método tem como objetivo, Cadastrar ou Atualizar os Dados de Quitação em uma determinada Operação de Transporte. 


Info
titleQuitação - Observações Importantes
  1. 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).
  2. Só deve-se fazer uso desse método, quando uma Operação de Transporte estiver com o Status: Declarado.
  3. A Quitação só poderá ser realizada dentro de Operações de Transportes do Tipo Padrão.
  4. Para uma Operação de Transporte que foi declarada sem Dados de Quitação, poderá ser informado tais dados para a Operação de Transporte desejada, fazendo uso desse método.
    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)
  5. 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'.
  6. 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).
  7. 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

RequestCadastroAtualizacaoDadosQuitacaoRequest
NºCampoTipoObrigatórioDescriçãoObservação
1IdOperacaoIdOperacaoTransporteintSimId da Operação de Transporte.Retorno 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 Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
2MotivoCancelamentostringSimMotivo do cancelamento da Operação de Transporte.N/A

Response

Request
PesoCarregadoMercadoriadecimalSimPeso 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)
3QuantidadeCarregadaintSimQuantidade 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ã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 Peso

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


Tolerância para a perda da carga.

7TipoToleranciaPesointNãoTipo 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).

8PorcetagemPesoAMaiordecimalNãoPorcentagem Peso À Maior

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


Tolerância para aumento da carga.

9DocumentosQuitacaoList<DadosQuitacaoFreteDocumentosResponse>SimDocumentos de QuitaçãoObrigató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'

Os Terminais autorizados deverão ser cadastrados pelo Cliente através da Plataforma Web.
11QuitaEmTodosTerminaisbool(true || false)SimPermite 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'


DadosQuitacaoFreteDocumentosRequest
Nº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


Response

DadosQuitacaoFreteResponse
NºCampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Erro.NULO em caso de sucesso.
2IdCancelamentoOperacaoTransporteMensagemRetornointSimMensagem de RetornoN/A
3IdOperacaointSimRetorna o ID do Cancelamento Id da Operação de Transporte.Retorno do Id no Response do método - 'CadastrarAtualizarOperacaoTransporte'
4dadosQuitacaoDadosQuitacaoFreteResponseSimDados de QuitaçãoN/A
3DataCancelamentoDatetime(YYYY-MM-DD)SimRetorna a Data de Cancelamento da Operação de Transporte.N/A
4ProtocoloCancelamentostringSimRetorna o Protocolo de cancelamento da Operação de Transporte.N/A


CadastroAtualizacaoDadosQuitacaoResponse
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 Carregada
    3. QuantidadeCarregada - Quantidade Carregada (Unidade)
2PesoCarregadoMercadoriadecimalSimPeso 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)
3QuantidadeCarregadaintSimQuantidade 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ã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 Peso

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


Tolerância para a perda da carga.

7TipoToleranciaPesointNãoTipo 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).

8PorcetagemPesoAMaiordecimalNãoPorcentagem Peso À Maior

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


Tolerância para aumento da carga.

9DocumentosQuitacaoList<DadosQuitacaoFreteDocumentosResponse>SimDocumentos de QuitaçãoObrigató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'

Os Terminais autorizados deverão ser cadastrados pelo Cliente através da Plataforma Web.
11QuitaEmTodosTerminaisbool(true || false)SimPermite 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'


DadosQuitacaoFreteDocumentosResponse
Nº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


Método

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

...