Documentação de Serviços de Interoperabilidade
WEB-Service Acompanhamento da Execução das Empresas Estatais
Serviço
Objetivo
O Web Service contempla serviços que permitem o cadastramento e a consulta dos dados de execução mensal das empresas estatais.
Operações
Consultar execução por órgão e unidade orçamentária
Operação de consulta que retorna os valores de execução por localizador de gasto, para um determinado
órgão ou unidade orçamentária, para um exercício e mês especifico.
Nome da operação na interface do serviço:
consultarExecucao
Parâmetro(s) de entrada:
| Atributo | Tipo | Ocorrência mínima | Observações |
| credencial | CredencialDTO | 1 | Credencial do usuário |
| codigoOrgao | String | 0 | Código de identificação do órgão |
| codigoUnidadeOrcamentaria | String | 0 | Código de identificação da unidade |
| ano | int | 1 | Ano de exercício do orçamento |
| mes | int | 0 | Mês de consulta da execução |
Tipo de Retorno:
RetornoExecucaoEstataisDTO
RetornoExecucaoEstataisDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| sucesso | boolean | 1 | Indica que a operação foi realizada com sucesso. |
| mensagensErro | Lista de string | 0 | Sequência (lista) de mensagens de erro. |
| registros | Lista de ExecucaoOrgaoDTO | 0 | Sequência (lista) dos valores de execução. |
| exercicio | int | 1 | |
ExecucaoOrgaoDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoOrgao | string | 0 | Código do órgão. Equivale ao codigoOrgao de OrgaoDTO (ver WSQualitativo). |
| unidadeOrcamentaria | Lista de ExecucaoUnidadeOrcamentariaDTO | 0 | Lista de objetos de unidade. |
ExecucaoUnidadeOrcamentariaDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoUnidadeOrcamentaria | string | 0 | Código da unidade orçamentária. Equivale ao codigoOrgao de OrgaoDTO (ver WSQualitativo). |
| funcao | Lista de ExecucaoFuncaoDTO | 0 | Lista de objetos de função. |
| receita | Lista de ExecucaoReceitaDTO | 0 | Lista de objetos contendo informações a respeito da receita executadas, para o localizador. |
ExecucaoFuncaoDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoFuncao | string | 0 | |
| subFuncao | Lista de ExecucaoSubFuncaoDTO | 0 | Lista de objetos de subfunção. |
ExecucaoSubFuncaoDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoSubFuncao | string | 0 | |
| programa | Lista de ExecucaoProgramaDTO | 0 | Lista de objetos de programas. |
ExecucaoProgramaDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoPrograma | string | 0 | |
| acao | Lista de ExecucaoAcaoDTO | 0 | Lista de objetos de ações. |
ExecucaoAcaoDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoAcao | string | 0 | |
| localizador | Lista de ExecucaoLocalizadorDTO | 0 | Lista de objetos de Localizador. |
| snEmpreendimentoPPIPAC | boolean | 0 | Marcação PPI/PAC da ação. |
ExecucaoLocalizadorDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoLocalizador | string | 0 | |
| codigoRegiao | string | 0 | Código da região do localizador. |
| despesa | ExecucaoDespesaDTO | 0 | Objeto que encapsula as informações a respeito da despesa executadas para o localizador. |
ExecucaoDespesaDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoIdUso | string | 0 | Código do identificador de uso. |
| codigoNatureza | string | 0 | Código da natureza de despesa. |
| codigoModalidade | string | 0 | Código da modalidade. |
| codigoRP | string | 0 | Código de identificação de resultado primário. |
| dotacaoAtual | long | 0 | Valor da dotação atual (Lei+créditos) do localizador. |
| dotacaoInicial | long | 0 | Valor da dotação inicial (Lei) do localizador. |
| fisicoAtual | long | 0 | Valor físico atual (Lei+créditos) do localizador. |
| fisicoInicial | long | 0 | Valor físico inicial (Lei) do localizador. |
| execucaoMensal | Lista de ExecucaoMensalDTO | - | Lista de objetos que contêm os valores mensais de execução (parâmetro comum). |
ExecucaoReceitaDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoNaturezaReceita | string | 0 | Código da natureza de receita. |
| dotacaoAtual | long | 0 | Valor da dotação atual (Lei+créditos) do localizador. |
| dotacaoInicial | long | 0 | Valor da dotação inicial (Lei) do localizador. |
| execucaoMensal | Lista de ExecucaoMensalDTO | - | Lista de objetos que contêm os valores mensais de execução. |
Captação da execução por unidade orçamentária
Operação de captação (cadastro) dos dados de execução mensais de uma ou várias Unidades
Orçamentárias para um exercício especifico.
Nome da operação na interface do serviço:
incluirExecucao
Parâmetro(s) de entrada:
| Parâmetro | Tipo | Ocorrência mínima | Observações |
| credencial | CredencialDTO | 1 | Credencial do usuário |
| input | inputExecucaoEstataisDTO | 1 | Registro de execução para captação. |
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.
| Atributo | Tipo(tamanho) | Observações |
| usuario | Texto | Login do usuário no SIOP |
| senha | Texto | Hash MD5 da senha do usuário no SIOP |
| perfil | Inteiro | Perfil com o qual o usuário deseja realizar determinada operação. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| exercicio | int | 1 | Exercício para o qual será realizada a inclusão dos dados de execução. |
| registros | Lista de inputExecucaoOrgaoDTO | 0 | Lista de dados de execução para cada órgão setorial. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoOrgao | string | 1 | Código do órgão setorial, composto de 5 caracteres. (Ex: '20000' para a Presidência da República). |
| unidadeOrcamentaria | Lista de inputExecucaoUnidadeOrcamentariaDTO | 0 | Lista de dados de execução para cada Unidade Orçamentária do órgão setorial. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoUnidadeOrcamentaria | string | 1 | Código da Unidade Orçamentária, composto de 5 caracteres. (Ex: '20205' para a Companhia Docas do Ceará - CDC) |
| funcao | Lista de inputExecucaoFuncaoDTO | 0 | Lista de dados de execução da despesa de cada Função da Unidade Orçamentária. |
| receita | Lista de inputExecucaoReceitaDTO | 0 | Lista de dados de execução da receita da Unidade Orçamentária. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoFuncao | string | 1 | Código da Função, composto de 2 caracteres. (Ex: '26' para a Função Transporte) |
| subFuncao | Lista de inputExecucaoSubFuncaoDTO | 1 | Lista de dados de execução da despesa de cada SubFunção da Função. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoSubFuncao | string | 1 | Código da SubFunção, composto de 3 caracteres. (Ex: '782' para a Transporte Rodoviário) |
| programa | Lista de inputExecucaoProgramaDTO | 1 | Lista de dados de execução da despesa de cada Programa da SubFunção. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoPrograma | string | 1 | Código do Programa, composto de 4 caracteres. (Ex: '1353' para a Modernização da Polícia Federal) |
| acao | Lista de inputExecucaoAcaoDTO | 1 | Lista de dados de execução da despesa de cada Ação do Programa. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoAcao | string | 1 | Código da Ação, composto de 4 caracteres. (Ex: '12PJ' para a ação Apoio à Construção do Rodoanel) |
| localizador | Lista de inputExecucaoLocalizadorDTO | 1 | Lista de dados de execução da despesa de cada Localizador da Ação. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoLocalizador | string | 1 | Código do Localizador, composto de 4 caracteres. (Ex: '0001' para Nacional) |
| execucaoMensal | Lista de ExecucaoMensalDTO | 1 | Lista de dados de execução da despesa para cada mês do exercício do Localizador (parâmetro comum). |
| mensagem | string | 0 | Mensagem de retorno da operação de inclusão, com informações sobre a validação dos dados informados. |
| Atributo | Tipo | Ocorrência mínima | Observações |
| codigoNaturezaReceita | string | 1 | Código da Natureza de Receita, composto de 8 caracteres. (Ex: '61100000' para Geração Própria) |
| execucaoMensal | Lista de ExecucaoReceitaMensalDTO | 1 | Lista de dados de execução da receita para cada mês do exercício da Unidade Orçamentária. |
ExecucaoReceitaMensalDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| financeiro | long | 1 | Valor financeiro de execução da receita no mês para a Natureza de Receita. |
| mes | int | 1 | Mês de referencia da execução. |
| mensagem | string | 0 | Mensagem de retorno da operação de inclusão, com informações sobre a validação dos dados informados. |
Tipo de Retorno:
RetornoInputExecucaoEstataisDTO
| Atributo | Tipo | Ocorrência mínima | Observações |
| sucesso | boolean | 1 | Indica que a operação foi realizada com sucesso. |
| mensagensErro | Lista de string | 0 | Sequência (lista) de mensagens de erro. |
| registros | Lista de inputExecucaoOrgaoDTO | 0 | Sequência (lista) dos parâmetros informados para inclusão. |
| exercicio | int | 1 | |