DOCUMENTAÇÃO CORPORATIVA
BuscarDespesas
Objetivo
Este método tem como objetivo buscar as despesas do cliente.
Observações Importantes
BuscaDespesaRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | Pagina | int | Sim | Informar o número da página | Iremos retornar no máximo 25 despesas por página. |
2 | IdDespesa | int | Não | Id da Despesa | Caso o ID da Despesa seja NULL, retornaremos todas as despesas do cliente. |
3 | Status | int | Não | Status da Despesa | 0 = A Pagar 1 = Vence Hoje 2 = Vencida 3 = Cancelada 4 = Paga 5 = Todas 6 = Ativas 7 = Pendente 8 = Pagas Fora do Prazo |
BuscaDespesaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | Itens | List<DespesaResponse> | Sim | Response - Despesa | Lista de Despesas Obtidas com os Filtros utilizados |
DespesaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | IdDespesa | int | Sim | Id da Despesa | N/A |
2 | Cancelado | bool (true || false) | Sim | Indica se a Despesa foi Cancelada ou Não | N/A |
3 | DataHoraCriacao | DateTime (YYYY-MM-DD) | Sim | Data e Hora da Criação | N/A |
4 | DataHoraPagamento | DateTime (YYYY-MM-DD) | Não | Data e Hora de Pagamento | N/A |
5 | NomeFuncionario | string | Sim | Nome do Funcionário | N/A |
6 | CpfFuncionario | string | Sim | CPF do Funcionário | N/A |
7 | PlacaVeiculo | string | Não | Placa do Veículo | N/A |
8 | IdTipoDespesa | int | Sim | Id Dm Tipo Despesa | Os tipos de Despesa podem ser obtidos através do método BuscarTiposDespesas , já que vários tipos diferentes de despesas podem ser cadastrados. |
9 | IdFrotaVeiculo | int | Não | Id Frota Veículo | N/A |
10 | IdFuncionario | int | Sim | Id Funcionário | N/A |
11 | DataHoraVencimento | DateTime (YYYY-MM-DD) | Sim | Data e Hora de Vencimento | N/A |
12 | ValorPrevisto | decimal | Sim | Valor Previsto da Despesa | N/A |
13 | ProcessarAutomaticamente | bool (true || false) | Sim | Indica se será Processada Automaticamente ou não | N/A |
14 | Descricao | string | Sim | Descrição da Despesa | N/A |
15 | ItemFinanceiro | string | Sim | Item Financeiro | N/A |
16 | IdRotaAssociada | int | Não | Id da Rota Associada | N/A |
17 | NumeroCartao | string | Não | Número do cartão ao qual despesa precisa ser paga | O número de cartão da despesa é obrigatório em praticamente todos os tipos de despesa. Este somente NÃO é obrigatório em despesas de tipo TAG (SEM PARAR, por exemplo) |
Método
Abaixo, segue o método - 'BuscarDespesas'.
BuscaDespesaRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:tms="http://tmsempresa.v1.targetmp.com.br"> <soapenv:Header/> <soapenv:Body> <tem:BuscarDespesas> <tem:auth> <tms:Usuario>?</tms:Usuario> <tms:Senha>?</tms:Senha> </tem:auth> <tem:buscaDespesa> <tms:Pagina>?</tms:Pagina> <tms:IdDespesa>?</tms:IdDespesa> <tms:Status>?</tms:Status> </tem:buscaDespesa> </tem:BuscarDespesas> </soapenv:Body> </soapenv:Envelope>