DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Objetivo

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


Quitaçã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

CadastroAtualizacaoDadosQuitacaoRequest
CampoTipoObrigatórioDescriçãoObservação
1IdOperacaoTransporteintSimId da Operação de Transporte.N/A
2DadosQuitacaoDadosQuitacaoFreteRequestSimDados de QuitaçãoN/A
DadosQuitacaoFreteRequest
CampoTipoObrigatórioDescriçãoObservação
1ValorMercadoriadecimalSimValor da MercadoriaN/A
2PesoCarregadoMercadoriadecimalSimPeso Carregado da MercadoriaN/A
3QuantidadeCarregadaintSimQuantidade CarregadaN/A
4TipoCalculoAvariaintNãoTipo Cálculo Avaria

Por Valor = 1

Por Peso = 2

Por Unidade = 3

Nenhum = 4

5EncerraNaANTTbool(true || false)SimEncerra na ANTTN/A
6PorcentagemToleranciaPesodecimalNãoPorcentagem Tolerância PesoN/A
7TipoToleranciaPesointSimTipo Tolerância Peso

Integral = 1

Excedente = 2

Nenhum = 3

8PorcetagemPesoAMaiordecimalNãoPorcentagem Peso A MaiorN/A
9DocumentosQuitacaoList<DadosQuitacaoFreteDocumentosResponse>SimDocumentos de QuitaçãoN/A
10IdsTerminaisCarregamentoList<int>Sim

Ids Terminais de Carregamento


Retorno dos Ids no método - 'BuscarTerminaisCarregamentoAutorizados'

N/A
11QuitaEmTodosTerminaisbool(true || false)SimQuita Em todos os TerminaisN/A
DadosQuitacaoFreteDocumentosRequest
CampoTipoObrigatórioDescriçãoObservação
1NomeDocumentostringNãoNome DocumentoN/A
2NumeroIdentificadorDocumentostringSimNúmero Identificador DocumentoN/A
3Obrigatoriobool(true || false)SimObrigatórioN/A
4DocumentoGeradoDestinobool(true || false)NãoDocumento Gerado DestinoN/A

Response

DadosQuitacaoFreteResponse
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/A
4dadosQuitacaoDadosQuitacaoFreteResponseSimDados de QuitaçãoN/A
CadastroAtualizacaoDadosQuitacaoResponse
CampoTipoObrigatórioDescriçãoObservação
1ValorMercadoriadecimalSimRetorna o Valor da MercadoriaN/A
2PesoCarregadoMercadoriadecimalSimRetorna o Peso Carregado da MercadoriaN/A
3QuantidadeCarregadaintSimRetorna a Quantidade CarregadaN/A
4TipoCalculoAvariaintNãoRetorna o Tipo Cálculo AvariaN/A
5EncerraNaANTTbool(true || false)SimRetorna - Encerra na ANTTN/A
6PorcentagemToleranciaPesodecimalNãoRetorna a Porcentagem Tolerância PesoN/A
7TipoToleranciaPesointSimRetorna o Tipo Tolerância PesoN/A
8PorcetagemPesoAMaiordecimalNãoRetorna Porcentagem Peso A MaiorN/A
9DocumentosQuitacaoList<DadosQuitacaoFreteDocumentosResponse>SimRetorna Documentos de QuitaçãoN/A
10IdsTerminaisCarregamentoList<int>SimRetorna Ids Terminais de CarregamentoN/A
11QuitaEmTodosTerminaisbool(true || false)SimRetorna Quita Em todos os TerminaisN/A
DadosQuitacaoFreteDocumentosResponse
CampoTipoObrigatórioDescriçãoObservação
1NomeDocumentostringNãoNome DocumentoN/A
2NumeroIdentificadorDocumentostringSimNúmero Identificador DocumentoN/A
3Obrigatoriobool(true || false)SimObrigatórioN/A

Método

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

CadastrarAtualizarDadosQuitacaoOperacaoTransporte
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:CadastrarAtualizarDadosQuitacaoOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:dadosQuitacaoRequest>
            <tms:IdOperacaoTransporte>?</tms:IdOperacaoTransporte>
            <tms:DadosQuitacao>
               <tms:ValorMercadoria>?</tms:ValorMercadoria>
               <tms:PesoCarregadoMercadoria>?</tms:PesoCarregadoMercadoria>
               <tms:QuantidadeCarregada>?</tms:QuantidadeCarregada>
               <tms:TipoCalculoAvaria>?</tms:TipoCalculoAvaria>
               <tms:EncerraNaANTT>?</tms:EncerraNaANTT>
               <tms:PorcentagemToleranciaPeso>?</tms:PorcentagemToleranciaPeso>
               <tms:TipoToleranciaPeso>?</tms:TipoToleranciaPeso>
               <tms:PorcetagemPesoAMaior>?</tms:PorcetagemPesoAMaior>
               <tms:DocumentosQuitacao>
                  <tms:DadosQuitacaoFreteDocumentosRequest>
                     <tms:NomeDocumento>?</tms:NomeDocumento>
                     <tms:NumeroIdentificadorDocumento>?</tms:NumeroIdentificadorDocumento>
                     <tms:Obrigatorio>?</tms:Obrigatorio>
                     <tms:DocumentoGeradoDestino>?</tms:DocumentoGeradoDestino>
                  </tms:DadosQuitacaoFreteDocumentosRequest>
               </tms:DocumentosQuitacao>
               <tms:IdsTerminaisCarregamento>
                  <arr:int>?</arr:int>
               </tms:IdsTerminaisCarregamento>
               <tms:QuitaEmTodosTerminais>?</tms:QuitaEmTodosTerminais>
            </tms:DadosQuitacao>
         </tms:dadosQuitacaoRequest>
      </tms:CadastrarAtualizarDadosQuitacaoOperacaoTransporte>
   </soapenv:Body>
</soapenv:Envelope>
  • No labels