Ferramentas do usuário

Ferramentas do site


webservices:manual-wsquantitativo

Tabela de conteúdos

Web Service Quantitativo do SIOP (WSQuantitativo)

Informações Gerais

Serviço

Nome: Web Service Quantitativo do SIOP
Nome na interface: WSQuantitativo
Início da operação: 29/02/2012
Endereço do WSDL - Testes https://testews.siop.gov.br/services/WSQuantitativo?wsdl
Endereço do WSDL - Produção https://webservice.siop.gov.br/services/WSQuantitativo?wsdl

Objetivo

Fornecer uma interface que possibilite a interoperabilidade entre os IntraSigs e o SIOP para a transmissão de dados referentes à proposta quantitativa das Unidades Orçamentárias e Órgãos Setoriais.

Inclui operações para consulta e cadastro. Inclui também operações para tratar Acompanhamento Orçamentário e Execução Financeira do SIAFI.

Operações

Cadastrar Acompanhamento Orçamentário

Operação para cadastro e alteração do acompanhamento orçamentário (execução física) de uma ação e seus localizadores.

Nome da operação na interface do serviço: cadastrarAcompanhamentoOrcamentario

Parâmetro(s) de entrada:

ParâmetroTipo(tamanho)Observações
credencialCredencialDTO
acompanhamentoAcaoAcompanhamentoOrcamentarioAcaoDTO

Tipo de Retorno: RetornoAcompanhamentoOrcamentarioDTO

Exemplo: Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <ser:cadastrarAcompanhamentoOrcamentario>
       <credencial>
          <perfil>[PERFIL]</perfil>
          <senha>[HASH MD5 DA SENHA]</senha>
          <usuario>[LOGIN]</usuario>
       </credencial>
       <acompanhamentoAcao>
          <periodoOrdem>2</periodoOrdem>
          <exercicio>2013</exercicio>
          <codigoMomento>2000</codigoMomento>
          <!-- identificação da ação -->
          <esfera>10</esfera>
          <unidadeOrcamentaria>32263</unidadeOrcamentaria>
          <funcao>22</funcao>
          663
          <programa>2041</programa>
          <acao>20TZ</acao>
          <codigoTipoInclusaoAcao>1</codigoTipoInclusaoAcao>
          <acompanhamentosLocalizadores>
             <!-- para cada localizador a ser acompanhamado -->
             <acompanhamentoLocalizador>
                <!-- identificação do localizador -->
                <localizador>0001</localizador>
                <codigoTipoInclusaoLocalizador>1</codigoTipoInclusaoLocalizador>
                <!-- acompanhamento do localizador -->
                <!-- Campos Reprogramado e Limite devem ser informados somente
                na captação JAN-JUN (periodoOrdem = 1) -->
                <reprogramado>0</reprogramado>
                <realizadoLOA>0</realizadoLOA>
                <dataApuracaoLOA>2013-12-01</dataApuracaoLOA>
                <limite>118074</limite>
                <realizadoRAP>0</realizadoRAP>
                <dataApuracaoRAP>2013-12-01</dataApuracaoRAP>
                <analisesLocalizador>
                   <!-- para cada análise (pelo menos uma) -->
                   <analiseLocalizador>
                      <analise>TEXTO ANÁLISE LOCALIZADOR</analise>
                   </analiseLocalizador>
                </analisesLocalizador>
                <!-- localizadores nacionais (região = nacional) de ações
                marcadas com snRegionalizarNaExecucao devem ter informações
                sobre regionalização -->
                 <informacoesRegionalizacao>
                     <!-- Para cada recorte de regionalização (pelo menos 1)-->
                     <informacaoRegionalizacao>
                        <!-- Deve ser informado Regiao/UF/Município ou Recorte Geográfico -->
                        <!-- Código da Região, conforme WS Qualitativo obterTabelasApoio -->
                        <codigoRegiao>1</codigoRegiao>
                        <!-- Sigla da UF -->
                        <uf>DF</uf>
                        <!-- Código IBGE com 7 dígitos -->
                        <municipio>5300108</municipio>
                        <!-- Código do Recorte Geográfico, conforme WS Qualitativo obterTabelasApoio​​​​​​​ -->
                        <recorteGeograficoId>5</recorteGeograficoId>
                        <!-- Valor Liquidado para regionalização da Execução (Inteiro) -->
                        <liquidado>0</liquidado>
                        <!-- Meta realizada para regionalização da Execução (Inteiro) -->
                        <realizado>0</realizado>
                        <comentario>Comentário Regionalização da Execução</comentario>
                     </informacaoRegionalizacao>
                  </informacoesRegionalizacao>
                <acompanhamentosPlanoOrcamentario>
                   <!-- para cada PO a ser acompanhado -->
                   <acompanhamentoPlanoOrcamentario>
                      <!-- código do PO -->
                      <planoOrcamentario>0002</planoOrcamentario>
                      <!--acompanhamento do PO -->
                      <realizadoLOA>0</realizadoLOA>
                      <dataApuracaoLOA>2013-12-31</dataApuracaoLOA>
                      <analisesPlanoOrcamentario>
                             <!-- para cada análise do PO -->
                         <analisePlanoOrcamentario>
                            <analise>TEXTO DA ANALISE DO PO</analise>
                         </analisePlanoOrcamentario>
                      </analisesPlanoOrcamentario>
                   </acompanhamentoPlanoOrcamentario>
                </acompanhamentosPlanoOrcamentario>
             </acompanhamentoLocalizador>
          </acompanhamentosLocalizadores>
       </acompanhamentoAcao>
    </ser:cadastrarAcompanhamentoOrcamentario>
 </soapenv:Body>
</soapenv:Envelope>

Resposta:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
 <env:Header/>
 <env:Body>
    <ns2:cadastrarAcompanhamentoOrcamentarioResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
     <!-- alertas não impedem a tramitação do acompanhamento -->
          <alertas>
             <alerta>ALERTA 1: Localizador: 0001 - Nacional - Há execução financeira (LOA), mas a captação física é zero.</alerta>
             <alerta>ALERTA 2: Localizador: 0001 - Nacional - Reprogramado menor que o empenhado.</alerta>
             <alerta>ALERTA 3: Localizador: 0001 - Nacional - O valor do realizado físico de JAN-DEZ está menor do que o de JAN-JUN.</alerta>
          </alertas>
     <!-- acompanhamento não possui pendências -->
       </return>
    </ns2:cadastrarAcompanhamentoOrcamentarioResponse>
 </env:Body>
</env:Envelope>


Cadastrar Proposta

Operação para cadastro e alteração de uma proposta orçamentária. No contexto deste serviço, entende-se como proposta a programação orçamentária para um determinado localizador e tipo de detalhamento, e não a proposta completa para uma UO ou OS.

O parâmetro proposta, do tipo PropostaDTO, deve ter preenchido os campos que indicam o exercício, momento, tipo de detalhamento e os que identificam a funcional-programática do localizador, além da lista de FinanceiroDTO que forma o detalhamento financeiro da programação. A partir do PLOA de 2014 é possível informar as necessidades de expansão das metas físicas (em PropostaDTO e MetaPlanoOrcamentarioDTO) e das dotações (em FinanceiroDTO).

A lista de ReceitaDTO é utilizada somente nas propostas de ações da esfera de investimentos.

Com a inclusão do plano orçamentário (PO) à LOA de 2013, as propostas de ações que possuam PO precisam ter obrigatoriamente cada um de seus elementos de FinanceiroDTO associados a um dos PO da ação.

A lista de MetaPlanoOrcamentarioDTO (atributo metaPlanoOrcamentario) deve ser preenchida com as metas físicas e solicitações de expansão de cada PO que possua produto e tenha sido detalhado na proposta.

Nome da operação na interface do serviço: cadastrarProposta

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
proposta PropostaDTO

Tipo de Retorno: RetornoPropostasDTO

Consultar Acompanhamento Físico e Financeiro

Esta operação tem como objetivo fornecer informações de execução física e financeira com base no exercício, período de captação física, código do momento da captação física e tipo de captação informados, que pode ser apresentada por localizador, plano orçamentário ou ambos. Os resultados são retornados em uma estrutura do tipo RetornoAcompanhamentoFisicoFinanceiroDTO, que contém uma lista de registros do tipo AcompanhamentoFisicoFinanceiroDTO, um objeto do tipo PaginacaoDTO e um campo de data chamado “dataHoraUltimaCargaSiafi”, que armazena a última atualização dos registros financeiros retornados na consulta.

Por questões de desempenho, a operação tem como um de seus parâmetros uma estrutura do tipo PaginacaoDTO, que é utilizada para que o cliente informe o número da página desejada através do atributo pagina. Quando não informado, o serviço assume o valor 0 (zero), corresponde à primeira página. No retorno desta operação são informados o número da página e o número máximo de registros por página – atributos pagina e registrosPorPagina de PaginacaoDTO. Para obter o resultado completo da consulta o cliente deve realizar sucessivas requisições, incrementando o atributo pagina até que a operação retorne uma quantidade de registros inferior a registrosPorPagina.

Nome da operação na interface do serviço: consultarAcompanhamentoFisicoFinanceiro

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO Informações de acesso ao sistema (login, senha e perfil).
exercicio Integer Exercício da captação física
período Integer (1) 1 para o primeiro período da captação física, 2 para o segundo.
momentoId Integer (4) Momento da captação física
tipoCaptacao char (1) 'L' para captação por localizadores, 'P' para captação por planos orçamentários
paginacao PaginacaoDTO Caso necessário, informe o número da página para obter as páginas subsequentes da consulta.

Tipo de Retorno: RetornoAcompanhamentoFisicoFinanceiroDTO

Consultar Acompanhamento Orçamentário

Operação para obtenção do acompanhamento orçamentário das ações, e todos os seus respectivos localizadores, das unidades orçamentárias vinculadas à credencial e que se enquadrem no filtro (funcional-programática) informado.

Observações:

  • Esta operação ignora os atributos codigoLocalizador e codigoTipoInclusaoLocalizador do filtro e retorna sempre o acompanhamento de todos os localizadores de cada ação encontrada.
  • O atributo codigoTipoInclusaoAcao (origem da ação) do filtro faz parte da chave da ação. Para garantir que a operação retorne o acompanhamento de uma única ação é necessário informar a funcional completa da ação (esfera, unidade orçamentária, função, sub-função, programa, ação) e a sua origem (codigoTipoInclusaoAcao).

Nome da operação na interface do serviço: consultarAcompanhamentoOrcamentario

Parâmetro(s) de entrada:

ParâmetroTipo(tamanho)Observações
credencialCredencialDTOObrigatório.
exercicioIntegerExercício da captação física. Obrigatório.
periodoOrdemInteger (1)1 para o primeiro período da captação física, 2 para o segundo. Obrigatório.
codigoMomentoInteger (4)Momento da captação física (1000, 2000 ou 4500). Campo opcional
filtroFiltroFuncionalProgramaticaDTOPreenchimento obrigatório.
dataHoraReferenciaData/HoraFiltra o retorno para captações que foram alteradas após dataHoraReferencia. Campo opcional.

Tipo de Retorno: RetornoAcompanhamentoOrcamentarioDTO

Exemplo: Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <ser:consultarAcompanhamentoOrcamentario>
       <credencial>
          <perfil>32</perfil>
          <senha>**</senha>
          <usuario>**</usuario>
       </credencial>
       <exercicio>2017</exercicio>
       <periodoOrdem>1</periodoOrdem>
       <codigoMomento>4500</codigoMomento>
       <filtro>
          <codigoAcao>2011</codigoAcao>
          <codigoEsfera>20</codigoEsfera>
          <codigoFuncao>12</codigoFuncao>
          <codigoLocalizador>?</codigoLocalizador>
          <codigoPrograma>2109</codigoPrograma>
          <codigoSubFuncao>331</codigoSubFuncao>
          <codigoTipoInclusaoAcao>?</codigoTipoInclusaoAcao>
          <codigoTipoInclusaoLocalizador>?</codigoTipoInclusaoLocalizador>
          <codigoUO>26401</codigoUO>
       </filtro>
    </ser:consultarAcompanhamentoOrcamentario>
 </soapenv:Body>
</soapenv:Envelope>

Resposta:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:request>**</sof:request>
 </env:Header>
 <env:Body>
    <ns2:consultarAcompanhamentoOrcamentarioResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <acompanhamentosAcoes>
             <acompanhamentoAcao>
                <exercicio>2017</exercicio>
                <codigoMomento>4500</codigoMomento>
                <esfera>20</esfera>
                <unidadeOrcamentaria>26401</unidadeOrcamentaria>
                <funcao>12</funcao>
                331
                <programa>2109</programa>
                <acao>2011</acao>
                <codigoTipoInclusaoAcao>1</codigoTipoInclusaoAcao>
                <snPendencia>false</snPendencia>
                <dataHoraAlteracao>2017-07-21T15:11:09.840-03:00</dataHoraAlteracao>
                <acompanhamentosLocalizadores>
                   <acompanhamentoLocalizador>
                      <localizador>0054</localizador>
                      <codigoTipoInclusaoLocalizador>1</codigoTipoInclusaoLocalizador>
                      <meta>0</meta>
                      <reprogramado>0</reprogramado>
                      <realizadoLOA>0</realizadoLOA>
                      <dataApuracaoLOA>2017-06-30T00:00:00-03:00</dataApuracaoLOA>
                      <dotacaoAtual>1200</dotacaoAtual>
                      <dotacaoInicial>1200</dotacaoInicial>
                      <limite>1200</limite>
                      <empenhado>0.0</empenhado>
                      <liquidado>0.0</liquidado>
                      <pago>0.0</pago>
                      <realizadoRAP>0</realizadoRAP>
                      <dataApuracaoRAP>2017-06-30T00:00:00-03:00</dataApuracaoRAP>
                      <rapInscritoLiquido>0.0</rapInscritoLiquido>
                      <rapLiquidadoAPagar>0.0</rapLiquidadoAPagar>
                      <rapPago>0.0</rapPago>
                      <rapLiquidadoEfetivo>0.0</rapLiquidadoEfetivo>
                      <analisesLocalizador/>
                      <informacoesRegionalizacao/>
                      <acompanhamentosPlanoOrcamentario>
                         <acompanhamentoPlanoOrcamentario>
                            <planoOrcamentario>0001</planoOrcamentario>
                            <realizadoLOA>0</realizadoLOA>
                            <dataApuracaoLOA>2017-06-30T00:00:00-03:00</dataApuracaoLOA>
                            <descricaoProduto>Pessoa beneficiada</descricaoProduto>
                            <descricaoUnidadeMedida>unidade</descricaoUnidadeMedida>
                            <titulo>Auxílio-Transporte - Civis</titulo>
                            <dotacaoAtual>1200.0</dotacaoAtual>
                            <empenhado>0.0</empenhado>
                            <liquidado>0.0</liquidado>
                            <pago>0.0</pago>
                            <meta>1</meta>
                         </acompanhamentoPlanoOrcamentario>
                      </acompanhamentosPlanoOrcamentario>
                   </acompanhamentoLocalizador>
                </acompanhamentosLocalizadores>
             </acompanhamentoAcao>
          </acompanhamentosAcoes>
       </return>
    </ns2:consultarAcompanhamentoOrcamentarioResponse>
 </env:Body>
</env:Envelope>


Consultar Emendas do Localizador

Nome da operação na interface do serviço: obterEmendasLocalizador

Parâmetro(s) de entrada:

Parâmetro Tipo(tamanho) Observações
credencial CredencialDTO
localizador LocalizadorDTO Necessário preenchimento apenas dos atributos exercicio e identificadorUnico.

Tipo de Retorno: RetornoFinanceiroEmendasDTO

Exemplo:

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <ser:consultarEmendasLocalizador>      
       <credencial>
          <perfil>33</perfil>
          <senha>***</senha>
          <usuario>WSSICONV</usuario>
       </credencial>         
       <localizador>
          <exercicio>2013</exercicio>
          <identificadorUnico>963378</identificadorUnico>
       </localizador>         
    </ser:consultarEmendasLocalizador>
 </soapenv:Body>
</soapenv:Envelope>

Resposta:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
 <env:Header/>
 <env:Body>
    <ns2:consultarEmendasLocalizadorResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <financeiros>
             <financeiroEmendas>
                <fonte>100</fonte>
                <idOC>9999</idOC>
                <idUso>0</idUso>
                <identificadorPlanoOrcamentario>7733</identificadorPlanoOrcamentario>
                <naturezaDespesa>33300000</naturezaDespesa>
                <resultadoPrimarioAtual>2</resultadoPrimarioAtual>
                <resultadoPrimarioLei>2</resultadoPrimarioLei>
                <valor>10000</valor>
                <emendas>
                   <emenda>
                      <codAutor>7</codAutor>
                      <decisaoParecerId>1</decisaoParecerId>
                      <emendaNumero>7</emendaNumero>
                      <emenda>2013</emenda>
                      <valorSuplementacao>10000</valorSuplementacao>
                      <valorCancelamento>0</valorCancelamento>
                   </emenda>
                </emendas>
             </financeiroEmendas>
             <financeiroEmendas>
                <fonte>100</fonte>
                <idOC>9999</idOC>
                <idUso>0</idUso>
                <identificadorPlanoOrcamentario>7733</identificadorPlanoOrcamentario>
                <naturezaDespesa>44300000</naturezaDespesa>
                <resultadoPrimarioAtual>2</resultadoPrimarioAtual>
                <resultadoPrimarioLei>2</resultadoPrimarioLei>
                <valor>3990000</valor>
                <emendas>
                   <emenda>
                      <codAutor>7</codAutor>
                      <decisaoParecerId>1</decisaoParecerId>
                      <emendaNumero>7</emendaNumero>
                      <emenda>2013</emenda>
                      <valorSuplementacao>3990000</valorSuplementacao>
                      <valorCancelamento>0</valorCancelamento>
                   </emenda>
                </emendas>
             </financeiroEmendas>
          </financeiros>
       </return>
    </ns2:consultarEmendasLocalizadorResponse>
 </env:Body>
</env:Envelope>

Consultar Execução Orçamentária

Esta operação tem como objetivo fornecer informações de execução financeira com base em filtros de consulta e na seleção dos elementos da programação orçamentária desejados como retorno. Tanto os filtros como as seleções de retorno contemplam todos os elementos da classificação qualitativa (institucional-funcional-programática, inclusive com plano orçamentário), quantitativa e marcadores orçamentários. O filtro de consulta permite que para cada elemento de classificação e marcador orçamentário seja informada uma lista de valores desejados.

O agrupamento dos atributos selecionados segue a seguinte ordem: anoReferencia, anoExercicio, unidadeGestoraUO, unidadeGestoraResponsavel, planoInterno, esfera, orgao, unidadeOrcamentaria, funcao, subFuncao, programa, acao, localizador, planoOrcamentario, natureza, categoriaEconomica, grupoNaturezaDespesa, modalidadeAplicacao, elementoDespesa, subElementoDespesa, idoc, iduso, fonte, resultadoPrimarioLei, resultadoPrimarioAtual, tipoCredito, origem, snObraIrregular, snLeiCalmon, snErradicacaoAnalfabetismo, programacaoSelecionada, snExcecaoDecreto, snAcaoEssencial, tipoApropriacaoPO, tematicaPO, acompanhamentoPO, identificadorAcompanhamentoPO, detalheAcompanhamentoPO.

Por questões de desempenho, foi implementado um mecanismo de paginação dos resultados. A operação tem como um de seus parâmetros uma estrutura do tipo PaginacaoDTO, que é utilizada para que o cliente informe o número da página desejada através do atributo pagina. Quando não informado, o serviço assume o valor 0 (zero), corresponde à primeira página. No retorno desta operação são informados o número da página e o número máximo de registros por página – atributos pagina e registrosPorPagina de PaginacaoDTO. Para obter o resultado completo da consulta o cliente deve realizar sucessivas requisições, incrementando o atributo pagina até que a operação retorne uma quantidade de registros inferior a registrosPorPagina.

Nome da operação na interface do serviço: consultarExecucaoOrcamentaria

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO Informações de acesso ao sistema (login, senha e perfil).
filtro FiltroExecucaoOrcamentariaDTO Filtros de consulta, permite a passagem de uma lista de valores para cada elemento da classificação.
selecaoRetorno SelecaoRetornoExecucaoOrcamentariaDTO Contém um valor booleano opcional para cada elemento da classificação que deva ser retornado pela operação.
paginacao PaginacaoDTO Caso necessário, informe o número da página para obter as páginas subsequentes da consulta.

Tipo de Retorno: RetornoExecucaoOrcamentariaDTO

Exemplo

Requisição:

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://servicoweb.siop.sof.planejamento.gov.br/”>

 <soapenv:Header/>
 <soapenv:Body>
    <ser:consultarExecucaoOrcamentaria>
       <credencial>
          <perfil>32</perfil>
          <senha></senha>
          <usuario>WSMEC</usuario>
       </credencial>
       <filtro>
          <acoes>
             <acao>20RG</acao>
             <acao>20GK</acao>
          </acoes>
          <anoExercicio>2017</anoExercicio>
          <anoReferencia>2017</anoReferencia>
          <planosOrcamentarios>
             <planoOrcamentario>EIND</planoOrcamentario>
          </planosOrcamentarios>          
       </filtro>
       <selecaoRetorno>
          <acao>t</acao>
          <acompanhamentoPO>true</acompanhamentoPO>
          <anoExercicio>t</anoExercicio>
          <anoReferencia>t</anoReferencia>
          <categoriaEconomica>t</categoriaEconomica>
          <detalheAcompanhamentoPO>t</detalheAcompanhamentoPO>
          <elementoDespesa>true</elementoDespesa>
          <esfera>true</esfera>
          <estatalDependente>true</estatalDependente>
          <fonte>true</fonte>
          <funcao>true</funcao>
          <grupoNaturezaDespesa>true</grupoNaturezaDespesa>
          <identificadorAcompanhamentoPO>true</identificadorAcompanhamentoPO>
          <idoc>true</idoc>
          <iduso>true</iduso>
          <localizador>true</localizador>
          <modalidadeAplicacao>true</modalidadeAplicacao>
          <natureza>true</natureza>
          <numeroptres>true</numeroptres>
          <numeroemenda>true</numeroemenda>
          <origem>true</origem>
          <planoInterno>true</planoInterno>
          <planoOrcamentario>true</planoOrcamentario>
          <programa>true</programa>
          <projetoLei>true</projetoLei>
          <resultadoPrimarioAtual>true</resultadoPrimarioAtual>
          <resultadoPrimarioLei>true</resultadoPrimarioLei>
          <subElementoDespesa>true</subElementoDespesa>
          <subFuncao>true</subFuncao>
          <tematicaPO>true</tematicaPO>
          <tipoApropriacaoPO>true</tipoApropriacaoPO>
          <tipoCredito>true</tipoCredito>
          <unidadeGestoraResponsavel>true</unidadeGestoraResponsavel>
          <unidadeOrcamentaria>true</unidadeOrcamentaria>
       </selecaoRetorno>
       <paginacao>
          <pagina></pagina>
          <registrosPorPagina>2</registrosPorPagina>
       </paginacao>
    </ser:consultarExecucaoOrcamentaria>
 </soapenv:Body>

</soapenv:Envelope>

Resposta:

<env:Envelope xmlns:env=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:sof=“http://servicoweb.siop.sof.planejamento.gov.br/”>

 <env:Header>
    <sof:request>A9C7584FDB4C4620448ECEF1376B5573</sof:request>
 </env:Header>
 <env:Body>
    <ns2:consultarExecucaoOrcamentariaResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <execucoesOrcamentarias>
             <execucaoOrcamentaria>
                <acao>20RG</acao>
                <acompanhamentoPO>0</acompanhamentoPO>
                <anoExercicio>2017</anoExercicio>
                <anoReferencia>2017</anoReferencia>
                <categoriaEconomica>4</categoriaEconomica>
                <detalheAcompanhamentoPO>00</detalheAcompanhamentoPO>
                <elementoDespesa>00</elementoDespesa>
                <esfera>10</esfera>
                <fonte>188</fonte>
                <funcao>12</funcao>
                <grupoNaturezaDespesa>4</grupoNaturezaDespesa>
                <idOc>9999</idOc>
                <idUso>0</idUso>
                <identificadorAcompanhamentoPO>00</identificadorAcompanhamentoPO>
                <localizador>0029</localizador>
                <modalidadeAplicacao>99</modalidadeAplicacao>
                <natureza>44990000</natureza>
                <numeroemenda>28790005</numeroemenda>
                <origem>emend</origem>
                <planoOrcamentario>EIND</planoOrcamentario>
                <programa>2080</programa>
                <projetoLei>0.00</projetoLei>
                <resultadoPrimarioAtual>6</resultadoPrimarioAtual>
                <resultadoPrimarioLei>6</resultadoPrimarioLei>
                <subElementoDespesa>00</subElementoDespesa>
                <subFuncao>363</subFuncao>
                <tematicaPO>0</tematicaPO>
                <tipoApropriacaoPO>0</tipoApropriacaoPO>
                <tipoCredito>A</tipoCredito>
                <unidadeOrcamentaria>26101</unidadeOrcamentaria>
             </execucaoOrcamentaria>
             <execucaoOrcamentaria>
                <acao>20RG</acao>
                <acompanhamentoPO>0</acompanhamentoPO>
                <anoExercicio>2017</anoExercicio>
                <anoReferencia>2017</anoReferencia>
                <categoriaEconomica>4</categoriaEconomica>
                <detalheAcompanhamentoPO>00</detalheAcompanhamentoPO>
                <elementoDespesa>00</elementoDespesa>
                <esfera>10</esfera>
                <fonte>188</fonte>
                <funcao>12</funcao>
                <grupoNaturezaDespesa>4</grupoNaturezaDespesa>
                <idOc>9999</idOc>
                <idUso>0</idUso>
                <identificadorAcompanhamentoPO>00</identificadorAcompanhamentoPO>
                <localizador>0029</localizador>
                <modalidadeAplicacao>99</modalidadeAplicacao>
                <natureza>44990000</natureza>
                <numeroemenda>28790005</numeroemenda>
                <numeroptres>129722</numeroptres>
                <origem>siafi</origem>
                <planoOrcamentario>EIND</planoOrcamentario>
                <programa>2080</programa>
                <projetoLei>0.00</projetoLei>
                <resultadoPrimarioAtual>6</resultadoPrimarioAtual>
                <resultadoPrimarioLei>6</resultadoPrimarioLei>
                <subElementoDespesa>00</subElementoDespesa>
                <subFuncao>363</subFuncao>
                <tematicaPO>0</tematicaPO>
                <tipoApropriacaoPO>0</tipoApropriacaoPO>
                <tipoCredito>A</tipoCredito>
                <unidadeOrcamentaria>26101</unidadeOrcamentaria>
             </execucaoOrcamentaria>
          </execucoesOrcamentarias>
          <paginacao>
             <pagina>1</pagina>
             <registrosPorPagina>2</registrosPorPagina>
          </paginacao>
       </return>
    </ns2:consultarExecucaoOrcamentariaResponse>
 </env:Body>

</env:Envelope>

Consultar Execução Orçamentária Mensal

Esta operação possui o mesmo comportamento da operação Consultar Execução Orçamentária, mas devolve o total da execução dentro do mês passado como argumento.

Nome da operação na interface do serviço: consultarExecucaoOrcamentariaMensal

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO Informações de acesso ao sistema (login, senha e perfil).
filtro FiltroExecucaoOrcamentariaDTO Filtros de consulta, permite a passagem de uma lista de valores para cada elemento da classificação.
selecaoRetorno SelecaoRetornoExecucaoOrcamentariaDTO Contém um valor booleano opcional para cada elemento da classificação que deva ser retornado pela operação.
mês Integer Um número inteiro representando o mês a ser consultado.
paginacao PaginacaoDTO Caso necessário, informe o número da página obter as páginas subsequentes da consulta.

Tipo de Retorno: RetornoExecucaoOrcamentariaDTO

Consultar Execução Orçamentária Mensal com Estatais

Operação para obtenção da Execução Orçamentária por mês de um determinado exercício, levando em consideração as esferas 10, 20 e 30, sendo o resultado dos valores de um determinado mês obtidos pelo somatório dos meses anteriores, iniciando em janeiro.

Esta operação implementa o mesmo mecanismo de paginação descrito na operação “Consultar Execução Orçamentária”.

Nome da operação na interface do serviço: consultarExecucaoOrcamentariaEstataisMensal

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
parametros ParametrosWebExecucaoOrcamentariaDTO O exercício é obrigatório.
paginacao PaginacaoDTO Caso necessário, informe o número da página para obter as páginas subsequentes da consulta.

Tipo de Retorno: RetornoExecucaoOrcamentariaMensalDestDTO

Consultar Proposta

Operação para consulta de uma proposta orçamentária. Nesta operação, o atributo proposta, do tipo PropostaDTO, deve ter preenchido apenas os campos que indicam o exercício, momento e tipo de detalhamento, e os que identificam o localizador da proposta.

Nome da operação na interface do serviço: consultarProposta

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
proposta PropostaDTO Nesta operação não é necessário informar as listas de FinanceiroDTO, ReceitaDTO e MetaPlanoOrcamentarioDTO.

Tipo de Retorno: RetornoPropostasDTO

Excluir Proposta

Operação para exclusão de uma proposta orçamentária. Nesta operação, o atributo proposta, do tipo PropostaDTO, deve ter preenchido apenas os campos que indicam o exercício, momento e tipo de detalhamento, e os que identificam o localizador da proposta.

Nome da operação na interface do serviço: excluirProposta

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
proposta PropostaDTO Nesta operação não é necessário informar as listas de FinanceiroDTO, ReceitaDTO e MetaPlanoOrcamentarioDTO.

Tipo de Retorno: RetornoPropostasDTO

Obter Ações Disponíveis para Acompanhamento Orçamentário

Nome da operação na interface do serviço: obterAcoesDisponiveisAcompanhamentoOrcamentario

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
exercicio Inteiro
periodo Inteiro 1 – Jan-Jun, 2 – Jan-Dez
snAcompanhamentoOpcionalAcao Boolean Preenchimento Opcional. Aceita os valores “true”, “false” e nulo. Caso for nulo, retorna todos os valores
snAcompanhamentoOpcionalLocalizador Boolean Preenchimento Opcional. Aceita os valores “true”, “false” e nulo. Caso for nulo, retorna todos os valores

Tipo de Retorno: RetornoAcoesDTO (ver documentação do WSQualitativo) - note que somente retornam as ações de captação obrigatória.

Exemplo:

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <ser:obterAcoesDisponiveisAcompanhamentoOrcamentario>
        <credencial>
          <perfil>[PERFIL]</perfil>
          <senha>[SENHA]</senha>
          <usuario>[LOGIN]</usuario>
       </credencial>
       <exercicio>2013</exercicio>
       <periodo>2</periodo>
       <snAcompanhamentoOpcionalAcao></snAcompanhamentoOpcionalAcao>
       <snAcompanhamentoOpcionalLocalizador>false</snAcompanhamentoOpcionalLocalizador>
    </ser:obterAcoesDisponiveisAcompanhamentoOrcamentario>
 </soapenv:Body>
</soapenv:Envelope>

Resposta:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:request>EECE011BBEABCB576369D19EA2B7F55C</sof:request>
 </env:Header>
 <env:Body>
    <ns2:obterAcoesDisponiveisAcompanhamentoOrcamentarioResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <acoes>
             <acao>
                <codigoAcao>4172</codigoAcao>
                <codigoPrograma>2109</codigoPrograma>
                <codigoFuncao>12</codigoFuncao>
                <codigoSubFuncao>126</codigoSubFuncao>
                <codigoOrgao>26101</codigoOrgao>
                <codigoEsfera>10</codigoEsfera>
                <snAcompanhamentoOpcional>false</snAcompanhamentoOpcional>
                <localizadores>
                   <localizador>
                      <codigoLocalizador>0001</codigoLocalizador>
                      <snAcompanhamentoOpcional>false</snAcompanhamentoOpcional>
                   </localizador>
                </localizadores>
             </acao>
             <acao>
                <codigoAcao>20GK</codigoAcao>
                <codigoPrograma>2032</codigoPrograma>
                <codigoFuncao>12</codigoFuncao>
                <codigoSubFuncao>364</codigoSubFuncao>
                <codigoOrgao>26101</codigoOrgao>
                <codigoEsfera>10</codigoEsfera>
                <snAcompanhamentoOpcional>false</snAcompanhamentoOpcional>
                <localizadores>
                   <localizador>
                      <codigoLocalizador>0001</codigoLocalizador>
                      <snAcompanhamentoOpcional>false</snAcompanhamentoOpcional>
                   </localizador>
                   <localizador>
                      <codigoLocalizador>0022</codigoLocalizador>
                      <snAcompanhamentoOpcional>false</snAcompanhamentoOpcional>
                   </localizador>
                </localizadores>
             </acao>
          </acoes>
       </return>
    </ns2:obterAcoesDisponiveisAcompanhamentoOrcamentarioResponse>
 </env:Body>
</env:Envelope>

Obter Datas Carga SIAFI

Esta operação fornece a data da última carga SIAFI das execuções financeiras diárias, o último mês fechado do SIAFI e a data de fechamento do último mês.

Nome da operação na interface do serviço: obterDatasCargaSIAFI

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO

Tipo de Retorno: RetornoInformacaoCargaSiafiDTO

Exemplo:

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <ser:obterDatasCargaSIAFI>
        <credencial>
          <perfil>[PERFIL]</perfil>
          <senha>[SENHA]</senha>
          <usuario>[LOGIN]</usuario>
       </credencial>
    </ser:obterDatasCargaSIAFI>
 </soapenv:Body>
</soapenv:Envelope>

Retorno:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:request>6DAA65E8E8549529EB1D4C0347F93CF9</sof:request>
 </env:Header>
 <env:Body>
    <ns2:obterDatasCargaSIAFIResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <informacoesCargaSiafi>
             <informacaoCargaSiafi>
                <tipo>diaria</tipo>
                <dataCompetencia>2014-05-05T00:00:00-03:00</dataCompetencia>
                <ultimaCarga>2014-05-06T02:33:54.941-03:00</ultimaCarga>
             </informacaoCargaSiafi>
             <informacaoCargaSiafi>
                <tipo>mensal</tipo>
                <dataCompetencia>2014-03-08T00:00:00-03:00</dataCompetencia>
                <ultimaCarga>2014-04-09T09:07:19.847-03:00</ultimaCarga>
                <ultimoMesFechado>2014-03</ultimoMesFechado>
                <dataFechamentoUltimoMes>2014-04-08T00:00:00-03:00</dataFechamentoUltimoMes>
             </informacaoCargaSiafi>
          </informacoesCargaSiafi>
       </return>
    </ns2:obterDatasCargaSIAFIResponse>
 </env:Body>
</env:Envelope>

Obter informação da captação das propostas do PLOA

Esta operação tem como objetivo fornecer informações sobre o estado das captações das propostas no nível de localizador de gasto. É possível, por exemplo, obter todos os localizadores que já possuem captação, os que estão disponíveis para serem captados e, nos casos de localizadores indisponíveis, saber os motivos pelos quais não é possível realizar a captação.

Nome da operação na interface do serviço: obterInformacaoCaptacaoPLOA

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
parametro ParametroInformacaoCaptacaoPLOA

Tipo de Retorno: RetornoInformacaoCaptacaoPLOADTO

Obter Programação Completa

Operação para consulta de todas as propostas das Unidades Orçamentárias vinculadas à credencial informada.

Nome da operação na interface do serviço: obterProgramacaoCompletaQuantitativo

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
exercicio Inteiro(4)
codigoMomento Inteiro(4) Parâmetro usado com a finalidade de filtrar a consulta para o momento desejado.
dataHoraReferencia Data/Hora A operação só retornará propostas criadas ou alteradas a partir da data e hora de referência, caso informada.
paginacao PaginacaoDTO Caso necessário, informe o número da página para obter as páginas subsequentes da consulta.

Tipo de Retorno: RetornoPropostasDTO

Obter Tabelas de Apoio

Operação para obtenção das tabelas de apoio do módulo quantitativo do SIOP. Podem ser consultadas as tabelas de natureza de despesa, idOC, idUso, fonte e tipo de resultado primário.

Nome da operação na interface do serviço: obterTabelasApoioQuantitativo

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
exercicio Inteiro(4)
retornarNaturezas Boolean Indica se a operação deve retornar a tabela de naturezas de despesa.
retornarIdOcs Boolean Indica se a operação deve retornar a tabela de indicadores de operação de crédito.
retornarIdUsos Boolean Indica se a operação deve retornar a tabela de indicadores de uso.
retornarFontes Boolean Indica se a operação deve retornar a tabela de fontes.
retornarRPs Boolean Indica se a operação deve retornar a tabela de tipos de resultado primário.
dataHoraReferencia Data/Hora A operação só retornará registros criados ou alterados a partir da data e hora de referência, caso informada.

Tipo de Retorno: RetornoApoioQuantitativoDTO

Consultar naturezas de despesa disponíveis para cadastro proposta

Operação para obtenção das naturezas de despesa que podem ser utilizadas no cadastro de uma proposta do módulo quantitativo do SIOP.

Nome da operação na interface do serviço: Listar naturezas de despesa disponíveis para cadastro proposta

Parâmetro(s) de entrada:

Atributo Tipo(tamanho) Observações
credencial CredencialDTO
filtro FiltroNaturezaDespesaDTO

Tipo de Retorno: RetornoNaturezasDTO

Estruturas de Entrada/Saída e Retorno

As informações que trafegam pelo serviço são organizadas em estruturas de dados que atuam como entrada (parâmetros) e retorno das operações. Enquanto os dados são manipulados pelos sistemas, seja nos clientes ou no servidor, essas informações ficam alocadas em entidades que, no contexto de web services, podem ser chamadas de Objetos de Transferência de Dados, ou DTOs (sigla de Data Transfer Objects). Um DTO é uma classe de objetos que descreve os atributos (e as operações de atribuição e consulta de seus valores) de determinado conceito envolvido no domínio de um problema. No momento da comunicação, seja na requisição ou na resposta, os DTOs são transformados em estruturas XML formatadas de acordo com a especificação contida no documento descritor do web service (WSDL).

As linguagens de programação modernas possuem ferramentas que automatizam o processo de construção dos DTOs a partir do WSDL, bem como bibliotecas com funcionalidades que tornam transparente para o desenvolvedor o processo de tradução de DTO para XML e vice-versa.

Entradas/Saídas

AcompanhamentoFisicoFinanceiroDTO

AtributoTipo(tamanho)Observações
tipoCaptacaoCharacter (35)Descrição do tipo de captação dos registros, por localizador ou plano orçamentário
exercicioInteger (4)Exercício da captação física.
periodoVarchar (80)Descrição do período da captação física
momentoIdIntegerCódigo do momento
momentoVarchar (150)Descrição do momento
esferaCharacter (2)Código da esfera orçamentária.
orgaoCharacter (5)Código do órgão orçamentário.
descricaoOrgaoVarchar (110)Descrição do órgão orçamentário.
uoCharacter (5)Código da unidade orçamentária.
descricaoUoVarchar (110)Descrição da unidade orçamentária.
orgaoSiorgVarchar (6)Código do Orgão Siorg
descricaoSiorgVarchar (110)Descrição do Órgão Siorg
funcaoCharacter (2)Código da função.
descricaoFuncaoVarchar (120)Descrição da função.
subfuncaoCharacter (3)Código da Subfunção.
descricaoSubFuncaoVarchar (120)Descrição da Subfunção.
programaCharacter (4)Código do programa.
tituloProgramaVarchar (255)Título do programa.
acaoCharacter (4)Código da ação.
tituloAcaoVarchar (255)Título da ação.
produtoInteger (4)Código do produto. Referencia ao atributo codigoProduto em produtoDTO.
unidadeMedidaCharacter (10)Unidade de medida do produto da ação
descricaoUnidadeMedidaVarchar (80)Descrição da unidade de medida do produto da ação
localizadorCharacter (4)Código do localizador.
descricaoLocalizadorVarchar (255)Descrição do localizador.
quantidadeMetaLOANumeric (16,2)Quantidade física da proposta quantitativa no momento LOA (8000)
dotacaoInicialNumeric (16,2)Valor financeiro da proposta orçamentária no momento LOA (8000).
dotacaoAtualNumeric (16,2)Valor financeiro da proposta orçamentária corrente.
liquidadoNumeric (16,2)Valor liquidado oriundo do SIAFI .
reprogramadoFisicoNumeric (16,2)Quantidade física reprogramada
reprogramadoFinanceiroNumeric (16,2)Valor financeiro reprogramado
realizadoLOANumeric (16,2)Quantidade realizada em relação a meta LOA
pagoNumeric (16,2)Valor pago oriundo do SIAFI.
liquidadoRAPNumeric (16,2)Valor liquidado por inscrição de RAP.
realizadoRAPNumeric (16,2)Valor realizado de RAP.
codigoPOCharacter (4)Código do plano orçamentário.
tituloPOVarchar (255)Título do plano orçamentário.
produtoPOInteger (4)Código do produto do plano orçamentário. Referencia ao atributo codigoProduto em produtoDTO.
unidadeMedidaPOCharacter (10)Unidade de medida do produto do plano orçamentário
descricaoUnidadeMedidaPOVarchar (80)Descrição da unidade de medida do produto do plano orçamentário
quantidadeMetaLOAPONumeric (16,2)Meta física inicial do plano orçamentário
quantidadeMetaAtualPONumeric (16,2)Meta física do plano orçamentário atualizada
dotacaoInicialPONumeric (16,2)Dotação inicial do plano orçamentário
dotacaoAtualPONumeric (16,2)Dotação atual do plano orçamentário
liquidadoPONumeric (16,2)Valor liquidado do plano orçamentário
realizadoPONumeric (16,2)Valor realizado em relação a meta LOA do plano orçamentário
pagoPONumeric (16,2)Valor pago do plano orçamentário
liquidadoRAPPONumeric (16,2)Valor liquidado por inscrição de RAP do plano orçamentário
descricaoProdutoVarchar (80)Descrição do produto
descricaoProdutoPOVarchar (80)Descrição do produto intermediário (produto do plano orçamentário)

AcompanhamentoOrcamentarioAcaoDTO

AtributoTipo(tamanho)Observações
periodoOrdemInteiro(1)
exercicioInteiro(4)Exercício da captação física.
codigoMomentoInteiro(4)
esferaTexto(2)Código da esfera orçamentária.
unidadeOrcamentariaTexto(5)Código do órgão orçamentário.
funcaoTexto(2)Código da função.
subFuncaoTexto(3)Código da Subfunção.
programaTexto(4)Código do programa.
acaoTexto(4)Código da ação.
codigoTipoInclusaoAcaoInteiro(1)Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário.
acompanhamentosLocalizadoresLista de AcompanhamentoOrcamentarioLocalizadorDTO
snPendenciaBooleanIndica a ocorrência de pendências na captação. Este é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento.
dataHoraAlteracaoDataEste é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento.

AcompanhamentoOrcamentarioLocalizadorDTO

Esta estrutura encapsula os dados de acompanhamento orçamentário de um localizador e é sempre utilizada como componente de AcompanhamentoOrcamentarioAcaoDTO no atributo acompanhamentosLocalizadores.

A chave única deste localizador é composta pelos atributos localizador e codigoTipoInclusaoLocalizador em conjunto com a chave única do AcompanhamentoOrcamentarioAcaoDTO do qual está relacionado.

AtributoTipo(tamanho)Observações
localizador Texto(4)Código do localizador.
codigoTipoInclusaoLocalizador Inteiro(1)Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário
reprogramadoLongExecução física Reprogramada para o exercício.
realizadoLOALongExecução física realizada.
realizadoRAPLongExecução física realizada para Restos a Pagar Não Processados.
limiteLongReprogramado Financeiro(limite de empenho)
justificativa Texto(1000) Este atributo deixou de ser utilizado a partir de 2013.
dataApuracaoLOADataData de apuração da execução física.
dataApuracaoRAPDataData de apuração da execução física para Restos a Pagar Não Processados.
metaLongMeta física do localizador. Somente retorno. Não deve ser preenchido no cadastro de acompanhamento.
dotacaoAtualLongSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
dotacaoInicialLongSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
empenhadoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
liquidadoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
pagoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
rapInscritoLiquidoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Inscrito Líquido.
rapLiquidadoAPagarDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Liquidado a Pagar.
rapPagoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Pago.
rapLiquidadoEfetivoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Liquidado Efetivo.
analisesLocalizadorLista de AnaliseAcompanhamentoOrcamentarioDTOContém os comentários analíticos sobre o acompanhamento. Pelo menos uma análise deve ser preenchida.
informacoesRegionalizacaoLista de AcompanhamentoOrcamentarioRegionalizacaoDTOAs informações sobre a regionalização devem ser preenchidos nos localizadores nacionais (região Nacional) das ações marcadas com snRegionalizarNaExecucao.
acompanhamentosPlanoOrcamentarioLista de AcompanhamentoPlanoOrcamentarioDTOContém os acompanhamentos dos Planos Orçamentários (PO). Pode ser preenchido quando um dos POs possuir meta fisica estabelecida.


AcompanhamentoPlanoOrcamentarioDTO

AtributoTipo(tamanho)Observações
planoOrcamentarioTexto(4)Código do plano orçamentário.
realizadoLOALongExecução física realizada.
dataApuracaoLOADataData de apuração da execução física.
descricaoProdutoTextoSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
descricaoUnidadeMedidaTextoSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
tituloTextoSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
dotacaoAtualDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
empenhadoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
liquidadoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
pagoDoubleSomente retorno. Não deve ser preenchido no cadastro de acompanhamento.
metaLongMeta física do PO. Somente retorno. Não deve ser preenchido no cadastro de acompanhamento.
analisesPlanoOrcamentarioLista de AnaliseAcompanhamentoOrcamentarioDTONeste campo devem ser colocados, sempre que possível, os fatores que contribuíram para a execução da ação; os fatores que a dificultaram; a metodologia de apuração do realizado no período; os resultados obtidos com os recursos da ação; informações adicionais relevantes, não descritas acima; e a justificativa para a Reprogramação, se houver.

AnaliseAcompanhamentoOrcamentarioDTO

AtributoTipo(tamanho)Observações
periodoOrdemInteiro(1)
analiseTexto(5000)
nomeUsuarioTexto(255)Usado apenas no retorno de operações de consulta.
ultimaModificacaoDataUsado apenas no retorno de operações de consulta.

AcompanhamentoOrcamentarioRegionalizacaoDTO

AtributoTipo(tamanho)Observações
codigoRegiaointCódigo da Região (ver RegiaoDTO - WSQualitativo)
ufTexto(2)Sigla da UF
municipioTexto(7)Código IBGE do município com 7 dígitos
recorteGeograficoIdintCódigo do Recorte Geográfico (ver RecorteGeograficoDTO - WSQualitativo)
liquidadoLongvalor liquidado para esta regionalização da execução
realizadoLongmeta realizada para esta regionalização da execução
comentarioTexto(5000)
nomeUsuarioTexto(255)Usado apenas no retorno de operações de consulta.
ultimaModificacaoDataUsado apenas no retorno de operações de consulta.


CredencialDTO

Esta estrutura é composta pelas informações necessárias para que a aplicação cliente se identifique junto ao serviço. A credencial a ser utilizada nos web services do SIOP é específica para esse fim e não é válida para acessar a aplicação web. Todas as operações do WSQuantitativo utilizam CredencialDTO como parâmetro.

AtributoTipo(tamanho)Aceita Nulo?Observações
usuarioTextoNãoLogin do usuário no SIOP
senhaTextoNãoHash MD5 da senha do usuário no SIOP
perfilInteiroSim (apenas para operações de consultas de tabelas de apoio).Perfil com o qual o usuário deseja realizar determinada operação. Não é obrigatório na operação obterTabelasApoioQuantitativo.

EmendaDTO

AtributoTipo(tamanho)
exercicioInteger
codAutorInteger
decisaoParecerIdInteger
emendaNumeroInteger
emendaInteger
valorSuplementacaoLong
valorCancelamentoLong

ExecucaoOrcamentariaDTO

AtributoTipo(tamanho)Descrição
anoReferenciaInteger(4)Ano de referência, diferente do ano de execução nos casos de restos a pagar.
anoExercicioInteger(4)Ano de exercício, representa o ano de execução.
unidadeGestoraResponsavelvarchar(6)
planoInternovarchar(11)Código do plano interno.
esferavarchar(2)Código da esfera.
unidadeOrcamentariavarchar(5)Código da unidade orçamentária.
funcaovarchar(2)Código da função.
subFuncaovarchar(3)Código da subfunção.
programavarchar(4)Código do programa.
acaovarchar(4)Código da ação.
localizadorvarchar(4)Código do localizador.
planoOrcamentariovarchar(4)Código do plano orçamentário.
naturezavarchar(8)Código da natureza de despesa.
categoriaEconomicavarchar(1)Código da categoria econômica.
grupoNaturezaDespesavarchar(1)Código do grupo de natureza de despesa.
modalidadeAplicacaovarchar(2)Código da modalidade de aplicação.
elementoDespesavarchar(2)Código do elemento de despesa.
subElementoDespesavarchar(2)Código do subelemento de despesa.
idOcvarchar(4)Código do identificador de doação e operações de crédito.
idUsovarchar(1)Código do identificador de uso.
fontevarchar(4)Código da fonte de recursos.
resultadoPrimarioLeivarchar(1)O código de resultado primário possui dois campos para guardar o código definido em lei e o atual, pois pode ter ocorrido alguma alteração orçamentária.
resultadoPrimarioAtualvarchar(1)O código de resultado primário possui dois campos para guardar o código definido em lei e o atual, pois pode ter ocorrido alguma alteração orçamentária.
tipoCreditovarchar(1)é a origem (tipo de inclusão) da ação. Domínio: A = LOA, C = Crédito Especial, G = Crédito Extraordinário.
origemvarchar(5)
tipoApropriacaoPOvarchar(1)
tematicaPOvarchar(1)indica se o PO está associado a algum recorte temático do orçamento.
acompanhamentoPOvarchar(1)Código do acompanhamento (Plano Orçamentário).
identificadorAcompanhamentoPOvarchar(2)Código do identificador de acompanhamento (Plano Orçamentário).
detalheAcompanhamentoPOvarchar(2)Código do detalhe de acompanhamento (Plano Orçamentário).
autorizadoBigDecimal
projetoLeiBigDecimal
dotacaoAntecipadaBigDecimal
dotacaoInicialBigDecimal
dotInicialSiafiBigDecimal
dotAtualBigDecimal
empLiquidadoBigDecimal
empenhadoALiquidarBigDecimal
pagoBigDecimal
disponivelBigDecimal
indisponivelBigDecimal
rapInscritoProcessadoBigDecimal
rapExerciciosAnterioresBigDecimal
rapCanceladosNaoProcessadosBigDecimal
rapCanceladosProcessadosBigDecimal
rapAPagarNaoProcessadoBigDecimal
rapAPagarProcessadoBigDecimal
rapPagoNaoProcessadoBigDecimal
rapPagoProcessadoBigDecimal
rapInscritoNaoProcessadoBigDecimal
rapNaoProcessadoBloqueadoBigDecimal
rapNaoProcessadoALiquidarBigDecimal
rapNaoProcessadoLiquidadoAPagarBigDecimal
creditoContidoSOFBigDecimal
bloqueadoSOFBigDecimal
bloqueadoRemanejamentoBigDecimal
executadoPorInscricaoDeRAPBigDecimalCorresponde ao ajuste anual, presente no SIAFI, de despesas executadas por inscrição em restos a pagar.
numeroptresStringPrograma de Trabalho Resumido.
numeroemendaStringAutor e número da emenda individual ou de bancada estadual.

ExecucaoOrcamentariaMensalDestDTO

AtributoTipo(tamanho)Observações
exercicioInteiro(4)Obrigatório.
esferaTexto(2)Código da esfera orçamentária.
unidadeOrcamentariaTexto(5)Código da unidade orçamentária.
funcaoTexto(2)Código da função.
descricaoFuncaoTextoDescrição da função.
subfuncaoTexto(3)Código da Subfunção.
descricaoSubfuncaoTextoDescrição da Subfunção.
programaTexto(4)Código do programa.
tituloProgramaTextoTítulo do programa.
acaoTexto(4)Código da ação.
tituloAcaoTextoTítulo da ação.
localizadorTexto(4)Código do localizador.
tituloLocalizadorTextoTítulo do localizador.
ppipacBooleanoVerdadeiro caso faça parte do ppiPac, falso caso contrário
regiaoTexto
ufTexto
leiBigDecimalDotação da lei (inicial).
leiMaisCreditosBigDecimalDotação atual.
realizadaJaneiroBigDecimalEmpenho a liquidar com empenho liquidado em janeiro
realizadaFevereiroBigDecimalEmpenho a liquidar com empenho liquidado somados até fevereiro
realizadaMarcoBigDecimalEmpenho a liquidar com empenho liquidado somados até março
realizadaAbrilBigDecimalEmpenho a liquidar com empenho liquidado somados até abril
realizadaMaioBigDecimalEmpenho a liquidar com empenho liquidado somados até maio
realizadaJunhoBigDecimalEmpenho a liquidar com empenho liquidado somados até junho
realizadaJulhoBigDecimalEmpenho a liquidar com empenho liquidado somados até julho
realizadaAgostoBigDecimalEmpenho a liquidar com empenho liquidado somados até agosto
realizadaSetembroBigDecimalEmpenho a liquidar com empenho liquidado somados até setembro
realizadaOutubroBigDecimalEmpenho a liquidar com empenho liquidado somados até outubro
realizadaNovembroBigDecimalEmpenho a liquidar com empenho liquidado somados até novembro
realizadaDezembroBigDecimalEmpenho a liquidar com empenho liquidado somados até dezembro
estatalDependenteBooleanIndica se é uma estatal dependente
estatalIndependenteBooleanIndica se é uma estatal independente

FiltroExecucaoOrcamentariaDTO

AtributoTipo(tamanho)Aceita nulo?Descrição
anoExercicioInteiro(4)Sim, caso anoReferencia seja informadoAno de exercício, representa o ano de execução.
anoReferenciaInteiro(4)Sim, caso anoExercicio seja informadoAno de referência, diferente do ano de execução nos casos de restos a pagar.
esferasLista de varchar(2)SimCódigos das esferas.
unidadesOrcamentariasLista de varchar(5)SimCódigos das unidades orçamentárias.
funcoesLista de varchar(2)SimCódigos das funções.
subfuncoesLista de varchar(3)SimCódigos das subfunções.
programasLista de varchar(4)SimCódigos dos programas.
acoesLista de varchar(4)SimCódigos das ações.
localizadoresLista de varchar(4)SimCódigos dos localizadores.
planosOrcamentariosLista de varchar(4)SimCódigos dos planos orçamentários.
naturezasDespesaLista de varchar(8)SimCódigos das naturezas de despesas completos (até subelemento de despesa).
categoriasEconomicasLista de varchar(1)SimCódigos das categorias econômicas.
gruposNaturezaLista de varchar(1)SimCódigos dos grupos de naturezas de despesa.
modalidadesAplicacaoLista de varchar(2)SimCódigos das modalidades de aplicação.
elementosDespesaLista de varchar(2)SimCódigos dos elementos de despesa.
idusosLista de varchar(1)SimCódigos dos identificadores de uso.
fontesLista de varchar(4)SimCódigos das fontes de recursos.
idocsLista de varchar(4)SimCódigos dos identificadores de doação e operações de crédito.
resultadosPrimariosLeiLista de varchar(1)SimCódigos dos resultados primários na LOA.
resultadosPrimariosAtuaisLista de varchar(1)SimCódigos dos resultados primários atuais.
planosInternosLista de varchar(11)SimCódigos dos planos internos.
unidadesGestorasResponsaveisLista de varchar(6)SimCódigos das unidades gestoras responsáveis.
tipoCreditoLista de varchar(1)Simé a origem (tipo de inclusão) da ação. Domínio: A = LOA, C = Crédito Especial, G = Crédito Extraordinário.
programacoesSelecionadasLista de varchar(1)SimMarcações Programação Selecionada.
tiposPrecatoriosLista de varchar(1)SimMarcadores de Precatório
acompanhamentosIntensivosLista de varchar(2)SimMarcadores de Acompanhamentos Intensivos
tiposApropriacaoPOLista de varchar(1)SimCódigos dos tipos de apropriação (Plano Orçamentário)
tematicasPOLista de varchar(1)SimCódigos das temáticas (Plano Orçamentário)
acompanhamentosPOLista de varchar(1)SimCódigos dos acompanhamentos (Plano Orçamentário)
identificadoresAcompanhamentoPOLista de varchar(2)SimCódigos dos identificadores de acompanhamento (Plano Orçamentário)
detalhesAcompanhamentoPOLista de varchar(2)SimCódigos dos detalhes de acompanhamento (Plano Orçamentário)

FiltroFuncionalProgramaticaDTO

Classe que encapsula os dados que compõem a classificação institucional/funcional-programática até o nível de localizador (incluindo tipo de inclusão de ação e de localizador). É utilizada como parâmetro nas operações de consulta. Os atributos passados como nulos são desconsiderados.

AtributoTipo(tamanho)Aceita Nulo?Observações
codigoAcaoTexto(4)Sim
codigoEsferaTexto(2)Sim
codigoFuncaoTexto(2)Sim
codigoLocalizadorTexto(4)Sim
codigoProgramaTexto(4)Sim
codigoSubFuncaoTexto(3)Sim
codigoTipoInclusaoAcaoInteiro(1)SimValores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário.
codigoTipoInclusaoLocalizadorInteiro(1)SimValores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário.
codigoUOTexto(5)Sim
exercicioInteiro(4)Sim

FinanceiroDTO

A chave única deste DTO deve ser composta também pela chave-única de PropostaDTO.

AtributoTipo(tamanho)Aceita Nulo?Observações
idUsoTexto(1)NãoOs valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo.
idOCTexto(4)NãoOs valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo.
naturezaDespesaTexto(8)NãoOs valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo.
fonteTexto(3)NãoOs valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo.
resultadoPrimarioLeiTexto(1)NãoO código de resultado primário possui dois campos para guardar o código definido em lei e o atual, pois pode ter ocorrido alguma alteração orçamentária.
resultadoPrimarioAtualTexto(1)SimO código de resultado primário possui dois campos para guardar o código definido em lei e o atual, pois pode ter ocorrido alguma alteração orçamentária.
identificadorPlanoOrcamentarioInteiroNãoDeve ser preenchido se a ação possuir pelo menos um plano orçamentário. O valor desse campo corresponde ao atributo identificadorUnico de PlanoOrcamentarioDTO (não é o código do plano orçamentário).
valorLongNão
expansaoSolicitadaLongSim
expansaoConcedidaLongSimCampo de retorno.

FinanceiroEmendasDTO

Este DTO herda os atributos de FinanceiroDTO.

AtributoTipo(tamanho)Observações
emendasLista de EmendaDTO

FonteDTO

AtributoTipo(tamanho)Observações
codigoFonteTexto
exercicioInteiro
descricaoTexto
snAtivoBooleano

IdOcDTO

AtributoTipo(tamanho)Observações
codigoIdOcString
exercicioInteiro
descricaoTexto
snAtivoBooleano

IdUsoDTO

AtributoTipo(tamanho)Observações
codigoIdUsoDTOTexto
exercicioInteiro
descricaoTexto
snAtivoBooleano

InformacaoCargaSiafiDTO

AtributoTipo(tamanho)Observações
dataCompetenciaDate
dataFechamentoUltimoMesDate
tipoString
ultimaCargaDate
ultimoMesFechadoStringFormato: AAAA-MM

InformacaoCaptacaoPLOADTO

AtributoTipo(tamanho)Observações
exercicioInteiro
identificadorUnicoLocalizadorInteiro
codigoMomentoLocalizadorInteiro
identificadorUnicoAcaoInteiro
codigoMomentoAcaoInteiro
funcionalTexto
temPropostaBoolean
codigoMomentoPropostaAtualInteiro
propostaValidaBoolean
codigoTipoDetalhamentoTexto(2)
temJanelaBoolean
codigoMomentoJanelaAtualInteiro
podeCaptarBoolean
porQueNaoPodeCaptarTexto

MetaPlanoOrcamentarioDTO

AtributoTipo(tamanho)Observações
identificadorUnicoPlanoOrcamentarioInteiroO valor desse campo corresponde ao atributo identificadorUnico de PlanoOrcamentarioDTO (não é o código do plano orçamentário).
quantidadeFisicoLongMeta física para o plano orçamentário.
expansaoFisicaSolicitadaLong
expansaoFisicaConcedidaLongCampo de retorno.

NaturezaDespesaDTO

AtributoTipo(tamanho)Observações
codigoNaturezaTexto
exercicioInteiro
descricaoTexto
descricaoAbreviadaTexto

ParametroInformacaoCaptacaoPLOA

AtributoTipo(tamanho)Aceita nulo?Observações
exercicioInteiroNão
codigoMomentoInteiroNão
codigoTipoDetalhamentoTexto(2)Sim
codigoOrgaoTexto(5)Não
codigoUnidadeOrcamentariaTexto(5)Sim
captadosBooleanSimUse true para obter somente os localizadores com proposta, false para obter somente os localizadores sem proposta, e nulo para todos.
captaveisBooleanSimUse true para obter apenas os localizadores que estejam aptos a serem captados. Em caso de false ou nulo retorna todos.

ParametrosWebExecucaoOrcamentariaDTO

Parâmetros aplicáveis a consultas de execução orçamentária, para filtrar os resultados do serviço.

AtributoTipo(tamanho)Aceita Nulo?Observações
exercicioInteiro(4)NãoObrigatório.
esferaTextoSim
orgaoTextoSim
unidadeOrcamentariaTextoSim
funcaoTextoSim
subFuncaoTextoSim
programaTextoSim
acaoTextoSim
localizadorTextoSim

PropostaDTO

Representa a proposta orçamentária para um determinado localizador e tipo de detalhamento.

AtributoTipo(tamanho)Aceita Nulo?Observações
exercicioInteiroNão
codigoEsferaTexto(2)Não
codigoOrgaoTexto(5)NãoCódigo da unidade orçamentária.
codigoFuncaoTexto(2)Não
codigoSubFuncaoTexto(3)Não
codigoProgramaTexto(4)Não
codigoAcaoTexto(4)Não
codigoTipoInclusaoAcaoNumerico(1)NãoValores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário
codigoLocalizadorTexto(4)Não
codigoTipoInclusaoLocalizadorNumerico(1)NãoValores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário
codigoMomentoNumerico(4)Não São os momentos (etapas) do processo no SIOP: 1000 (UO), 2000 (OS), 5000 (PLOA) e 8000 (LOA). Podem haver outros visualizados somente na SOF.
codigoTipoDetalhamentoTexto(2)Não São referenciais usados durante a elaboração da proposta. Para momentos PLOA e LOA devem sempre estar com valor zero. Detalhes dos valores podem ser consultados no MTO.
snAtualBooleanSimCampo de retorno
quantidadeFisicoLongSimMeta física para o localizador da proposta.
valorFisicoLongSimValor necessário para atingir a meta física, equivale à soma dos financeiros da proposta.
financeirosLista de FinanceiroDTONãoContém os detalhamentos financeiros da proposta.
receitasLista de ReceitaDTOSimUtilizado somente nas propostas da esfera 30 (investimentos).
metaPlanoOrcamentarioLista de MetaPlanoOrcamentarioDTOSimjustificativaContém as metas físicas dos planos orçamentários que possuam produto associado.
justificativaTextoSim
identificadorUnicoAcaoInteiroSim
expansaoFisicaSolicitadaLongSim
expansaoFisicaConcedidaLongSimCampo de retorno.
justificativaExpansaoSolicitadaString(2500)Sim
justificativaExpansaoConcedidaString(2500)SimCampo de retorno.

ReceitaDTO

AtributoTipo(tamanho)Aceita Nulo?Observações
naturezaReceitaTexto(8)NãoCódigo de Natureza de Receita.
valorLongNão

ResultadoPrimarioDTO

AtributoTipo(tamanho)Observações
codigoResultadoPrimarioTexto
exercicioInteiro
descricaoTexto

SelecaoRetornoExecucaoOrcamentariaDTO

AtributoTipo(tamanho)Aceita Nulo?Descrição
anoReferenciaBooleanSim
anoExercicioBooleanSim
unidadeGestoraResponsavelBooleanSim
planoInternoBooleanSim
esferaBooleanSim
unidadeOrcamentariaBooleanSim
funcaoBooleanSim
subFuncaoBooleanSim
programaBooleanSim
acaoBooleanSim
localizadorBooleanSim
planoOrcamentarioBooleanSim
naturezaBooleanSim
categoriaEconomicaBooleanSim
grupoNaturezaDespesaBooleanSim
modalidadeAplicacaoBooleanSim
elementoDespesaBooleanSim
subElementoDespesaBooleanSim
idocBooleanSim
idusoBooleanSim
fonteBooleanSim
resultadoPrimarioLeiBooleanSimO código de resultado primário possui dois campos para guardar o código definido em lei e o atual, pois pode ter ocorrido alguma alteração orçamentária.
resultadoPrimarioAtualBooleanSimO código de resultado primário possui dois campos para guardar o código definido em lei e o atual, pois pode ter ocorrido alguma alteração orçamentária.
tipoCreditoBooleanSimé a origem (tipo de inclusão) da ação. Domínio: A = LOA, C = Crédito Especial, G = Crédito Extraordinário.
programacaoSelecionadaBooleanSim
tipoPrecatorioBooleanSim
tipoApropriacaoPOBooleanSim
tematicaPOBooleanSimIndica se o PO está associado a algum recorte temático do orçamento.
acompanhamentoPOBooleanSim
identificadorAcompanhamentoPOBooleanSim
detalheAcompanhamentoPOBooleanSim
autorizadoBooleanSim
projetoLeiBooleanSim
dotacaoAntecipadaBooleanSim
dotacaoInicialBooleanSim
dotInicialSiafiBooleanSim
dotAtualBooleanSim
empLiquidadoBooleanSim
empenhadoALiquidarBooleanSim
pagoBooleanSim
disponivelBooleanSim
indisponivelBooleanSim
rapInscritoProcessadoBooleanSim
rapExerciciosAnterioresBooleanSim
rapCanceladosNaoProcessadosBooleanSim
rapCanceladosProcessadosBooleanSim
rapAPagarNaoProcessadoBooleanSim
rapAPagarProcessadoBooleanSim
rapPagoNaoProcessadoBooleanSim
rapPagoProcessadoBooleanSim
rapInscritoNaoProcessadoBooleanSim
rapNaoProcessadoBloqueadoBooleanSim
rapNaoProcessadoALiquidarBooleanSim
rapNaoProcessadoLiquidadoAPagarBooleanSim
creditoContidoSOFBooleanSim
bloqueadoSOFBooleanSim
bloqueadoRemanejamentoBooleanSim
mesBooleanSimUtilizado apenas nas chamadas de consultarExecucaoOrcamentariaMensal
numeroptresBooleanSim
numeroemendaBooleanSim

FisicoPedidoAlteracaoDTO

AtributoTipo(tamanho)Observações
exercicioInteiro
codigoEsferaTexto
codigoUOTexto
codigoFuncaoTexto
codigoSubFuncaoTexto
codigoProgramaTexto
codigoAcaoTexto
codigoLocalizadorTexto
codigoTipoInclusaoAcaoInteiro
codigoTipoInclusaoLocalizadorInteiro
quantidadeAcrescimoNumérico
quantidadeReducaoNumérico
listaFinanceiroPedidoAlteracaoDTOLista FinanceiroPedidoAlteracaoDTO

Retornos

PaginacaoDTO

AtributoTipo(tamanho)Observações
paginaInteiroNúmero da página retornada na consulta. Quando utilizado como parâmetro, deve informar o número da página desejada.
registrosPorPaginaInteiroNúmero máximo de registros por página.

RetornoAcompanhamentoFisicoFinanceiroDTO

AtributoTipo(tamanho)Observações
registrosLista de AcompanhamentoFisicoFinanceiroDTO
paginacaoPaginacaoDTOContém informações sobre a paginação do resultado da operação. Pode ser utilizado também como parâmetro nas operações com páginação quando se pretende obter as páginas subsequentes de uma consulta.
dataHoraUltimaCargaSiafiDataData da última atualização dos valores financeiros.

RetornoAcompanhamentoOrcamentarioDTO

AtributoTipo(tamanho)Observações
acompanhamentosAcaoLista de AcompanhamentoOrcamentarioAcaoDTO

RetornoApoioQuantitativoDTO

AtributoTipo(tamanho)Observações
naturezasLista de NaturezaDespesaDTO
idocsLista de IdOcDTO
idUsosLista de IdUsoDTO
fontesLista de FonteDTO
resultadosPrimariosLista de ResultadoPrimarioDTO

RetornoExecucaoOrcamentariaDTO

AtributoTipo(tamanho)Descrição
sucessoBooleanIndicação de sucesso na execução da operação.
mensagensErroLista de StringLista com as mensagens do sistema em caso de sucesso = false.
dataHoraUltimaCargaDate Data e hora da última carga da parasof (STN). ATENÇÃO! nas operações de consultas de execução mensal este campo tem o seguinte significado específico. O ano e mês informam o último mês fechado. O dia serve para indicar quando ocorreu o fechamento do mês, mas é necessário incrementar o valor do mês em 1. Exemplos: “2014-05-09” = mês 05/14 fechou em 09/06/14, “2014-04-11” = mês 04/14 fechou em 11/05/14, “2014-03-08” = mês 03/14 fechou em 08/04/14
execucoesOrcamentariasLista de ExecucaoOrcamentariaDTO
paginacaoPaginacaoDTO

RetornoExecucaoOrcamentariaDestDTO

AtributoTipo(tamanho)Observações
registrosLista de ExecucaoOrcamentariaMensalDestDTO

RetornoFinanceiroEmendasDTO

AtributoTipo(tamanho)Observações
financeirosLista de FinanceiroEmendasDTO

RetornoInformacaoCaptacaoPLOADTO

AtributoTipo(tamanho)
registrosLista de InformacaoCaptacaoPLOADTO

RetornoInformacaoCargaSiafiDTO

AtributoTipo(tamanho)Observações
informacoesCargaSiafiList<InformacaoCargaSiafiDTO>

3.2.11 RetornoPropostasDTO

AtributoTipo(tamanho)Observações
sucessoBooleanoIndica que a operação foi realizada com sucesso.
mensagensErroLista de TextoLista de mensagens de erro, quando sucesso for 'false'.
registrosLista de PropostaDTO
numeroRegistrosInteiroNúmero de registros retornados
valorTotalLongValor total dos registros retornados