DOCUMENTAÇÃO CORPORATIVA
ObterDetalhesQuitacao
Objetivo
Esse método tem como objetivo realizar a busca sobre detalhes de Quitação de uma determinada Operação de Transporte.
Observações Importantes
- 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
ObterDetalhesQuitacaoRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | IdOperacao | int | Sim | Id da Operação de Transporte | N/A |
Response
DetalhesQuitacaoResponse | |||||
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 | Id da Operação de Transporte | N/A |
3 | CIOT | string | Sim | Código do CIOT | N/A |
4 | MunicipioOrigem | string | Sim | Município de Origem | N/A |
5 | MunicipioDestino | string | Sim | Município de Destino | N/A |
6 | DataHoraInicio | Datetime (YYYY-MM-DD) | Sim | Data e Hora do Início da Viagem | N/A |
7 | DataHoraTermino | Datetime (YYYY-MM-DD) | Sim | Data e Hora do Termino da Viagem | N/A |
8 | CPFCNPJContratado | string | Sim | CPF/CNPJ Contratado - Transportador | N/A |
9 | ValorFrete | decimal | Não | Valor do Frete | N/A |
10 | NomeMotorista | string | Sim | Nome do Motorista | N/A |
11 | CPFMotorista | string | Sim | CPF do Motorista | N/A |
12 | ValorContratado | decimal | Não | Valor Contratado | N/A |
13 | StatusOperacao | string | Sim | Status da Operação de Transporte | N/A |
14 | InformacoesParcelasResponse | List<Obj> | Sim | Lista de Parcelas | N/A |
15 | DadosQuitacaoFreteResponse | Obj | Sim | Objeto Dados Quitação Frete | N/A |
16 | MensagemRetorno | string | Sim | Mensagem de Retorno | N/A |
InformacoesParcelasResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Valor | decimal | Sim | Valor da Parcela | N/A |
2 | DataVencimento | Datetime (YYYY-MM-DD) | Não | Data de Vencimento | N/A |
3 | DataPagamento | Datetime (YYYY-MM-DD) | Não | Data de Pagamento | N/A |
4 | NumeroParcela | int | Sim | Número da Parcela | N/A |
5 | DescricaoParcela | string | Sim | Descrição da Parcela | N/A |
6 | Cancelada | bool (true || false) | Sim | Cancelada | Se a parcela está cancelada ou não. |
7 | FormaPagamento | string | Sim | Forma de Pagamento | Cartão ou Depósito em Conta |
8 | StatusParcela | string | Sim | Status da Parcela | N/A |
9 | Observacao | string | Não | Observação | N/A |
DadosQuitacaoFreteResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | ValorMercadoria | decimal | Sim | Valor da Mercadoria | N/A |
2 | PesoCarregadoMercadoria | decimal | Sim | Peso Carregado da Mercadoria | N/A |
3 | QuantidadeCarregada | int | Sim | Quantidade Carregada | N/A |
4 | TipoCalculoAvaria | int | Não | Tipo Cálculo Avaria | N/A |
5 | EncerraNaANTT | bool (true || false) | Sim | Se a Operação de Transporte está encerrada da ANTT | N/A |
6 | PorcentagemToleranciaPeso | decimal | Não | Porcentagem Tolerância Peso | N/A |
7 | TipoToleranciaPeso | int | Não | Tipo Tolerância Peso | N/A |
8 | PorcetagemPesoAMaior | decimal | Não | Porcentagem Peso A Maior | N/A |
9 | DadosQuitacaoFreteDocumentosResponse | List<Obj> | Sim | Documentos da Quitação | N/A |
10 | IdsTerminaisCarregamento | List<int> | Sim | Ids Terminais de Carregamento | N/A |
11 | QuitaEmTodosTerminais | bool (true || false) | Sim | Se Operação de Transporte pode ser Quitadas em todos os terminais | N/A |
DetalhesQuitacaoResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso. |
2 | ValorFreteTabela | decimal | Sim | Valor Frete Tabela | N/A |
3 | DescricaoTipoCarga | string | Sim | Descrição Tipo Carga | N/A |
4 | Quilometragem | decimal | Sim | Quilometragem | N/A |
5 | IdDmCategoriaVeiculo | int | Sim | Id Dm Categoria | N/A |
6 | HaveraFreteDeRetorno | bool (true || false) | Sim | Caso a Operação de Transportes não necessite de CIOT. | N/A |
DadosQuitacaoFreteDocumentosResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | NomeDocumento | string | Sim | Nome do Documento | N/A |
2 | NumeroIdentificadorDocumento | string | Sim | Número Identificador do Documento | N/A |
3 | Obrigatorio | bool (true || false) | Sim | Obrigatório | N/A |
Método
Abaixo, segue método - 'CalcularValorTabelaFrete'.
CalculoValorTabelaFreteRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br"> <soapenv:Header/> <soapenv:Body> <tms:ObterDetalhesQuitacao> <tms:auth> <tms:Usuario>?</tms:Usuario> <tms:Senha>?</tms:Senha> <tms:Token>?</tms:Token> </tms:auth> <tms:detalhesQuitacao> <tms:IdOperacao>?</tms:IdOperacao> </tms:detalhesQuitacao> </tms:ObterDetalhesQuitacao> </soapenv:Body> </soapenv:Envelope>
Calcular Valor Tabela de Frete
Abaixo, segue exemplo do método - 'CalcularValorTabelaFrete'.
CalculoValorTabelaFreteRequest
Request <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header/> <soapenv:Body> <tms:ObterDetalhesQuitacao> <tms:auth> <tms:Usuario>tms.exemplo</tms:Usuario> <tms:Senha>v0hXPrwerKblaBs=</tms:Senha> <tms:Token i:nil="true" /> </tms:auth> <tms:detalhesQuitacao> <tms:IdOperacao>?</tms:IdOperacao> </tms:detalhesQuitacao> </tms:ObterDetalhesQuitacao> </soapenv:Body> </soapenv:Envelope> Response