Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Esse método tem como objetivo, realizar a busca de uma parcela ou mais de uma determinada Operação de Transporte Transporte por Período.


Info
titleObservações Importantes
  1. 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.



BuscarOperacaoTranporteParcelasPorPeriodoRequest

CampoTipoObrigatórioDescriçãoObservação
1dataInicioDatetime (YYYY-MM-DD)SimData de início para o período de tempo a ser considerado na buscaN/A
2dataFimDatetime (YYYY-MM-DD)SimData de fim para o período de tempo a ser considerado na buscaN/A
3statusParcelaintSimInteiro contendo um código de Status de Parcela.1= Pendente
2= Paga
3= Vencida

BuscaOperacaoTransporteParcelasResponse

CampoTipoObrigatórioDescriçãoObservação
1CodigoErrointSimRetorna o código de Erro.Se o participante tiver sido cadastrado com sucesso, o código será 0.
2MensagemRetornostringNãoMensagem indicando o tipo de retorno da função.N/A
3Sucessobool (true || false)NãoConfirmação se o cadastro foi efetivado com sucesso.N/A
4ParcelasList<
OperacaoTransporteParcelaResponse>
SimLista de parcelas (consulte especificação de lista de parcelas).N/A

OperacaoTransporteParcelaResponse

CampoTipoObrigatórioDescriçãoObservação
1IdOperacaoTransporteParcelaintSimIdentificador de Parcela de Operação de Transporte no sistema Target Frete.N/A
2CIOTCompletostringSimCIOT completoN/A
3ValordecimalSimValor da parcela.N/A
4DataVencimentoDatetime (YYYY-MM-DD)SimData de vencimento da parcela.N/A
5DataPagamentoDatetime (YYYY-MM-DD)SimData de pagamento da parcela.N/A
6NumeroParcelaintSimNúmero da parcela.N/A
7QuantidadeparcelasintSimQuantidade de parcelas.N/A
8DataHoraRegistroDatetime (YYYY-MM-DD)SimData e Hora do registro da parcelaN/A
9DescricaoParcelastringSimDescrição da parcela.N/A
10Canceladabool (true || false)SimIndica se uma parcela foi cancelada.N/A
11FormaPagamentointSimForma de Pagamento escolhida para a Parcela de Operação de Transporte1= Cartão
2= Depósito
12CartaoPagamentostringSimNúmero do Cartão para destino do pagamento da Operação de Transporte.N/A
13CodigoBancostringNãoCódigo do banco de compensação.N/A
14AgenciaDepositostringNãoAgência da rede bancária onde será realizado o pagamento.N/A
15ContaDepositostringNãoConta da agência onde será realizado o pagamento.N/A
16DigitoContaDepositostringNãoDigito verificador da conta que será realizado o pagamento.N/A
17StatusParcelaintSimInteiro contendo um código de Status de Parcela.1= Pendente
2= Paga
3= Vencida
18TipoParcelaOperacaoTransporteintSimInteiro contendo um código de Tipo de Parcela.1= Adiantamento
2= Intermediaria
3= Saldo
4= Adiantamento
19FlagContaPoupancabool (true || false)NãoFlag que indica se é uma conta Poupança ou nãoN/A
20VariacaoContaPoupancastringSimVariação da Conta Poupança.N/A
21ItemFinanceiroParcelastringSimItem Financeiro da Parcela.N/A



Método

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

...