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

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).
Só deve-se fazer uso desse método, quando uma Operação de Transporte estiver com o Status: Declarado.
A Quitação só poderá ser realizada dentro de Operações de Transportes do Tipo Padrão.
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)
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

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
CadastroAtualizacaoDadosQuitacaoRequest
1	IdOperacaoTransporte	int	Sim	Id da Operação de Transporte.	Retorno do Id no Response do método - 'CadastrarAtualizarOperacaoTransporte'
2	DadosQuitacao	DadosQuitacaoFreteRequest	Sim	Dados de Quitação	N/A

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosQuitacaoFreteRequest
1	ValorMercadoria	decimal	Sim	Valor Total da Mercadoria em Nota	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: ValorMercadoria - Valor da Mercadoria em Nota PesoCarregadoMercadoria - Peso da Mercadoria Carregada QuantidadeCarregada - Quantidade Carregada (Unidade)
2	PesoCarregadoMercadoria	decimal	Sim	Peso Carregado da Mercadoria	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: ValorMercadoria - Valor da Mercadoria em Nota PesoCarregadoMercadoria - Peso da Mercadoria Carregada QuantidadeCarregada - Quantidade Carregada (Unidade)
3	QuantidadeCarregada	int	Sim	Quantidade Carregada (Unidade)	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: ValorMercadoria - Valor da Mercadoria em Nota PesoCarregadoMercadoria - Peso da Mercadoria Carregada QuantidadeCarregada - Quantidade Carregada (Unidade)
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' = 2. 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 2(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

Response

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosQuitacaoFreteResponse
1	Erro	ErroResponse - string	Não	Retorna o Erro.	NULO em caso de sucesso.
2	MensagemRetorno	int	Sim	Mensagem de Retorno	N/A
3	IdOperacao	int	Sim	Retorna o Id da Operação de Transporte	Retorno do Id no Response do método - 'CadastrarAtualizarOperacaoTransporte'
4	dadosQuitacao	DadosQuitacaoFreteResponse	Sim	Dados de Quitação	N/A

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
CadastroAtualizacaoDadosQuitacaoResponse
1	ValorMercadoria	decimal	Sim	Valor Total da Mercadoria em Nota	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: ValorMercadoria - Valor da Mercadoria em Nota PesoCarregadoMercadoria - Peso da Mercadoria Carregada QuantidadeCarregada - Quantidade Carregada (Unidade)
2	PesoCarregadoMercadoria	decimal	Sim	Peso Carregado da Mercadoria	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: ValorMercadoria - Valor da Mercadoria em Nota PesoCarregadoMercadoria - Peso da Mercadoria Carregada QuantidadeCarregada - Quantidade Carregada (Unidade)
3	QuantidadeCarregada	int	Sim	Quantidade Carregada (Unidade)	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: ValorMercadoria - Valor da Mercadoria em Nota PesoCarregadoMercadoria - Peso da Mercadoria Carregada QuantidadeCarregada - Quantidade Carregada (Unidade)
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' = 2. 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 2(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
DadosQuitacaoFreteDocumentosResponse
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

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>

Documentação WS 2.0 - Target Frete (Terceiros)

CadastrarAtualizarDadosQuitacaoOperacaoTransporte

Objetivo

Request

Response

Método

Related pages