DOCUMENTAÇÃO CORPORATIVA
BuscarPacotesDespesa
Objetivo
Este método tem como objetivo realizar buscas de pacotes de despesas.
Observações Importantes
BuscaPacoteDespesaRequest | |||||
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 pacotes de despesas. |
2 | IdCronogramaDespesa | int | Não | Id Cronograma Despesa (Id do Pacote de Despesa) | Caso Id Cronograma/Id do Pacote de despesa for NULL, retornaremos todos os Pacotes de Despesas do cliente. |
BuscaPacoteDespesaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | Itens | List< PacoteDespesaResponse> | Sim | Response - Pacote Despesa | N/A |
PacoteDespesaResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
1 | IdCronogramaDespesa | int | Não | Id Cronograma Despesa (Id do Pacote de Despesa) | N/A |
2 | DataHoraCadastro | DateTime (YYYY-MM-DD) | Sim | Data e Hora do Cadastro | N/A |
3 | DataHoraInicio | DateTime (YYYY-MM-DD) | Sim | Data e Hora Início | N/A |
4 | DataHoraFim | DateTime (YYYY-MM-DD) | Sim | Data e Hora Fim | N/A |
5 | ItensDespesa | List< ItemDespesaResponse> | Sim | Response - Itens de Despesa | Lista Contendo as Despesas do Pacote |
6 | ValorTotal | decimal | Sim | Valor do Pacote de Despesas | Soma total dos valores previstos das Despesas do Pacote. |
7 | IdCentroDeCusto | int | Não | Id Centro de Custo | N/A |
8 | NomePacoteDespesa | string | Sim | Nome / Título do Pacote de Despesas | Título/Nome |
9 | DescricaoDetalhada | string | Sim | Descrição Detalhada do Pacote | N/A |
ItemDespesaResponse | |||||
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 está Cancelada ou Não | N/A |
3 | DataHoraCriacao | DateTime (YYYY-MM-DD) | Sim | Data e Hora Criação da Despesa | N/A |
4 | DataHoraPagamento | DateTime (YYYY-MM-DD) | Não | Data e Hora Pagamento da Despesa | N/A |
5 | 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. |
6 | IdFrotaVeiculo | int | Não | Id Frota Veículo | N/A |
7 | IdFuncionario | int | Sim | Id Funcionário | N/A |
8 | DataHoraVencimento | DateTime (YYYY-MM-DD) | Sim | Data e Hora Vencimento da Despesa | N/A |
9 | ValorPrevisto | decimal | Sim | Valor Previsto da Despesa | N/A |
10 | ProcessarAutomaticamente | bool (true || false) | Sim | Processar Automaticamente | N/A |
11 | Descricao | string | Sim | Descrição da Despesa | Título/Nome |
12 | NumeroDocumento | string | Sim | Numero Documento (Item Financeiro) | N/A |
13 | IdRotaAssociada | int | Não | Descrição Detalhada | N/A |
14 | 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 - 'BuscarPacotesDespesa'.
BuscaPacoteDespesaRequest
<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:BuscarPacotesDespesa> <tem:auth> <tms:Usuario>?</tms:Usuario> <tms:Senha>?</tms:Senha> </tem:auth> <tem:buscaPacotes> <tms:Pagina>?</tms:Pagina> <tms:IdCronogramaDespesa>?</tms:IdCronogramaDespesa> </tem:buscaPacotes> </tem:BuscarPacotesDespesa> </soapenv:Body> </soapenv:Envelope>