Versions Compared

Key

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

Objetivo

Este método tem como objetivo realizar buscas de pacotes de despesas.

...

Info
titleObservações Importantes



BuscaPacoteDespesaRequest
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
IdCronograma
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
Pacotes de
despesas
Despesas do cliente.


BuscaPacoteDespesaResponse
CampoTipoObrigatórioDescriçãoObservação
1ItensList<
PacoteDespesaResponse>
SimResponse - Pacote DespesaN/A


PacoteDespesaResponse
CampoTipoObrigatórioDescriçãoObservação
1
IdPacoteDespesa
IdCronogramaDespesaintNãoId Cronograma Despesa (Id do Pacote de Despesa)N/A
2DataHoraCadastroDateTime (YYYY-MM-DD)SimData e Hora do CadastroN/A
3DataHoraInicioDateTime (YYYY-MM-DD)SimData e Hora InícioN/A
4DataHoraFimDateTime (YYYY-MM-DD)SimData e Hora FimN/A
5ItensDespesaList<
ItemDespesaResponse>
SimResponse -
Pacote
Itens de Despesa
N/A
Lista Contendo as Despesas do Pacote
6ValorTotaldecimalSimValor do Pacote de DespesasSoma total dos valores previstos das
despesas
Despesas do
pacote
Pacote.
7IdCentroDeCustointNãoId Centro de CustoN/A
8
Descricao
NomePacoteDespesastringSim
Descrição
Nome / Título do Pacote de DespesasTítulo/Nome
9DescricaoDetalhadastringSimDescrição Detalhada do PacoteN/A


ItemDespesaResponse
CampoTipoObrigatórioDescriçãoObservação
1IdDespesaintSimId da DespesaN/A
2Canceladobool (true || false)Sim
Cancelado
Indica se a Despesa está Cancelada ou NãoN/A
3DataHoraCriacaoDateTime (YYYY-MM-DD)SimData e Hora Criação da DespesaN/A
4DataHoraPagamentoDateTime (YYYY-MM-DD)NãoData e Hora Pagamento da DespesaN/A
5
IdDmTipoDespesa
IdTipoDespesaintSimId Dm Tipo Despesa
N/A
Os tipos de Despesa podem ser obtidos através do método BuscarTiposDespesas , já que vários tipos diferentes de despesas podem ser cadastrados.
6IdFrotaVeiculointNãoId Frota VeículoN/A
7IdFuncionariointSimId FuncionárioN/A
8DataHoraVencimentoDateTime (YYYY-MM-DD)SimData e Hora Vencimento da DespesaN/A
9ValorPrevistodecimalSimValor Previsto da DespesaN/A
10ProcessarAutomaticamentebool (true || false)SimProcessar AutomaticamenteN/A
11DescricaostringSimDescrição da DespesaTítulo/Nome
12
ItemFinanceiro
NumeroDocumentostringSimNumero Documento (Item Financeiro)N/A
13IdRotaAssociadaintNãoDescrição DetalhadaN/A
14NumeroCartaostringNãoNúmero do cartão ao qual despesa precisa ser pagaO 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'.

Code Block
languagexml
themeRDark
firstline1
titleBuscaPacoteDespesaRequest
linenumberstrue
<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>