Objetivo
Esse método tem como objetivo criar uma parcela adicional para uma determinada Operação de Transporte.
Observações Importantes
- Só poderá ser criado até 4 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.
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. | N/A |
| 3 | Valor | decimal | Sim | Valor da parcela. | N/A |
| 4 | DataVencimento | Datetime(YYYY-MM-DD) | Sim | Data de vencimento da parcela. | N/A |
| 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 |
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>