DOCUMENTAÇÃO CORPORATIVA
RegistrarParcelaAdicional
- Gabriel Nisã Brandão Casaes Monteiro (Unlicensed)
- vitor.costa (Unlicensed)
- Raphael Santos (Unlicensed)
Objetivo
Esse método tem como objetivo criar uma parcela adicional para uma determinada Operação de Transporte.
Observações Importantes
- De acordo com a resolução 5862 do PEF as operações de transporte do Tipo Padrão não permitem mais retificação, portanto a adição de parcela nesse tipo de viagem não poderá ser utilizada, uma vez que a mudança nos valores do contrato obrigaria uma retificação na ANTT.
- Só poderá ser criado até 10 parcelas adicionais para cada Operação de Transporte.
- Só poderá ser criada a parcela para uma Operação de Transporte com o status - Declarada.
- Obs. Para saber se o Status da Operação de Transporte está como Declarada, fazer o uso do método - BuscarOperacaoTransporte.
- 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
| ParcelaAdicionalRequest | |||||
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|---|---|---|---|---|
| 1 | IdOperacaoTransporte | int | Sim | Id Operação Transporte. | N/A |
| 2 | NumeroCartao | string | Sim | Número do cartão para pagamento. | Quando pagamento via cartão |
| 3 | Valor | decimal | Sim | Valor da parcela. | N/A |
| 4 | DataVencimento | Datetime(YYYY-MM-DD) | Sim | Data de vencimento da parcela. | Exemplo: (2018-08-20T10:05:33) |
| 5 | Descricao | string | Sim | Descrição da Parcela. | N/A |
| 6 | Automatica | bool(true || false) | Sim | Indica se a parcela em questão será processada automaticamente na data de vencimento informada ou será paga manualmente no Sistema TARGET Frete. | N/A |
| 7 | ChavePix | string | Sim | Informar a chave Pix conforme a seleção do tipo no parâmetro “TipoChavePix" | N/A |
| 8 | TipoChavePIX | string | sim | Tag que direciona a forma de identificação que será realizado o pagamento PIX, conforme tipos disponíveis na observação. | 1- CPF/CNPJ 2 -Email 3 - Celular 4 - Aleatória 5 - Manual (dados bancários da conta) |
| 9 | CPFCNPJBeneficiarioContaDestino | string | Sim | CPF ou CNPJ do titular da conta que possui a chave PIX | N/A |
| 10 | CodigoBanco | string | Não | Código do banco do titular da conta que possui a chave PIX somente para "TipoChavePix Manual =5” | Somente para "TipoChavePix=5" |
| 11 | NumeroConta | string | Não | Número da conta do titular da conta que possui a chave PIX, somente para "TipoChavePix Manual =5” | Somente para "TipoChavePix=5" |
| 12 | DigitoConta | string | Não | Digito da conta do titular da conta que possui a chave PIX, somente para "TipoChavePix Manual =5” | Somente para "TipoChavePix=5" |
| 13 | NumeroAgencia | string | Não | Número da agência do titular da conta que possui a chave PIX, somente para "TipoChavePix Manual =5” | Somente para "TipoChavePix=5" |
| 14 | TipoContaDestinoFinanceiro | string | Não | Somente para "TipoChavePix=5" | 1 - conta corrente 2 - conta pagamento 3 - conta poupança |
| 15 | NomeBeneficiarioContaDestino | string | Sim | Nome do titular da conta que possui a chave PIX | N/A |
Response
| ParcelaAdicionalResponse | |||||
| Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
|---|---|---|---|---|---|
| 1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso. |
| 2 | Mensagem | string | Não | Retorna mensagem de validação. | N/A |
| 3 | IdOperacaoTransporteParcela | int | Sim | Retorna o Identificador de Parcela de Operação de Transporte no Sistema TARGET Frete. | N/A |
Método
Abaixo, segue o método - 'RegistrarParcelaAdicional'.
ParcelaAdicionalRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
<soapenv:Header/>
<soapenv:Body>
<tms:RegistrarParcelaAdicional>
<tms:auth>
<tms:Usuario>?</tms:Usuario>
<tms:Senha>?</tms:Senha>
<tms:Token>?</tms:Token>
</tms:auth>
<tms:parcelaAdicionalRequest>
<tms:IdOperacaoTransporte>?</tms:IdOperacaoTransporte>
<tms:NumeroCartao>?</tms:NumeroCartao>
<tms:Valor>?</tms:Valor>
<tms:DataVencimento>?</tms:DataVencimento>
<tms:Descricao>?</tms:Descricao>
<tms:Automatica>?</tms:Automatica>
</tms:parcelaAdicionalRequest>
</tms:RegistrarParcelaAdicional>
</soapenv:Body>
</soapenv:Envelope>
Registrar Parcela Adicional
Abaixo, segue exemplo do método - 'RegistrarParcelaAdicional'.
Exemplo - ParcelaAdicionalRequest
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:RegistrarParcelaAdicional>
<tms:auth>
<tms:Usuario>tms.exemplo</tms:Usuario>
<tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
<tms:Token i:nil="true" />
</tms:auth>
<tms:parcelaAdicionalRequest>
<tms:IdOperacaoTransporte>2959</tms:IdOperacaoTransporte>
<tms:NumeroCartao>4417810199011017</tms:NumeroCartao>
<tms:Valor>50</tms:Valor>
<tms:DataVencimento>2018-09-01</tms:DataVencimento>
<tms:Descricao>Parcela Complemento</tms:Descricao>
<tms:Automatica>true</tms:Automatica>
</tms:parcelaAdicionalRequest>
</tms:RegistrarParcelaAdicional>
</soapenv:Body>
</soapenv:Envelope>
Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<RegistrarParcelaAdicionalResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
<RegistrarParcelaAdicionalResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Erro i:nil="true"/>
<Mensagem>Parcela registrada com sucesso!</Mensagem>
<IdOperacaoTransporteParcela>8013</IdOperacaoTransporteParcela>
</RegistrarParcelaAdicionalResult>
</RegistrarParcelaAdicionalResponse>
</s:Body>
</s:Envelope>