| 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 |
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çã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âmetro | Tipo(tamanho) | Observações |
| credencial | CredencialDTO | |
| acompanhamentoAcao | AcompanhamentoOrcamentarioAcaoDTO |
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>
<subFuncao>663</subFuncao>
<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>
<justificativa>Análise Adicional WebService</justificativa>
<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 (Numeric(16,2)) -->
<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>
<perguntasAcompanhamentoLocalizador>
<perguntaAcompanhamentoLocalizador>
<codigoPergunta>522</codigoPergunta>
<tipoPergunta>Objetiva</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2884</codigoResposta>
<especificacaoResposta>Especificação Resposta</especificacaoResposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamentoLocalizador>
<perguntaAcompanhamentoLocalizador>
<codigoPergunta>524</codigoPergunta>
<tipoPergunta>Objetiva de múltipla escolha</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2891</codigoResposta>
<especificacaoResposta>Especificação outros.</especificacaoResposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamentoLocalizador>
<perguntaAcompanhamentoLocalizador>
<codigoPergunta>528</codigoPergunta>
<tipoPergunta>Objetiva de resposta múltipla com ordenação</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2912</codigoResposta>
<resposta>Outros - descrever.</resposta>
<especificacaoResposta>Especificação outros ordenação.</especificacaoResposta>
<ordem>1</ordem>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamentoLocalizador>
<perguntaAcompanhamentoLocalizador>
<codigoPergunta>533</codigoPergunta>
<tipoPergunta>Objetiva de resposta múltipla</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2946</codigoResposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2934</codigoResposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamentoLocalizador>
</perguntasAcompanhamentoLocalizador>
<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>
<reprogramado>10</reprogramado>
<limite>5</limite>
<analisesPlanoOrcamentario>
<!-- para cada análise do PO -->
<analisePlanoOrcamentario>
<analise>TEXTO DA ANALISE DO PO</analise>
</analisePlanoOrcamentario>
</analisesPlanoOrcamentario>
<perguntasAcompanhamentoPlanoOrcamentario>
<perguntaAcompanhamentoPlanoOrcamentario>
<codigoPergunta>533</codigoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2946</codigoResposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2934</codigoResposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamentoPlanoOrcamentario>
</perguntasAcompanhamentoPlanoOrcamentario>
</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>
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
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
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:
Nome da operação na interface do serviço: consultarAcompanhamentoOrcamentario
Parâmetro(s) de entrada:
| Parâmetro | Tipo(tamanho) | Observações |
| credencial | CredencialDTO | Obrigatório. |
| exercicio | Integer | Exercício da captação física. Obrigatório. |
| periodoOrdem | Integer (1) | 1 para o primeiro período da captação física, 2 para o segundo. Obrigatório. |
| codigoMomento | Integer (4) | Momento da captação física (1000, 2000 ou 4500). Campo opcional |
| filtro | FiltroFuncionalProgramaticaDTO | Preenchimento obrigatório. |
| dataHoraReferencia | Data/Hora | Filtra 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>
<subfuncao>331</subfuncao>
<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>
<justificativa>Análise adicional</justificativa>
<analisesLocalizador/>
<informacoesRegionalizacao/>
<perguntasAcompanhamentoLocalizador/>
<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>
<reprogramado>10</reprogramado>
<limite>5</limite>
<analisesPlanoOrcamentario/>
<perguntasAcompanhamentoPlanoOrcamentario/>
</acompanhamentoPlanoOrcamentario>
</acompanhamentosPlanoOrcamentario>
</acompanhamentoLocalizador>
</acompanhamentosLocalizadores>
</acompanhamentoAcao>
</acompanhamentosAcoes>
</return>
</ns2:consultarAcompanhamentoOrcamentarioResponse>
</env:Body>
</env:Envelope>
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>
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>
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
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
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
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
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>
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>
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
Nome da operação na interface do serviço: obterPerguntasAcompanhamentoOrcamentario
Parâmetro(s) de entrada:
| Atributo | Tipo(tamanho) | Observações |
| credencial | CredencialDTO | |
| exercicio | Inteiro | |
| periodo | Inteiro | 1 – Jan-Jun, 2 – Jan-Dez |
Tipo de Retorno: RetornoPerguntasAcompanhamentoOrcamentarioDTO
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:obterPerguntasAcompanhamentoOrcamentario>
<credencial>
<perfil>32</perfil>
<senha>**</senha>
<usuario>**</usuario>
</credencial>
<exercicio>2020</exercicio>
<periodo>2</periodo>
</ser:obterPerguntasAcompanhamentoOrcamentario>
</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:obterPerguntasAcompanhamentoOrcamentarioResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
<return>
<sucesso>true</sucesso>
<perguntasAcompanhamento>
<perguntaAcompanhamento>
<codigoPergunta>522</codigoPergunta>
<pergunta>Alteração em normativos(leis, regimentos, decretos etc.) impactou o alcance da meta física?</pergunta>
<tipoPergunta>Objetiva</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2883</codigoResposta>
<resposta>Sim</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2884</codigoResposta>
<resposta>Não</resposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamento>
<perguntaAcompanhamento>
<codigoPergunta>524</codigoPergunta>
<pergunta>Em relação ao planejamento para o período, aponte qual fator a seguir mais impactou o alcance da meta física.</pergunta>
<tipoPergunta>Objetiva de múltipla escolha</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2887</codigoResposta>
<resposta>Planos estratégicos, planejamento setorial ou definição de prioridades.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2888</codigoResposta>
<resposta>Medidas de gestão de riscos e garantia de continuidade e dos serviços essenciais.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2889</codigoResposta>
<resposta>Medidas de racionalização ou redução de gastos e de custos.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2890</codigoResposta>
<resposta>Análise e elaboração de projetos.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2891</codigoResposta>
<resposta>Outros - descrever.</resposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamento>
<perguntaAcompanhamento>
<codigoPergunta>528</codigoPergunta>
<pergunta>Quais fatores contratuais mais influenciaram o alcance da meta no período?</pergunta>
<tipoPergunta>Objetiva de resposta múltipla com ordenação</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2905</codigoResposta>
<resposta>Licitação deserta ou fracassada, empresa irregular, liberação de atas de registros de preços, decisão judicial etc.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2906</codigoResposta>
<resposta>Ausência ou reprovação de propostas de convênios.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2907</codigoResposta>
<resposta>Documentação: liberação de licença ambiental, alvarás, registros etc.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2908</codigoResposta>
<resposta>Imóvel: liberação do terreno, aquisição, desapropriação etc.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2909</codigoResposta>
<resposta>Agilização do processo de aquisição, antecipação de demandas ou dos procedimentos para novos editais.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2910</codigoResposta>
<resposta>Alterações no cronograma ou nos custos, aditivo contratual, reajuste nos valores, variação cambial.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2911</codigoResposta>
<resposta>Situação da contratação: em andamento, suspensa, cancelada, em revisão, acordo judicial, contrato emergencial.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2912</codigoResposta>
<resposta>Outros - descrever.</resposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamento>
<perguntaAcompanhamento>
<codigoPergunta>533</codigoPergunta>
<pergunta>Quanto à definição e mensuração da meta física, quais dos pontos a seguir foram mais comumente verificados no período?</pergunta>
<tipoPergunta>Objetiva de resposta múltipla</tipoPergunta>
<respostasAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2933</codigoResposta>
<resposta>Erro na projeção ou na reprogramação da meta física; meta superestimada ou subestimada.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2934</codigoResposta>
<resposta>Ausência de relação direta entre a execução física e a financeira.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2935</codigoResposta>
<resposta>Meta varia em função do número de usuários ou beneficiários, da remuneração do servidor, das aposentadorias, exonerações e outros.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2936</codigoResposta>
<resposta>A meta é não cumulativa, portanto foi definida em função da média do período.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2937</codigoResposta>
<resposta>Erro no preenchimento ou na apuração da meta física.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2938</codigoResposta>
<resposta>Apuração da meta contabilizou a execução com recursos de RAP.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2939</codigoResposta>
<resposta>Apuração da meta contabilizou a execução financeira em outra funcional-programática, devido a alteração na programação.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2940</codigoResposta>
<resposta>Apuração da meta contabilizou os resultados obtidos por meio de ações em parceria com atores externos.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2941</codigoResposta>
<resposta>Apuração da meta contabilizou os resultados realizados às expensas do servidor ou atividades executadas por servidores do quadro, sem custo adicional.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2942</codigoResposta>
<resposta>Projeto recente, sem tempo hábil para a primeira medição.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2943</codigoResposta>
<resposta>Projeto plurianual, com desembolso vinculado à execução das etapas previstas no cronograma físico-financeiro.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2944</codigoResposta>
<resposta>Meta contabilizada na efetivação do contrato de repasse, mesmo não havendo liquidação, ou obtida em relação ao valor pago, quando deveria ser o liquidado.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2945</codigoResposta>
<resposta>O realizado físico do RAP foi calculado considerando-se a proporcionalidade em relação à execução financeira.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2946</codigoResposta>
<resposta>O reprogramado físico do PO da regra de ouro (ROxx) foi calculado considerando-se a proporcionalidade em relação ao financeiro.</resposta>
</respostaAcompanhamento>
<respostaAcompanhamento>
<codigoResposta>2947</codigoResposta>
<resposta>Outros - descrever.</resposta>
</respostaAcompanhamento>
</respostasAcompanhamento>
</perguntaAcompanhamento>
</perguntasAcompanhamento>
</return>
</ns2:obterPerguntasAcompanhamentoOrcamentarioResponse>
</env:Body>
</env:Envelope>
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
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
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
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
| Atributo | Tipo(tamanho) | Observações |
| tipoCaptacao | Character (35) | Descrição do tipo de captação dos registros, por localizador ou plano orçamentário |
| exercicio | Integer (4) | Exercício da captação física. |
| periodo | Varchar (80) | Descrição do período da captação física |
| momentoId | Integer | Código do momento |
| momento | Varchar (150) | Descrição do momento |
| esfera | Character (2) | Código da esfera orçamentária. |
| orgao | Character (5) | Código do órgão orçamentário. |
| descricaoOrgao | Varchar (110) | Descrição do órgão orçamentário. |
| uo | Character (5) | Código da unidade orçamentária. |
| descricaoUo | Varchar (110) | Descrição da unidade orçamentária. |
| orgaoSiorg | Varchar (6) | Código do Orgão Siorg |
| descricaoSiorg | Varchar (110) | Descrição do Órgão Siorg |
| funcao | Character (2) | Código da função. |
| descricaoFuncao | Varchar (120) | Descrição da função. |
| subfuncao | Character (3) | Código da Subfunção. |
| descricaoSubFuncao | Varchar (120) | Descrição da Subfunção. |
| programa | Character (4) | Código do programa. |
| tituloPrograma | Varchar (255) | Título do programa. |
| acao | Character (4) | Código da ação. |
| tituloAcao | Varchar (255) | Título da ação. |
| produto | Integer (4) | Código do produto. Referencia ao atributo codigoProduto em produtoDTO. |
| unidadeMedida | Character (10) | Unidade de medida do produto da ação |
| descricaoUnidadeMedida | Varchar (80) | Descrição da unidade de medida do produto da ação |
| localizador | Character (4) | Código do localizador. |
| descricaoLocalizador | Varchar (255) | Descrição do localizador. |
| quantidadeMetaLOA | Numeric (16,2) | Quantidade física da proposta quantitativa no momento LOA (8000) |
| dotacaoInicial | Numeric (16,2) | Valor financeiro da proposta orçamentária no momento LOA (8000). |
| dotacaoAtual | Numeric (16,2) | Valor financeiro da proposta orçamentária corrente. |
| liquidado | Numeric (16,2) | Valor liquidado oriundo do SIAFI . |
| reprogramadoFisico | Numeric (16,2) | Quantidade física reprogramada |
| reprogramadoFinanceiro | Numeric (16,2) | Valor financeiro reprogramado |
| realizadoLOA | Numeric (16,2) | Quantidade realizada em relação a meta LOA |
| pago | Numeric (16,2) | Valor pago oriundo do SIAFI. |
| liquidadoRAP | Numeric (16,2) | Valor liquidado por inscrição de RAP. |
| realizadoRAP | Numeric (16,2) | Valor realizado de RAP. |
| codigoPO | Character (4) | Código do plano orçamentário. |
| tituloPO | Varchar (255) | Título do plano orçamentário. |
| produtoPO | Integer (4) | Código do produto do plano orçamentário. Referencia ao atributo codigoProduto em produtoDTO. |
| unidadeMedidaPO | Character (10) | Unidade de medida do produto do plano orçamentário |
| descricaoUnidadeMedidaPO | Varchar (80) | Descrição da unidade de medida do produto do plano orçamentário |
| quantidadeMetaLOAPO | Numeric (16,2) | Meta física inicial do plano orçamentário |
| quantidadeMetaAtualPO | Numeric (16,2) | Meta física do plano orçamentário atualizada |
| dotacaoInicialPO | Numeric (16,2) | Dotação inicial do plano orçamentário |
| dotacaoAtualPO | Numeric (16,2) | Dotação atual do plano orçamentário |
| liquidadoPO | Numeric (16,2) | Valor liquidado do plano orçamentário |
| realizadoPO | Numeric (16,2) | Valor realizado em relação a meta LOA do plano orçamentário |
| pagoPO | Numeric (16,2) | Valor pago do plano orçamentário |
| liquidadoRAPPO | Numeric (16,2) | Valor liquidado por inscrição de RAP do plano orçamentário |
| descricaoProduto | Varchar (80) | Descrição do produto |
| descricaoProdutoPO | Varchar (80) | Descrição do produto intermediário (produto do plano orçamentário) |
| Atributo | Tipo(tamanho) | Observações |
| periodoOrdem | Inteiro(1) | |
| exercicio | Inteiro(4) | Exercício da captação física. |
| codigoMomento | Inteiro(4) | |
| esfera | Texto(2) | Código da esfera orçamentária. |
| unidadeOrcamentaria | Texto(5) | Código do órgão orçamentário. |
| funcao | Texto(2) | Código da função. |
| subFuncao | Texto(3) | Código da Subfunção. |
| programa | Texto(4) | Código do programa. |
| acao | Texto(4) | Código da ação. |
| codigoTipoInclusaoAcao | Inteiro(1) | Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário. |
| acompanhamentosLocalizadores | Lista de AcompanhamentoOrcamentarioLocalizadorDTO | |
| snPendencia | Boolean | Indica a ocorrência de pendências na captação. Este é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento. |
| dataHoraAlteracao | Data | Este é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento. |
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.
| Atributo | Tipo(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 |
| reprogramado | Long | Execução física Reprogramada para o exercício. |
| realizadoLOA | Long | Execução física realizada. |
| realizadoRAP | Long | Execução física realizada para Restos a Pagar Não Processados. |
| limite | Double | Reprogramado Financeiro(limite de empenho) |
| justificativa | Texto(2000) | A partir de 2020, esse campo corresponde à Análise Adicional do localizador. |
| dataApuracaoLOA | Data | Data de apuração da execução física. |
| dataApuracaoRAP | Data | Data de apuração da execução física para Restos a Pagar Não Processados. |
| meta | Long | Meta física do localizador. Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| dotacaoAtual | Long | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| dotacaoInicial | Long | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| empenhado | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| liquidado | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| pago | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| rapInscritoLiquido | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Inscrito Líquido. |
| rapLiquidadoAPagar | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Liquidado a Pagar. |
| rapPago | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Pago. |
| rapLiquidadoEfetivo | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. Valor de Restos A Pagar Não Processados Liquidado Efetivo. |
| analisesLocalizador | Lista de AnaliseAcompanhamentoOrcamentarioDTO | Contém os comentários analíticos sobre o acompanhamento. Pelo menos uma análise deve ser preenchida. |
| informacoesRegionalizacao | Lista de AcompanhamentoOrcamentarioRegionalizacaoDTO | As informações sobre a regionalização devem ser preenchidos nos localizadores nacionais (região Nacional) das ações marcadas com snRegionalizarNaExecucao. |
| perguntasAcompanhamentoLocalizador | Lista de PerguntaAcompanhamentoOrcamentarioDTO | Contém as respostas às perguntas do questionário que substituiu o campo Análise a partir da captação JAN-DEZ 2020 |
| acompanhamentosPlanoOrcamentario | Lista de AcompanhamentoPlanoOrcamentarioDTO | Contém os acompanhamentos dos Planos Orçamentários (PO). Pode ser preenchido quando um dos POs possuir meta fisica estabelecida. |
| Atributo | Tipo(tamanho) | Observações |
| planoOrcamentario | Texto(4) | Código do plano orçamentário. |
| realizadoLOA | Long | Execução física realizada. |
| dataApuracaoLOA | Data | Data de apuração da execução física. |
| reprogramado | Long | Execução física Reprogramada para o exercício. |
| limite | Double | Reprogramado Financeiro(limite de empenho) |
| descricaoProduto | Texto | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| descricaoUnidadeMedida | Texto | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| titulo | Texto | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| dotacaoAtual | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| empenhado | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| liquidado | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| pago | Double | Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| meta | Long | Meta física do PO. Somente retorno. Não deve ser preenchido no cadastro de acompanhamento. |
| analisesPlanoOrcamentario | Lista de AnaliseAcompanhamentoOrcamentarioDTO | Neste 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. |
| perguntasAcompanhamentoPlanoOrcamentario | Lista de PerguntaAcompanhamentoOrcamentarioDTO | Contém as respostas às perguntas do questionário que substituiu o campo Análise a partir da captação JAN-DEZ 2020 |
| Atributo | Tipo(tamanho) | Observações |
| periodoOrdem | Inteiro(1) | |
| analise | Texto(5000) | |
| nomeUsuario | Texto(255) | Usado apenas no retorno de operações de consulta. |
| ultimaModificacao | Data | Usado apenas no retorno de operações de consulta. |
| Atributo | Tipo(tamanho) | Observações |
| codigoRegiao | int | Código da Região (ver RegiaoDTO - WSQualitativo) |
| uf | Texto(2) | Sigla da UF |
| municipio | Texto(7) | Código IBGE do município com 7 dígitos |
| recorteGeograficoId | int | Código do Recorte Geográfico (ver RecorteGeograficoDTO - WSQualitativo) |
| liquidado | Numeric (16,2) | valor liquidado para esta regionalização da execução |
| realizado | Long | meta realizada para esta regionalização da execução |
| comentario | Texto(5000) | |
| nomeUsuario | Texto(255) | Usado apenas no retorno de operações de consulta. |
| ultimaModificacao | Data | Usado apenas no retorno de operações de consulta. |
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.
| Atributo | Tipo(tamanho) | Aceita Nulo? | Observações |
| usuario | Texto | Não | Login do usuário no SIOP |
| senha | Texto | Não | Hash MD5 da senha do usuário no SIOP |
| perfil | Inteiro | Sim (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. |
| Atributo | Tipo(tamanho) | |
| exercicio | Integer | |
| codAutor | Integer | |
| decisaoParecerId | Integer | |
| emendaNumero | Integer | |
| emenda | Integer | |
| valorSuplementacao | Long | |
| valorCancelamento | Long |
| Atributo | Tipo(tamanho) | Descrição |
| anoReferencia | Integer(4) | Ano de referência, diferente do ano de execução nos casos de restos a pagar. |
| anoExercicio | Integer(4) | Ano de exercício, representa o ano de execução. |
| unidadeGestoraResponsavel | varchar(6) | |
| planoInterno | varchar(11) | Código do plano interno. |
| esfera | varchar(2) | Código da esfera. |
| unidadeOrcamentaria | varchar(5) | Código da unidade orçamentária. |
| funcao | varchar(2) | Código da função. |
| subFuncao | varchar(3) | Código da subfunção. |
| programa | varchar(4) | Código do programa. |
| acao | varchar(4) | Código da ação. |
| localizador | varchar(4) | Código do localizador. |
| planoOrcamentario | varchar(4) | Código do plano orçamentário. |
| natureza | varchar(8) | Código da natureza de despesa. |
| categoriaEconomica | varchar(1) | Código da categoria econômica. |
| grupoNaturezaDespesa | varchar(1) | Código do grupo de natureza de despesa. |
| modalidadeAplicacao | varchar(2) | Código da modalidade de aplicação. |
| elementoDespesa | varchar(2) | Código do elemento de despesa. |
| subElementoDespesa | varchar(2) | Código do subelemento de despesa. |
| idOc | varchar(4) | Código do identificador de doação e operações de crédito. |
| idUso | varchar(1) | Código do identificador de uso. |
| fonte | varchar(4) | Código da fonte de recursos. |
| resultadoPrimarioLei | varchar(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. |
| resultadoPrimarioAtual | varchar(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. |
| tipoCredito | varchar(1) | é a origem (tipo de inclusão) da ação. Domínio: A = LOA, C = Crédito Especial, G = Crédito Extraordinário. |
| origem | varchar(5) | |
| tipoApropriacaoPO | varchar(1) | |
| tematicaPO | varchar(1) | indica se o PO está associado a algum recorte temático do orçamento. |
| acompanhamentoPO | varchar(1) | Código do acompanhamento (Plano Orçamentário). |
| identificadorAcompanhamentoPO | varchar(2) | Código do identificador de acompanhamento (Plano Orçamentário). |
| detalheAcompanhamentoPO | varchar(2) | Código do detalhe de acompanhamento (Plano Orçamentário). |
| autorizado | BigDecimal | |
| projetoLei | BigDecimal | |
| dotacaoAntecipada | BigDecimal | |
| dotacaoInicial | BigDecimal | |
| dotInicialSiafi | BigDecimal | |
| dotAtual | BigDecimal | |
| empLiquidado | BigDecimal | |
| empenhadoALiquidar | BigDecimal | |
| pago | BigDecimal | |
| disponivel | BigDecimal | |
| indisponivel | BigDecimal | |
| rapInscritoProcessado | BigDecimal | |
| rapExerciciosAnteriores | BigDecimal | |
| rapCanceladosNaoProcessados | BigDecimal | |
| rapCanceladosProcessados | BigDecimal | |
| rapAPagarNaoProcessado | BigDecimal | |
| rapAPagarProcessado | BigDecimal | |
| rapPagoNaoProcessado | BigDecimal | |
| rapPagoProcessado | BigDecimal | |
| rapInscritoNaoProcessado | BigDecimal | |
| rapNaoProcessadoBloqueado | BigDecimal | |
| rapNaoProcessadoALiquidar | BigDecimal | |
| rapNaoProcessadoLiquidadoAPagar | BigDecimal | |
| creditoContidoSOF | BigDecimal | |
| bloqueadoSOF | BigDecimal | |
| bloqueadoRemanejamento | BigDecimal | |
| executadoPorInscricaoDeRAP | BigDecimal | Corresponde ao ajuste anual, presente no SIAFI, de despesas executadas por inscrição em restos a pagar. |
| numeroptres | String | Programa de Trabalho Resumido. |
| numeroemenda | String | Autor e número da emenda individual ou de bancada estadual. |
| Atributo | Tipo(tamanho) | Observações |
| exercicio | Inteiro(4) | Obrigatório. |
| esfera | Texto(2) | Código da esfera orçamentária. |
| unidadeOrcamentaria | Texto(5) | Código da unidade orçamentária. |
| funcao | Texto(2) | Código da função. |
| descricaoFuncao | Texto | Descrição da função. |
| subfuncao | Texto(3) | Código da Subfunção. |
| descricaoSubfuncao | Texto | Descrição da Subfunção. |
| programa | Texto(4) | Código do programa. |
| tituloPrograma | Texto | Título do programa. |
| acao | Texto(4) | Código da ação. |
| tituloAcao | Texto | Título da ação. |
| localizador | Texto(4) | Código do localizador. |
| tituloLocalizador | Texto | Título do localizador. |
| ppipac | Booleano | Verdadeiro caso faça parte do ppiPac, falso caso contrário |
| regiao | Texto | |
| uf | Texto | |
| lei | BigDecimal | Dotação da lei (inicial). |
| leiMaisCreditos | BigDecimal | Dotação atual. |
| realizadaJaneiro | BigDecimal | Empenho a liquidar com empenho liquidado em janeiro |
| realizadaFevereiro | BigDecimal | Empenho a liquidar com empenho liquidado somados até fevereiro |
| realizadaMarco | BigDecimal | Empenho a liquidar com empenho liquidado somados até março |
| realizadaAbril | BigDecimal | Empenho a liquidar com empenho liquidado somados até abril |
| realizadaMaio | BigDecimal | Empenho a liquidar com empenho liquidado somados até maio |
| realizadaJunho | BigDecimal | Empenho a liquidar com empenho liquidado somados até junho |
| realizadaJulho | BigDecimal | Empenho a liquidar com empenho liquidado somados até julho |
| realizadaAgosto | BigDecimal | Empenho a liquidar com empenho liquidado somados até agosto |
| realizadaSetembro | BigDecimal | Empenho a liquidar com empenho liquidado somados até setembro |
| realizadaOutubro | BigDecimal | Empenho a liquidar com empenho liquidado somados até outubro |
| realizadaNovembro | BigDecimal | Empenho a liquidar com empenho liquidado somados até novembro |
| realizadaDezembro | BigDecimal | Empenho a liquidar com empenho liquidado somados até dezembro |
| estatalDependente | Boolean | Indica se é uma estatal dependente |
| estatalIndependente | Boolean | Indica se é uma estatal independente |
| Atributo | Tipo(tamanho) | Aceita nulo? | Descrição |
| anoExercicio | Inteiro(4) | Sim, caso anoReferencia seja informado | Ano de exercício, representa o ano de execução. |
| anoReferencia | Inteiro(4) | Sim, caso anoExercicio seja informado | Ano de referência, diferente do ano de execução nos casos de restos a pagar. |
| esferas | Lista de varchar(2) | Sim | Códigos das esferas. |
| unidadesOrcamentarias | Lista de varchar(5) | Sim | Códigos das unidades orçamentárias. |
| funcoes | Lista de varchar(2) | Sim | Códigos das funções. |
| subfuncoes | Lista de varchar(3) | Sim | Códigos das subfunções. |
| programas | Lista de varchar(4) | Sim | Códigos dos programas. |
| acoes | Lista de varchar(4) | Sim | Códigos das ações. |
| localizadores | Lista de varchar(4) | Sim | Códigos dos localizadores. |
| planosOrcamentarios | Lista de varchar(4) | Sim | Códigos dos planos orçamentários. |
| naturezasDespesa | Lista de varchar(8) | Sim | Códigos das naturezas de despesas completos (até subelemento de despesa). |
| categoriasEconomicas | Lista de varchar(1) | Sim | Códigos das categorias econômicas. |
| gruposNatureza | Lista de varchar(1) | Sim | Códigos dos grupos de naturezas de despesa. |
| modalidadesAplicacao | Lista de varchar(2) | Sim | Códigos das modalidades de aplicação. |
| elementosDespesa | Lista de varchar(2) | Sim | Códigos dos elementos de despesa. |
| idusos | Lista de varchar(1) | Sim | Códigos dos identificadores de uso. |
| fontes | Lista de varchar(4) | Sim | Códigos das fontes de recursos. |
| idocs | Lista de varchar(4) | Sim | Códigos dos identificadores de doação e operações de crédito. |
| resultadosPrimariosLei | Lista de varchar(1) | Sim | Códigos dos resultados primários na LOA. |
| resultadosPrimariosAtuais | Lista de varchar(1) | Sim | Códigos dos resultados primários atuais. |
| planosInternos | Lista de varchar(11) | Sim | Códigos dos planos internos. |
| unidadesGestorasResponsaveis | Lista de varchar(6) | Sim | Códigos das unidades gestoras responsáveis. |
| tipoCredito | Lista 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. |
| programacoesSelecionadas | Lista de varchar(1) | Sim | Marcações Programação Selecionada. |
| tiposPrecatorios | Lista de varchar(1) | Sim | Marcadores de Precatório |
| acompanhamentosIntensivos | Lista de varchar(2) | Sim | Marcadores de Acompanhamentos Intensivos |
| tiposApropriacaoPO | Lista de varchar(1) | Sim | Códigos dos tipos de apropriação (Plano Orçamentário) |
| tematicasPO | Lista de varchar(1) | Sim | Códigos das temáticas (Plano Orçamentário) |
| acompanhamentosPO | Lista de varchar(1) | Sim | Códigos dos acompanhamentos (Plano Orçamentário) |
| identificadoresAcompanhamentoPO | Lista de varchar(2) | Sim | Códigos dos identificadores de acompanhamento (Plano Orçamentário) |
| detalhesAcompanhamentoPO | Lista de varchar(2) | Sim | Códigos dos detalhes de acompanhamento (Plano Orçamentário) |
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.
| Atributo | Tipo(tamanho) | Aceita Nulo? | Observações |
| codigoAcao | Texto(4) | Sim | |
| codigoEsfera | Texto(2) | Sim | |
| codigoFuncao | Texto(2) | Sim | |
| codigoLocalizador | Texto(4) | Sim | |
| codigoPrograma | Texto(4) | Sim | |
| codigoSubFuncao | Texto(3) | Sim | |
| codigoTipoInclusaoAcao | Inteiro(1) | Sim | Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário. |
| codigoTipoInclusaoLocalizador | Inteiro(1) | Sim | Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário. |
| codigoUO | Texto(5) | Sim | |
| exercicio | Inteiro(4) | Sim |
A chave única deste DTO deve ser composta também pela chave-única de PropostaDTO.
| Atributo | Tipo(tamanho) | Aceita Nulo? | Observações |
| idUso | Texto(1) | Não | Os valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo. |
| idOC | Texto(4) | Não | Os valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo. |
| naturezaDespesa | Texto(8) | Não | Os valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo. |
| fonte | Texto(3) | Não | Os valores possíveis podem ser recuperados pela operação obterTabelasApoioQuantitativo. |
| resultadoPrimarioLei | Texto(1) | Não | 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. |
| resultadoPrimarioAtual | Texto(1) | Sim | 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. |
| identificadorPlanoOrcamentario | Inteiro | Não | Deve 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). |
| valor | Long | Não | |
| expansaoSolicitada | Long | Sim | |
| expansaoConcedida | Long | Sim | Campo de retorno. |
Este DTO herda os atributos de FinanceiroDTO.
| Atributo | Tipo(tamanho) | Observações |
| emendas | Lista de EmendaDTO |
| Atributo | Tipo(tamanho) | Observações |
| codigoFonte | Texto | |
| exercicio | Inteiro | |
| descricao | Texto | |
| snAtivo | Booleano |
| Atributo | Tipo(tamanho) | Observações |
| codigoIdOc | String | |
| exercicio | Inteiro | |
| descricao | Texto | |
| snAtivo | Booleano |
| Atributo | Tipo(tamanho) | Observações |
| codigoIdUsoDTO | Texto | |
| exercicio | Inteiro | |
| descricao | Texto | |
| snAtivo | Booleano |
| Atributo | Tipo(tamanho) | Observações |
| dataCompetencia | Date | |
| dataFechamentoUltimoMes | Date | |
| tipo | String | |
| ultimaCarga | Date | |
| ultimoMesFechado | String | Formato: AAAA-MM |
| Atributo | Tipo(tamanho) | Observações |
| exercicio | Inteiro | |
| identificadorUnicoLocalizador | Inteiro | |
| codigoMomentoLocalizador | Inteiro | |
| identificadorUnicoAcao | Inteiro | |
| codigoMomentoAcao | Inteiro | |
| funcional | Texto | |
| temProposta | Boolean | |
| codigoMomentoPropostaAtual | Inteiro | |
| propostaValida | Boolean | |
| codigoTipoDetalhamento | Texto(2) | |
| temJanela | Boolean | |
| codigoMomentoJanelaAtual | Inteiro | |
| podeCaptar | Boolean | |
| porQueNaoPodeCaptar | Texto |
| Atributo | Tipo(tamanho) | Observações |
| identificadorUnicoPlanoOrcamentario | Inteiro | O valor desse campo corresponde ao atributo identificadorUnico de PlanoOrcamentarioDTO (não é o código do plano orçamentário). |
| quantidadeFisico | Long | Meta física para o plano orçamentário. |
| expansaoFisicaSolicitada | Long | |
| expansaoFisicaConcedida | Long | Campo de retorno. |
| Atributo | Tipo(tamanho) | Observações |
| codigoNatureza | Texto | |
| exercicio | Inteiro | |
| descricao | Texto | |
| descricaoAbreviada | Texto |
| Atributo | Tipo(tamanho) | Aceita nulo? | Observações |
| exercicio | Inteiro | Não | |
| codigoMomento | Inteiro | Não | |
| codigoTipoDetalhamento | Texto(2) | Sim | |
| codigoOrgao | Texto(5) | Não | |
| codigoUnidadeOrcamentaria | Texto(5) | Sim | |
| captados | Boolean | Sim | Use true para obter somente os localizadores com proposta, false para obter somente os localizadores sem proposta, e nulo para todos. |
| captaveis | Boolean | Sim | Use true para obter apenas os localizadores que estejam aptos a serem captados. Em caso de false ou nulo retorna todos. |
Parâmetros aplicáveis a consultas de execução orçamentária, para filtrar os resultados do serviço.
| Atributo | Tipo(tamanho) | Aceita Nulo? | Observações |
| exercicio | Inteiro(4) | Não | Obrigatório. |
| esfera | Texto | Sim | |
| orgao | Texto | Sim | |
| unidadeOrcamentaria | Texto | Sim | |
| funcao | Texto | Sim | |
| subFuncao | Texto | Sim | |
| programa | Texto | Sim | |
| acao | Texto | Sim | |
| localizador | Texto | Sim |
| Atributo | Tipo(tamanho) | Observações |
| codigoPergunta | Inteiro | Código da pergunta. Lista com valores válidos pode ser obtida através do método obterPerguntasAcompanhamentoOrcamentario. |
| pergunta | Texto | Este é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento. |
| tipoPergunta | Texto | Este é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento. |
| respostasAcompanhamento | Lista de RespostaAcompanhamentoOrcamentarioDTO |
| Atributo | Tipo(tamanho) | Observações |
| codigoResposta | Inteiro | Código da resposta. Lista com valores válidos pode ser obtida através do método ObterPerguntasAcompanhamentoOrcamentario. |
| resposta | Texto | Este é um atributo de saída, não deve ser preenchido no cadastro de acompanhamento. |
| especificacaoResposta | Texto | Utilizado somente para respostas que necessitem de especificação. |
| ordem | Inteiro | Utilizado para perguntas que requerem ordenação entre as respostas. |
Representa a proposta orçamentária para um determinado localizador e tipo de detalhamento.
| Atributo | Tipo(tamanho) | Aceita Nulo? | Observações |
| exercicio | Inteiro | Não | |
| codigoEsfera | Texto(2) | Não | |
| codigoOrgao | Texto(5) | Não | Código da unidade orçamentária. |
| codigoFuncao | Texto(2) | Não | |
| codigoSubFuncao | Texto(3) | Não | |
| codigoPrograma | Texto(4) | Não | |
| codigoAcao | Texto(4) | Não | |
| codigoTipoInclusaoAcao | Numerico(1) | Não | Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário |
| codigoLocalizador | Texto(4) | Não | |
| codigoTipoInclusaoLocalizador | Numerico(1) | Não | Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário |
| codigoMomento | Numerico(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. |
| codigoTipoDetalhamento | Texto(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. |
| snAtual | Boolean | Sim | Campo de retorno |
| quantidadeFisico | Long | Sim | Meta física para o localizador da proposta. |
| valorFisico | Long | Sim | Valor necessário para atingir a meta física, equivale à soma dos financeiros da proposta. |
| financeiros | Lista de FinanceiroDTO | Não | Contém os detalhamentos financeiros da proposta. |
| receitas | Lista de ReceitaDTO | Sim | Utilizado somente nas propostas da esfera 30 (investimentos). |
| metaPlanoOrcamentario | Lista de MetaPlanoOrcamentarioDTO | Sim | justificativaContém as metas físicas dos planos orçamentários que possuam produto associado. |
| justificativa | Texto | Sim | |
| identificadorUnicoAcao | Inteiro | Sim | |
| expansaoFisicaSolicitada | Long | Sim | |
| expansaoFisicaConcedida | Long | Sim | Campo de retorno. |
| justificativaExpansaoSolicitada | String(2500) | Sim | |
| justificativaExpansaoConcedida | String(2500) | Sim | Campo de retorno. |
| Atributo | Tipo(tamanho) | Aceita Nulo? | Observações |
| naturezaReceita | Texto(8) | Não | Código de Natureza de Receita. |
| valor | Long | Não |
| Atributo | Tipo(tamanho) | Observações |
| codigoResultadoPrimario | Texto | |
| exercicio | Inteiro | |
| descricao | Texto |
| Atributo | Tipo(tamanho) | Aceita Nulo? | Descrição |
| anoReferencia | Boolean | Sim | |
| anoExercicio | Boolean | Sim | |
| unidadeGestoraResponsavel | Boolean | Sim | |
| planoInterno | Boolean | Sim | |
| esfera | Boolean | Sim | |
| unidadeOrcamentaria | Boolean | Sim | |
| funcao | Boolean | Sim | |
| subFuncao | Boolean | Sim | |
| programa | Boolean | Sim | |
| acao | Boolean | Sim | |
| localizador | Boolean | Sim | |
| planoOrcamentario | Boolean | Sim | |
| natureza | Boolean | Sim | |
| categoriaEconomica | Boolean | Sim | |
| grupoNaturezaDespesa | Boolean | Sim | |
| modalidadeAplicacao | Boolean | Sim | |
| elementoDespesa | Boolean | Sim | |
| subElementoDespesa | Boolean | Sim | |
| idoc | Boolean | Sim | |
| iduso | Boolean | Sim | |
| fonte | Boolean | Sim | |
| resultadoPrimarioLei | Boolean | Sim | 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. |
| resultadoPrimarioAtual | Boolean | Sim | 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. |
| tipoCredito | Boolean | Sim | é a origem (tipo de inclusão) da ação. Domínio: A = LOA, C = Crédito Especial, G = Crédito Extraordinário. |
| programacaoSelecionada | Boolean | Sim | |
| tipoPrecatorio | Boolean | Sim | |
| tipoApropriacaoPO | Boolean | Sim | |
| tematicaPO | Boolean | Sim | Indica se o PO está associado a algum recorte temático do orçamento. |
| acompanhamentoPO | Boolean | Sim | |
| identificadorAcompanhamentoPO | Boolean | Sim | |
| detalheAcompanhamentoPO | Boolean | Sim | |
| autorizado | Boolean | Sim | |
| projetoLei | Boolean | Sim | |
| dotacaoAntecipada | Boolean | Sim | |
| dotacaoInicial | Boolean | Sim | |
| dotInicialSiafi | Boolean | Sim | |
| dotAtual | Boolean | Sim | |
| empLiquidado | Boolean | Sim | |
| empenhadoALiquidar | Boolean | Sim | |
| pago | Boolean | Sim | |
| disponivel | Boolean | Sim | |
| indisponivel | Boolean | Sim | |
| rapInscritoProcessado | Boolean | Sim | |
| rapExerciciosAnteriores | Boolean | Sim | |
| rapCanceladosNaoProcessados | Boolean | Sim | |
| rapCanceladosProcessados | Boolean | Sim | |
| rapAPagarNaoProcessado | Boolean | Sim | |
| rapAPagarProcessado | Boolean | Sim | |
| rapPagoNaoProcessado | Boolean | Sim | |
| rapPagoProcessado | Boolean | Sim | |
| rapInscritoNaoProcessado | Boolean | Sim | |
| rapNaoProcessadoBloqueado | Boolean | Sim | |
| rapNaoProcessadoALiquidar | Boolean | Sim | |
| rapNaoProcessadoLiquidadoAPagar | Boolean | Sim | |
| creditoContidoSOF | Boolean | Sim | |
| bloqueadoSOF | Boolean | Sim | |
| bloqueadoRemanejamento | Boolean | Sim | |
| mes | Boolean | Sim | Utilizado apenas nas chamadas de consultarExecucaoOrcamentariaMensal |
| numeroptres | Boolean | Sim | |
| numeroemenda | Boolean | Sim |
| Atributo | Tipo(tamanho) | Observações |
| exercicio | Inteiro | |
| codigoEsfera | Texto | |
| codigoUO | Texto | |
| codigoFuncao | Texto | |
| codigoSubFuncao | Texto | |
| codigoPrograma | Texto | |
| codigoAcao | Texto | |
| codigoLocalizador | Texto | |
| codigoTipoInclusaoAcao | Inteiro | |
| codigoTipoInclusaoLocalizador | Inteiro | |
| quantidadeAcrescimo | Numérico | |
| quantidadeReducao | Numérico | |
| listaFinanceiroPedidoAlteracaoDTO | Lista FinanceiroPedidoAlteracaoDTO |
Retornos
| Atributo | Tipo(tamanho) | Observações |
| pagina | Inteiro | Número da página retornada na consulta. Quando utilizado como parâmetro, deve informar o número da página desejada. |
| registrosPorPagina | Inteiro | Número máximo de registros por página. |
| Atributo | Tipo(tamanho) | Observações |
| registros | Lista de AcompanhamentoFisicoFinanceiroDTO | |
| paginacao | PaginacaoDTO | Conté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. |
| dataHoraUltimaCargaSiafi | Data | Data da última atualização dos valores financeiros. |
| Atributo | Tipo(tamanho) | Observações |
| acompanhamentosAcao | Lista de AcompanhamentoOrcamentarioAcaoDTO |
| Atributo | Tipo(tamanho) | Observações |
| naturezas | Lista de NaturezaDespesaDTO | |
| idocs | Lista de IdOcDTO | |
| idUsos | Lista de IdUsoDTO | |
| fontes | Lista de FonteDTO | |
| resultadosPrimarios | Lista de ResultadoPrimarioDTO |
| Atributo | Tipo(tamanho) | Descrição |
| sucesso | Boolean | Indicação de sucesso na execução da operação. |
| mensagensErro | Lista de String | Lista com as mensagens do sistema em caso de sucesso = false. |
| dataHoraUltimaCarga | Date | 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 |
| execucoesOrcamentarias | Lista de ExecucaoOrcamentariaDTO | |
| paginacao | PaginacaoDTO |
| Atributo | Tipo(tamanho) | Observações |
| registros | Lista de ExecucaoOrcamentariaMensalDestDTO |
| Atributo | Tipo(tamanho) | Observações |
| financeiros | Lista de FinanceiroEmendasDTO |
| Atributo | Tipo(tamanho) | |
| registros | Lista de InformacaoCaptacaoPLOADTO |
| Atributo | Tipo(tamanho) | Observações |
| informacoesCargaSiafi | List<InformacaoCargaSiafiDTO> |
| Atributo | Tipo(tamanho) | Observações |
| perguntasAcompanhamento | Lista de PerguntaAcompanhamentoOrcamentarioDTO |
| Atributo | Tipo(tamanho) | Observações |
| sucesso | Booleano | Indica que a operação foi realizada com sucesso. |
| mensagensErro | Lista de Texto | Lista de mensagens de erro, quando sucesso for 'false'. |
| registros | Lista de PropostaDTO | |
| numeroRegistros | Inteiro | Número de registros retornados |
| valorTotal | Long | Valor total dos registros retornados |