Ferramentas do usuário

Ferramentas do site


webservices:manual-wsalteracoesorcamentarias

Documentação de Serviços de Interoperabilidade

WEB-Service Alterações Orçamentárias

Informações Gerais

Serviço

Nome: Web Service Alterações Orçamentárias do SIOP
Nome na interface: WSAlteracoesOrcamentarias
Início da operação: 29/02/2012
Endereço do WSDL - Testes https://testews.siop.gov.br/services/WSAlteracoesOrcamentarias?wsdl
Endereço do WSDL - Produção https://siop.planejamento.gov.br/services/WSAlteracoesOrcamentarias?wsdl

Objetivo

O Web Service contempla operações que permitem o cadastramento e a consulta das alterações orçamentárias.

Inclui operações também para Desbloqueio do saldo de ações do PAC.

Operações

Enviar pedido de alteração orçamentária

Esta operação faz a verificação do pedido e, em caso de o pedido ter passado por todas as regras de verificação, realiza o envio do pedido para o próximo momento do workflow de Alterações Orçamentárias. Uma lista de verificações é retornada contendo os detalhes das regras não atendidas pelo pedido.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário
exercicioNumérico1
identificadorUnicoNumérico1Identificador do pedido de alteração.

Tipo de Retorno: RetornoVerificacaoPedidoAlteracaoDTO

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:enviarPedidoAlteracao>
       <credencial>
          <perfil>32</perfil>
          <senha>***</senha>
          <usuario>WSMEC</usuario>
       </credencial>
       <exercicio>2014</exercicio>
       <identificadorUnico>32488</identificadorUnico>
    </ser:enviarPedidoAlteracao>
 </soapenv:Body>
</soapenv:Envelope>

Resposta – Caso de falha na verificação do pedido:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:recibo>8B8479D573CFCD77539D3EE01ECA182D</sof:recibo>
 </env:Header>
 <env:Body>
    <ns2:enviarPedidoAlteracaoResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <mensagensErro>O pedido 32488 não foi enviado por não ter passado em todas as verficações.</mensagensErro>
          <sucesso>false</sucesso>
          <verificacoes>
             <verificacao>
                <regra>Janela de trabalho do pedido está aberta?</regra>
                <passou>false</passou>
             </verificacao>
          </verificacoes>
       </return>
    </ns2:enviarPedidoAlteracaoResponse>
 </env:Body>
</env:Envelope>

Resposta – Caso de sucesso na verificação do pedido:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:recibo>8E21D085CF6B008E22814AE23C7C6189</sof:recibo>
 </env:Header>
 <env:Body>
    <ns2:enviarPedidoAlteracaoResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <verificacoes/>
       </return>
    </ns2:enviarPedidoAlteracaoResponse>
 </env:Body>
</env:Envelope>

Excluir pedido de alteração orçamentária

Operação de exclusão de pedido de alteração orçamentária.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário
exercicioNumérico1Exercício da LOA alterada pelo pedido.
identificadorUnicoNumérico1Número de controle do pedido

Tipo de Retorno: RetornoPedidoAlteracaoDTO

Cadastrar pedido de alteração orçamentária

Operação para cadastro e alteração de pedido de alteração orçamentária.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário
pedidoAlteracaoPedidoAlteracaoDTO1

Tipo de Retorno: RetornoPedidoAlteracaoDTO

Cadastrar pedido de (des)bloqueio de saldo de ação do PAC

Operação para cadastro de pedido de bloqueio ou desbloqueio PAC.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
pedidoAlteracaoPedidoAlteracaoDTO1O codigoTipoAlteracao para pedidos de bloqueio/desbloqueio PAC é 950.

Tipo de Retorno: RetornoPedidoPACDTO

Consultar situação de transmissão para o SIAFI

Consulta situção da transmissão da fita Siafi.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1
identificadorUnicoNumérico1Identificador do pedido de alteração.

Tipo de Retorno: RetornoSituacaoTransmissaoSiafiDTO

Obter pedido de alteração orçamentária

Operação de consulta de pedido de alteração orçamentária.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1Exercício da LOA alterada pelo pedido.
identificadorUnicoNumérico1Número de controle do pedido.
codigoMomentoNumérico0-1Momento do pedido de alteração. Se não for informado retorna o pedido no seu momento atual, desde que a credencial informada tenha permissão de consulta nesse momento.

Tipo de Retorno: RetornoPedidoAlteracaoDTO

Obter pedidos de alteração orçamentária

Operação de consulta de pedidos de alteração orçamentária.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1Exercício da LOA alterada pelo pedido.
codigoMomentoNumérico0-1Momento do pedido de alteração.
filtroFuncionalFiltroFuncionalProgramaticaDTO1Filtro de consulta.
dataHoraUltimaConsultaData0-1Data de referência da consulta. Quando informada, a operação retorna apenas pedidos que tenham sido criados ou alterados a partir desta data.

Tipo de Retorno: RetornoPedidoAlteracaoDTO

Obter pedidos de alteração orçamentária por descrição

Operação de consulta de pedidos de alteração orçamentária. A operação retorna a lista de pedidos criados pela credencial e que correspondam aos parâmetros informados (exercicio, momento e descrição).

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1Exercício da LOA alterada pelo pedido.
codigoMomentoNumérico1Momento do pedido de alteração.
descricaoString1Descrição exata do pedido de alteração.

Tipo de Retorno: RetornoPedidoAlteracaoDTO

Obter pergunta de justificativa

Operação de consulta para obtenção da pergunta da justificativa do questionário básico de alterações orçamentárias a partir do seu código.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
codigoPerguntaNumérico1

Tipo de Retorno: RetornoPerguntaJustificativaDTO

Obter perguntas de justificativa

Operação de consulta para obtenção das perguntas de justificativa do questionário básico de alterações orçamentárias.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
orcamentoInvestimentoboolean1Indica se a operação deve trazer as perguntas do questionário de investimentos (true) ou fiscal e seguridade (false).

Tipo de Retorno: RetornoPerguntaJustificativaDTO

Obter saldos das ações do PAC

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1

Tipo de Retorno: RetornoSaldosBloqueioPAC

Obter tabelas de apoio do módulo de alterações orçamentárias

Operação de consulta para obtenção das tabelas de apoio do serviço.

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1
retornarClassificacoesBoolean1Operação deve retornar as classificações de alterações?
retornarTiposAlteracaoBoolean1Operação deve retornar os tipos alterações?
retornarSituacoesPedidoAlteracaoBoolean1Operação deve retornar as situações de pedido?
retornarTiposInstrumentoLegalBoolean1Operação deve retornar os tipos de instrumento legal?
retornarTiposFonteRecursoBoolean1Operação deve retornar os tipos de fonte de recurso?
dataHoraReferenciaData0-1Data de referência da consulta. Quando informada, a operação retorna apenas registros que tenham sido criados ou alterados a partir desta data.

Tipo de Retorno: RetornoApoioAlteracoesOrcamentariasDTO

Verificar pedido de alteração orçamentária

Esta operação faz a verificação do pedido e retorna, em caso de o pedido não ter passado em pelo menos uma verificação, uma lista contendo as regras de todas as verificações realizadas (independente de ter ou não o pedido atendido à regra).

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

Parâmetro(s) de entrada:

AtributoTipoOcorrênciaObservações
credencialCredencialDTO1Credencial do usuário.
exercicioNumérico1
identificadorUnicoNumérico1Identificador do pedido de alteração.

Tipo de Retorno: RetornoVerificacaoPedidoAlteracaoDTO

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:enviarPedidoAlteracao>
       
	<credencial>
          <perfil>32</perfil>
          <senha>46e13e5b3e289bb88b9bb24d29c5706d</senha>
          <usuario>WSMEC</usuario>
       </credencial>
       
       <exercicio>2014</exercicio>
       <identificadorUnico>32488</identificadorUnico>
       
    </ser:enviarPedidoAlteracao>
 </soapenv:Body>
</soapenv:Envelope>

Resposta – Caso de pendência na verificação:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:recibo>8C091591383C1DD5F5E8F40743FDE47F</sof:recibo>
 </env:Header>
 <env:Body>
    <ns2:verificarPedidoAlteracaoResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso> //<!-- a verificação foi realizada com sucesso, apesar de o pedido não ter passado em todas as verificações. -->//
          <verificacoes>
             <verificacao>
                <regra>Dotações orçamentárias adequadas no Excesso / Superávit?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Janela de trabalho do pedido está aberta?</regra>
                <passou>false</passou>
             </verificacao>
             <verificacao>
                <regra>Saldo considerando empenho e bloqueio?</regra>
                <passou>true</passou>
                <detalhes>
                   <detalhe>10.26298.12.363.2031.8652.0029 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           250.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.0053 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           300.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.0991 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           200.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.3132 P.O.: 0000 natureza: 44400000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           400.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.5058 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           100.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.7002 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           600.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.7004 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           500.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.7006 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           183.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.7008 P.O.: 0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 RP de Lei:2 RP Atual:2 valor cancelado (R$        11.000.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.7008 P.O.: 0000 natureza: 44300000 iduso:0 fonte:112 idoc:9999 RP de Lei:2 RP Atual:2 valor cancelado (R$         4.000.000) excede o bloqueado (R$                 0)</detalhe>
                   <detalhe>10.26298.12.363.2031.8652.7010 P.O.: 0000 natureza: 44400000 iduso:0 fonte:100 idoc:9999 RP de Lei:6 RP Atual:6 valor cancelado (R$           100.000) excede o bloqueado (R$                 0)</detalhe>
                </detalhes>
             </verificacao>
             <verificacao>
                <regra>Custo médio alterado?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Balanceamento entre suplementação e cancelamento de Emendas Individuais(RP 6)?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Fontes balanceadas?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Suplementação maior ou igual ao cancelamento de Emendas Individuais(RP 6) em serviços públicos de saúde(Iduso 6)?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Pedido encontra-se no momento do usuário?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Momento atual?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Justificativa preenchida corretamente?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Cancelamento acima do valor original?</regra>
                <passou>true</passou>
                <detalhes>
                   <detalhe>>> Montantes Disponíveis:</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.0029 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.0053 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.0991 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.3132 P.O.:0000 natureza: 44400000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.5058 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.7002 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.7004 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.7006 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.7008 P.O.:0000 natureza: 44300000 iduso:0 fonte:112 idoc:9999 rp lei:2 rp atual:2): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.7008 P.O.:0000 natureza: 44300000 iduso:0 fonte:100 idoc:9999 rp lei:2 rp atual:2): R$                 0</detalhe>
                   <detalhe>Lei + créditos - cancelado ( 10.26298.12.363.2031.8652.7010 P.O.:0000 natureza: 44400000 iduso:0 fonte:100 idoc:9999 rp lei:6 rp atual:6): R$                 0</detalhe>
                </detalhes>
             </verificacao>
             <verificacao>
                <regra>Fontes Balanceadas?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Dotações adequadas e limites respeitados nos cancelamentos?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Balanceamento entre suplementação e cancelamento (só são consideradas as dotações adequadas para o tipo)?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Balanceamento entre suplementação e cancelamento de Emendas do mesmo Parlamentar?</regra>
                <passou>true</passou>
                <detalhes/>
             </verificacao>
             <verificacao>
                <regra>Há algum localizador com financeiro suplementado e cancelado ao mesmo tempo?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Dotações adequadas e limites respeitados nas suplementações?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Redução abaixo das quantidades de físico?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Cancelamento e/ou suplementação especificados?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Pedido possui Localizadores vinculados?</regra>
                <passou>true</passou>
             </verificacao>
             <verificacao>
                <regra>Cancelamentos em tramitação maior que a dotação atual?</regra>
                <passou>true</passou>
             </verificacao>
          </verificacoes>
       </return>
    </ns2:verificarPedidoAlteracaoResponse>
 </env:Body>
</env:Envelope>

Resposta – Caso de sucesso na verificação:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
 <env:Header>
    <sof:recibo>A08A69556F356C9AA22FB5E14760E324</sof:recibo>
 </env:Header>
 <env:Body>
    <ns2:verificarPedidoAlteracaoResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
       </return>
    </ns2:verificarPedidoAlteracaoResponse>
 </env:Body>
</env:Envelope>

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.

CredencialDTO

AtributoTipoOcorrênciaObservações
usuarioString1Login do usuário no SIOP (formado por 3 caracteres).
senhaString1Hash MD5 da senha do usuário no SIOP.
perfilInteger0 ou 1Perfil com o qual o usuário deseja realizar determinada operação. Não é obrigatório na operação obterTabelasApoioQuantitativo.

PedidoAlteracaoDTO

Estrutura que representa o pedido de alteração orçamentária.

AtributoTipoOcorrênciaObservações
identificadorUnicoInteger1Número de controle do pedido
exercicioInteger1Exercício do LOA que será alterada
codigoMomentoInteger1Momento do pedido.
codigoClassificacaoAlteracaoInteger1Classificação da alteração
codigoTipoAlteracao“String(min 3, máx 5)“1Tipo da alteração
snOrcamentoInvestimentoboolean0-1Indica se a alteração é no orçamento de investimento
codigoSituacaoPedidoAlteracaoInteger0-1Situação do pedido. Atributo de saída.
codigoInstrumentoLegalInteger0-1Instrumento legal. Atributo de saída.
descricaoString(min 3)1Descrição textual (resumida) do pedido.
codigoOrgaoString(5)1Código do órgão setorial ou unidade orçamentária solicitante.
fisicosPedidoAlteracaoLISTA DE FisicoPedidoAlteracaoDTO>=1
respostasJustificativaLISTA DE RespostaJustificativaDTO>=1
nomeUsuarioCriacaoString0-1Atributo de saída.
loginUsuarioCriacaoString0-1Atributo de saída.
nomeUsuarioEfetivacaoString0-1Atributo de saída.
loginUsuarioEfetivacaoString0-1Atributo de saída.
nomeUsuarioEnvioString0-1Atributo de saída.
loginUsuarioEnvioString0-1Atributo de saída.
dataCriacaoData0-1Atributo de saída.
dataEfetivacaoData0-1Atributo de saída.
dataEnvioData0-1Atributo de saída.
snIntegracaoBoolean0-1Atributo de saída.
snAtualBoolean0-1Atributo de saída.
snExclusaoLogicaBoolean0-1Atributo de saída.
snAgregadoraBoolean0-1Atributo de saída.
snEnviadoCongressoNacionalBoolean0-1Atributo de saída.
snEmValidacaoExternaBoolean0-1Atributo de saída.
identificadorUnicoPedidoAgregadorInteger0-1Atributo de saída.
identificadorUnicoPedidoOrigemInteger0-1Atributo de saída.

FisicoPedidoAlteracaoDTO

Os atributos sublinhados se referem à chave única do DTO considerando seu relacionamento com PedidoAlteracaoDTO (FisicoPedidoAlteracaoDTO é sempre usado em uma lista dentro de PedidoAlteracaoDTO).

AtributoTipoOcorrênciaObservações
exercicioInteger1Exercício do LOA que será alterada
codigoEsferaString(2)1Esfera orçamentária.
codigoUOString(5)1Código da unidade orçamentária da programação a ser alterada.
codigoFuncaoString(2)1Função.
codigoSubFuncaoString(3)1Subfunção
codigoProgramaString(4)1Código do programa.
codigoAcaoString(4)1Código da ação.
codigoLocalizadorString(4)1Código do localizador.
codigoTipoInclusaoLocalizadorInteger1Tipo de inclusão (origem) do localizador. Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário
quantidadeAcrescimoLong1
quantidadeReducaoLong1
listaFinanceiroPedidoAlteracaoDTOLISTA de FinanceiroPedidoAlteracaoDTO.
codigoTipoInclusaoAcaoIntegerTipo de inclusão (origem) da ação. Valores válidos: 1 - PLOA, 2 - Emenda, 3 - Crédito Adicional, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário

FinanceiroPedidoAlteracaoDTO

Os atributos sublinhados se referem à chave única do DTO considerando seu relacionamento com FisicoPedidoAlteracaoDTO (FinanceiroPedidoAlteracaoDTO é sempre usado em uma lista dentro de FisicoPedidoAlteracaoDTO).

AtributoTipoOcorrênciaObservações
codigoFonteString(3)1
codigoIdOcString(4)1
codigoIdUsoString(1)1
codigoNaturezaString(8)1
codigoRPString(1)1
codigoRPLeiString(1)1
planoOrcamentarioString(4)1
codigoTipoFonteRecursoInteger1
valorSuplementacaoLong0-1Valor de suplementação (ou bloqueio).
valorCancelamentoLong0-1Valor de cancelamento (ou desbloqueio).
fisicoFinanceiroEmendaOrigemPedidoAlteracaoDTOLISTA de FisicoFinanceiroEmendaOrigemPedidoAlteracaoDTO.1Financeiro e emenda que tiveram a dotação cancelada para que houvesse a suplementação desse financeiro

FisicoFinanceiroEmendaOrigemPedidoAlteracaoDTO

Os atributos sublinhados se referem à chave única do DTO.

AtributoTipoOcorrênciaObservações
codigoEsferaString(2)1Esfera orçamentária.
codigoUOString(5)1Código da unidade orçamentária da programação a ser alterada.
codigoFuncaoString(2)1Função.
codigoSubFuncaoString(3)1Subfunção
codigoProgramaString(4)1Código do programa.
codigoAcaoString(4)1Código da ação.
codigoLocalizadorString(4)1Código do localizador.
codigoTipoInclusaoLocalizadorInteger1Tipo de inclusão (origem) do localizador. Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário
financeiroPedidoAlteracaoDTOFinanceiroPedidoAlteracaoDTO1FinanceiroPedidoAlteracaoDTO da origem da suplementação. Financeiro que foi cancelado.
codigoEmendaOrigemInteger1Composto do código do autor da emenda, quatro caracteres, mais quatro caracteres do número da emenda, AAAAEEEE

RespostaJustificativaDTO

O atributo sublinhados é a chave única do DTO considerando seu relacionamento com PedidoAlteracaoDTO (RespostaJustificativaDTO é sempre usado em uma lista dentro de PedidoAlteracaoDTO).

AtributoTipoOcorrênciaObservações
codigoPerguntaInteger1
respostaString1

PerguntaJustificativaDTO

AtributoTipoOcorrênciaObservações
codigoPerguntaInteger1
perguntaString1

FiltroFuncionalProgramaticaDTO

Este DTO é usado apenas como filtro para consulta de pedidos de alteração.

AtributoTipoOcorrênciaObservações
codigoEsferaString
codigoUOString
codigoFuncaoString
codigoSubFuncaoString
codigoProgramaString
codigoAcaoString
codigoTipoInclusaoAcaoInteger(1)
codigoLocalizadorString
codigoTipoInclusaoLocalizadorInteger(1)

ClassificacaoAlteracaoDTO

AtributoTipoOcorrênciaObservações
codigoClassificacaoAlteracaoInteger
descricaoString
snAtivoBoolean
snTipoCreditoBoolean

SaldosBloqueioDotacaoDTO

AtributoTipoOcorrênciaObservações
anoExercicioInteger
anoReferenciaInteger
codigoEsferaString
codigoUnidadeOrcamentariaString
codigoFuncaoString
codigoSubFuncaoString
codigoProgramaString
codigoAcaoString
codigoLocalizadorString
categoriaEconomicaString
grupoNaturezaDespesaString
modalidadeDeAplicacaoString
codigoFonteString
codigoIdOCString
codigoIdUsoString
codigoRPString
codigoRPLeiString
planoOrcamentarioString
tipoCreditoString
indicadorRapboolean
indicadorFuncionalPacboolean
dotacaoAtualBigDecimal
bloqueioAtualBigDecimal
saldoBigDecimal
dataGeracaoDate
celulaString Concatenação de UO, função, subfunção, programa, ação e localizador.

SituacaoPedidoAlteracaoDTO

AtributoTipoOcorrênciaObservações
codigoSituacaoPedidoAlteracaoInteger
descricaoString
snAtivoBoolean

TipoAlteracaoDTO

AtributoTipoOcorrênciaObservações
codigoTipoAcaoString
descricaoString
snAtivoBoolean

TipoFonteRecursoDTO

AtributoTipoOcorrênciaObservações
codigoTipoFonteRecursoInteger
descricaoString

TipoInstrumentoLegalDTO

AtributoTipoOcorrênciaObservações
codigoTipoInstrumentoLegalInteger
descricaoString
snAtivoBoolean

RetornoSaldosBloqueioPAC

AtributoTipoOcorrênciaObservações
sucessoboolean1Indica que a operação foi realizada com sucesso.
mensagensErroLISTA DE string0Sequência (lista) de mensagens de erro, quando sucesso for 'false'.
saldoBloqueioDotacaoLISTA DE SaldoBloqueioDotacaoDTO0 ou mais

RetornoPedidoAlteracaoDTO

AtributoTipoOcorrênciaObservações
sucessoboolean1Indica que a operação foi realizada com sucesso.
mensagensErroLISTA DE string0Sequência (lista) de mensagens de erro, quando sucesso for 'false'.
registrosLISTA DE PedidoAlteracaoDTO0

RetornoPedidoPACDTO

AtributoTipoOcorrênciaObservações
sucessoboolean1Indica que a operação foi realizada com sucesso.
mensagensErroLISTA DE string0Sequência (lista) de mensagens de erro, quando sucesso for 'false'.
identificadorUnicoInteger1Identificador único do pedido criado.
ESBString1Identificação da fita SIAFI.

RetornoPerguntaJustificativaDTO

AtributoTipoOcorrênciaObservações
sucessoboolean1Indica que a operação foi realizada com sucesso.
mensagensErroLISTA DE string0Sequência (lista) de mensagens de erro, quando sucesso for 'false'.
registrosLISTA DE PerguntaJustificativaDTO0

RetornoApoioAlteracoesOrcamentariasDTO

AtributoTipoOcorrênciaObservações
sucessoboolean1Indica que a operação foi realizada com sucesso.
mensagensErroLISTA DE string0Sequência (lista) de mensagens de erro, quando sucesso for 'false'.
classificacoesAlteracaoLISTA DE ClassificaoAlteracaoDTO
tiposAlteracaoLISTA DE TipoAlteracaoDTO
situacoesPedidoAlteracaoLISTA DE SituacaoPedidoAlteracaoDTO
tiposInstrumentoLegalLISTA DE TipoInstrumentoLegalDTO
tiposFonteRecursoLISTA DE TipoFonteRecursoDTO

RetornoSituacaoTransmissaoSiafiDTO

AtributoTipoOcorrênciaObservações
codigoSituacaoString
descricaoSituacaoString
ESBString

RetornoVerificacaoPedidoAlteracaoDTO

AtributoTipoObservações
sucessobooleanIndica se a operação foi realizada com sucesso, ou seja, que o pedido passou por todas as verificações e, no caso da operação enviarPedidoAlteracao, que o pedido foi enviado para o próximo momento.
verificacoesVerificacaoPedidoAlteracaoDTO

VerificacaoPedidoAlteracaoDTO

AtributoTipoObservações
regraStringDescrição da regra de negócio a ser verificada.
passoubooleanIndica se o pedido atende à regra.
snInformativabooleanIndica se a mensagem é apenas um aviso, quando true, ou um erro, quando false.
snConfirmacaoEnviobooleanIndica que a verificação exige uma ação de confirmação.
detalhesList<String>Os detalhes da verificação são retornados nesta lista, exceto quando o pedido atender a todas as regras.

ArquivoAnexoDTO

AtributoTipoObservações
arquivobase64BinaryRepresentação binária do arquivo codificado em Base 64.
nomeStringNome do arquivo, inclusive com sua extensão.
descricaoStringDescrição do arquivo.