...
BuscaTransacoesFinanceirasRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | QuantidadeItensPorPagina | int | Sim | Quantidade de itens a serem trazidos em uma página. | N/A |
2 | NumeroPagina | int | Sim | Número da página especificada de retorno. | N/A |
3 | TipoTransacaoFinanceira | int | Sim | Especifique aqui em qual tabela iremos buscar o resultado. Caso seja utilziado a opção 7, TipoBuscaUnitaria e IdEntidadeTransacaoFinanceira não são obrigatórios. | 1= OperacaoTransporteParcelas 2= ParcelaUnitaria 3= PagamentoAvulso 4= CombustivelAvulso 5= CompraValePedagio 6= CompraPedagioTAG 7= Todos |
4 | TipoBuscaUnitaria | int | Não | Especifique aqui o tipo da busca desejada e preencha o campo. | 1= PorIdEntidade 2= PorIdIntegrador 3= PorDocumentoRelacionado |
5 | IdEntidadeTransacaoFinanceira | int | Sim | ID de Entidade da Transacao. | N/A |
6 | DataInicioPeriodo | DateTime(YYYY-MM-DD) | Sim | Período de início de busca das transções. | N/A |
7 | DataFimPeriodo | DateTime(YYYY-MM-DD) | Sim | Período final de busca das transções. | N/A |
8 | IdIntegrador | string | Não | ID Integrador único da compra. | N/A |
9 | DocumentoRelacionado | string | Não | Documento único relacionado à compra | N/A |
10 | Pago | bool (true || false) | Sim | Está pago ou não. | Quando Pago igual a true, a busca é feita pela data de pagamento e não através da data de registro. |
Response
BuscaTransacoesFinanceirasResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de Sucesso |
2 | TipoTransacaoFinanceira | string | Sim | Retorna o Tipo da Transação Financeira. | N/A |
3 | IdEntidadeTransacaoFinanceira | int | Não | Retorna o Id de Entidade da Transação Financeira. | N/A |
4 | IdOperacaoTransporteRelacionada | int | Sim | Retorna o Id da Operação de CIOT, caso exista. | N/A |
5 | Valor | decimal | Sim | Valor da Operação | N/A |
6 | Situacao | string | Sim | Status da Operação no momento da busca. | N/A |
7 | ModoPagamento | string | Sim | Modo de pagamento para essa transação: Cartão, TAG e Depósito. | N/A |
8 | Comentario | string | Não | Comentário registrado na transação caso exista. | N/A |
9 | DataRegistro | DateTime(YYYY-MM-DD) | Não | Data em que a transação foi registrada. | N/A |
10 | DataPagamento | DateTime(YYYY-MM-DD) | Não | Data em que a transação foi paga. | N/A |
ResultadoPaginadoResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
2 | Itens | N/A | N/A | Itens | N/A |
3 | NumeroPagina | int | Sim | Número da Página | N/A |
4 | QuantidadeItensPorPagina | int | Sim | Quantidade de Itens por Página | N/A |
5 | QuantidadeTotalItens | int | Sim | Quantidade Total de Itens | N/A |
6 | QuantidadeTotalPaginas | int | Sim | Quantidade Total de Páginas | N/A |
...