DOCUMENTAÇÃO CORPORATIVA
BuscarOperacaoTranporteParcelasPorPeriodo
Objetivo
Esse método tem como objetivo, realizar a busca de uma parcela ou mais de uma determinada Operação de Transporte por Período.
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.
BuscarOperacaoTranporteParcelasPorPeriodoRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | dataInicio | Datetime (YYYY-MM-DD) | Sim | Data de início para o período de tempo a ser considerado na busca | N/A |
2 | dataFim | Datetime (YYYY-MM-DD) | Sim | Data de fim para o período de tempo a ser considerado na busca | N/A |
3 | statusParcela | int | Sim | Inteiro contendo um código de Status de Parcela. | 1= Pendente 2= Paga 3= Vencida |
BuscaOperacaoTransporteParcelasResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | CodigoErro | int | Sim | Retorna o código de Erro. | Se o participante tiver sido cadastrado com sucesso, o código será 0. |
2 | MensagemRetorno | string | Não | Mensagem indicando o tipo de retorno da função. | N/A |
3 | Sucesso | bool (true || false) | Não | Confirmação se o cadastro foi efetivado com sucesso. | N/A |
4 | Parcelas | List< OperacaoTransporteParcelaResponse> | Sim | Lista de parcelas (consulte especificação de lista de parcelas). | N/A |
OperacaoTransporteParcelaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | IdOperacaoTransporteParcela | int | Sim | Identificador de Parcela de Operação de Transporte no sistema Target Frete. | N/A |
2 | CIOTCompleto | string | Sim | CIOT completo | 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 | DataPagamento | Datetime (YYYY-MM-DD) | Sim | Data de pagamento da parcela. | N/A |
6 | NumeroParcela | int | Sim | Número da parcela. | N/A |
7 | Quantidadeparcelas | int | Sim | Quantidade de parcelas. | N/A |
8 | DataHoraRegistro | Datetime (YYYY-MM-DD) | Sim | Data e Hora do registro da parcela | N/A |
9 | DescricaoParcela | string | Sim | Descrição da parcela. | N/A |
10 | Cancelada | bool (true || false) | Sim | Indica se uma parcela foi cancelada. | N/A |
11 | FormaPagamento | int | Sim | Forma de Pagamento escolhida para a Parcela de Operação de Transporte | 1= Cartão 2= Depósito |
12 | CartaoPagamento | string | Sim | Número do Cartão para destino do pagamento da Operação de Transporte. | N/A |
13 | CodigoBanco | string | Não | Código do banco de compensação. | N/A |
14 | AgenciaDeposito | string | Não | Agência da rede bancária onde será realizado o pagamento. | N/A |
15 | ContaDeposito | string | Não | Conta da agência onde será realizado o pagamento. | N/A |
16 | DigitoContaDeposito | string | Não | Digito verificador da conta que será realizado o pagamento. | N/A |
17 | StatusParcela | int | Sim | Inteiro contendo um código de Status de Parcela. | 1= Pendente 2= Paga 3= Vencida |
18 | TipoParcelaOperacaoTransporte | int | Sim | Inteiro contendo um código de Tipo de Parcela. | 1= Adiantamento 2= Intermediaria 3= Saldo 4= Adiantamento |
19 | FlagContaPoupanca | bool (true || false) | Não | Flag que indica se é uma conta Poupança ou não | N/A |
20 | VariacaoContaPoupanca | string | Sim | Variação da Conta Poupança. | N/A |
21 | ItemFinanceiroParcela | string | Sim | Item Financeiro da Parcela. | N/A |
Método
Abaixo, segue o método - 'BuscarOperacaoTransporteParcelasPorPeriodo'.
BuscarOperacaoTransporteParcelasPorPeriodoRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:BuscarOperacaoTranporteParcelasPorPeriodo> <tem:dataInicio>?</tem:dataInicio> <tem:dataFim>?</tem:dataFim> <tem:statusParcela>?</tem:statusParcela> </tem:BuscarOperacaoTranporteParcelasPorPeriodo> </soapenv:Body> </soapenv:Envelope>