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|https://testews.siop.gov.br/services/WSAlteracoesOrcamentarias?wsdl]]|
|Endereço do WSDL - Produção|[[https://siop.planejamento.gov.br/services/WSAlteracoesOrcamentarias?wsdl|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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário|
|exercicio|Numérico|1| |
|identificadorUnico|Numérico|1|Identificador do pedido de alteração.|

**Tipo de Retorno:** RetornoVerificacaoPedidoAlteracaoDTO

**Exemplo:**

Requisição:
<code>

<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>

</code>

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

<code>
<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>

</code>

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

<code>
<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>

</code>

==== 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário|
|exercicio|Numérico|1|Exercício da LOA alterada pelo pedido.|
|identificadorUnico|Numérico|1|Nú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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário|
|pedidoAlteracao|PedidoAlteracaoDTO|1| |

**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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|pedidoAlteracao|PedidoAlteracaoDTO|1|O 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1| |
|identificadorUnico|Numérico|1|Identificador do pedido de alteração.|

**Tipo de Retorno:** RetornoSituacaoTransmissaoSiafiDTO
==== Obter formalização enviada ao Congresso Nacional ====

Operação para consulta de formalizações (grupos de pedido de alteração orçamentária) enviadas ao Congresso Nacional

**Nome da operação na interface do serviço:** obterFormalizacaoEnviadaAoCongreso

**Parâmetro(s) de entrada:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1|Exercício da LOA alterada pela formalização.|
|codigoGrupoPedidoAlteracao|Numérico|1|Número da formalização (grupo de pedidos de alteração).|

**Tipo de Retorno:** RetornoGrupoPedidoAlteracaoDTO
==== 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1|Exercício da LOA alterada pelo pedido.|
|identificadorUnico|Numérico|1|Número de controle do pedido.|
|codigoMomento|Numérico|0-1|Momento 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1|Exercício da LOA alterada pelo pedido.|
|codigoMomento|Numérico|0-1|Momento do pedido de alteração.|
|filtroFuncional|FiltroFuncionalProgramaticaDTO|1|Filtro de consulta.|
|dataHoraUltimaConsulta|Data|0-1|Data 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1|Exercício da LOA alterada pelo pedido.|
|codigoMomento|Numérico|1|Momento do pedido de alteração.|
|descricao|String|1|Descriçã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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|codigoPergunta|Numérico|1| |

**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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|orcamentoInvestimento|boolean|1|Indica 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1| |

**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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1| |
|retornarClassificacoes|Boolean|1|Operação deve retornar as classificações de alterações?|
|retornarTiposAlteracao|Boolean|1|Operação deve retornar os tipos alterações?|
|retornarSituacoesPedidoAlteracao|Boolean|1|Operação deve retornar as situações de pedido?|
|retornarTiposInstrumentoLegal|Boolean|1|Operação deve retornar os tipos de instrumento legal?|
|retornarTiposFonteRecurso|Boolean|1|Operação deve retornar os tipos de fonte de recurso?|
|dataHoraReferencia|Data|0-1|Data 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:**

|Atributo|Tipo|Ocorrência|Observações|
|credencial|CredencialDTO|1|Credencial do usuário.|
|exercicio|Numérico|1| |
|identificadorUnico|Numérico|1|Identificador do pedido de alteração.|

**Tipo de Retorno:** RetornoVerificacaoPedidoAlteracaoDTO

**Exemplo:**

Requisição:
<code>

<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>

</code>

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

<code>
<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>

</code>

Resposta – Caso de sucesso na verificação:

<code>
<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>

</code>

===== 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 ====

|Atributo|Tipo|Ocorrência|Observações|
|__usuario__ |String|1|Login do usuário no SIOP (formado por 3 caracteres).|
|senha|String|1|Hash MD5 da senha do usuário no SIOP.|
|perfil|Integer|0 ou 1|Perfil 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.

|Atributo|Tipo|Ocorrência|Observações|
|__identificadorUnico__ |Integer|1|Número de controle do pedido|
|__exercicio__ |Integer|1|Exercício do LOA que será alterada|
|__codigoMomento__ |Integer|1|Momento do pedido.|
|codigoClassificacaoAlteracao|Integer|1|Classificação da alteração|
|codigoTipoAlteracao|"String(min 3, máx 5)"|1|Tipo da alteração|
|snOrcamentoInvestimento|boolean|0-1|Indica se a alteração é no orçamento de investimento|
|codigoSituacaoPedidoAlteracao|Integer|0-1|Situação do pedido. Atributo de saída.|
|codigoInstrumentoLegal|Integer|0-1|Instrumento legal. Atributo de saída.|
|descricao|String(min 3)|1|Descrição textual (resumida) do pedido.|
|codigoOrgao|String(5)|1|Código do órgão setorial ou unidade orçamentária solicitante.|
|fisicosPedidoAlteracao|LISTA DE FisicoPedidoAlteracaoDTO|>=1| |
|respostasJustificativa|LISTA DE RespostaJustificativaDTO|>=1| |
|nomeUsuarioCriacao|String|0-1|Atributo de saída.|
|loginUsuarioCriacao|String|0-1|Atributo de saída.|
|nomeUsuarioEfetivacao|String|0-1|Atributo de saída.|
|loginUsuarioEfetivacao|String|0-1|Atributo de saída.|
|nomeUsuarioEnvio|String|0-1|Atributo de saída.|
|loginUsuarioEnvio|String|0-1|Atributo de saída.|
|dataCriacao|Data|0-1|Atributo de saída.|
|dataEfetivacao|Data|0-1|Atributo de saída.|
|dataEnvio|Data|0-1|Atributo de saída.|
|snIntegracao|Boolean|0-1|Atributo de saída.|
|snAtual|Boolean|0-1|Atributo de saída.|
|snExclusaoLogica|Boolean|0-1|Atributo de saída.|
|snAgregadora|Boolean|0-1|Atributo de saída.|
|snEnviadoCongressoNacional|Boolean|0-1|Atributo de saída.|
|snEmValidacaoExterna|Boolean|0-1|Atributo de saída.|
|identificadorUnicoPedidoAgregador|Integer|0-1|Atributo de saída.|
|identificadorUnicoPedidoOrigem|Integer|0-1|Atributo 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).

|Atributo|Tipo|Ocorrência|Observações|
|__exercicio__ |Integer|1|Exercício do LOA que será alterada|
|__codigoEsfera__ |String(2)|1|Esfera orçamentária.|
|__codigoUO__ |String(5)|1|Código da unidade orçamentária da programação a ser alterada.|
|__codigoFuncao__ |String(2)|1|Função.|
|__codigoSubFuncao__ |String(3)|1|Subfunção|
|__codigoPrograma__ |String(4)|1|Código do programa.|
|__codigoAcao__ |String(4)|1|Código da ação.|
|__codigoLocalizador__ |String(4)|1|Código do localizador.|
|__codigoTipoInclusaoLocalizador__ |Integer|1|Tipo de inclusão (origem) do localizador. Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário|
|quantidadeAcrescimo|Long|1| |
|quantidadeReducao|Long|1| |
|listaFinanceiroPedidoAlteracaoDTO|LISTA de FinanceiroPedidoAlteracaoDTO.| | |
|codigoTipoInclusaoAcao|Integer|Tipo 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).

|Atributo|Tipo|Ocorrência|Observações|
|__codigoFonte__ |String(3)|1| |
|__codigoIdOc__ |String(4)|1| |
|__codigoIdUso__ |String(1)|1| |
|__codigoNatureza__ |String(8)|1| |
|__codigoRP__ |String(1)|1| |
|__codigoRPLei__ |String(1)|1| |
|__planoOrcamentario__ |String(4)|1| |
|codigoTipoFonteRecurso|Integer|1| |
|valorSuplementacao|Long|0-1|Valor de suplementação (ou bloqueio).|
|valorCancelamento|Long|0-1|Valor de cancelamento (ou desbloqueio).|
|fisicoFinanceiroEmendaOrigemPedidoAlteracaoDTO|LISTA de FisicoFinanceiroEmendaOrigemPedidoAlteracaoDTO.|1|Financeiro 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.

|Atributo|Tipo|Ocorrência|Observações|
|__codigoEsfera__ |String(2)|1|Esfera orçamentária.|
|__codigoUO__ |String(5)|1|Código da unidade orçamentária da programação a ser alterada.|
|__codigoFuncao__ |String(2)|1|Função.|
|__codigoSubFuncao__ |String(3)|1|Subfunção|
|__codigoPrograma__ |String(4)|1|Código do programa.|
|__codigoAcao__ |String(4)|1|Código da ação.|
|__codigoLocalizador__ |String(4)|1|Código do localizador.|
|__codigoTipoInclusaoLocalizador__ |Integer|1|Tipo de inclusão (origem) do localizador. Valores válidos: 1 - PLOA, 2 - Emenda, 4 - PPA, 5 - Crédito Especial, 6 - Crédito Extraordinário|
|__financeiroPedidoAlteracaoDTO__ |FinanceiroPedidoAlteracaoDTO|1|FinanceiroPedidoAlteracaoDTO da origem da suplementação. Financeiro que foi cancelado.|
|__codigoEmendaOrigem__ |Integer|1|Composto do código do autor da emenda, quatro caracteres, mais quatro caracteres do número da emenda, AAAAEEEE|

==== GrupoPedidoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|codigoGrupoPedidoAlteracao|Integer|1|Número do grupo de pedido de alteração|
|exercicio|Integer|1|Exercício do grupo de pedido de alteração|
|descricao|String|1|Descrição|
|snEnviadoCN|Boolean|1|Indica se foi enviado ao Congresso Nacional|
|snEmValidacaoExterna|Boolean|1|Indica se está em validação externa (fora da SOF)|
|snEfetivado|Boolean|1|Indica se o grupo foi efetivado. Ou seja, se foi publicado|
|snExclusaoLogica|Boolean|1|Indica se o grupo está excluído|
|dataCriacao|Date|1|Data da criação|
|dataEfetivacao|Date|0|Data da efetivação|
|codigoInstrumentoLegal|Integer|1|Código do instrumento legal que o tornou público|
|dataEnvioValidacaoExterna|Date|0|Data de envio para validação externa|
|dataEnvioCN|Date|0|Data de envio ao Congresso Nacional|
|codigoClassificacaoAlteracao|Integer|1|Classificação da alteração orçamentária|
|fisicosAgregados|LISTA DE FisicoPedidoAlteracaoDTO|0|Localizadores e metas físicas que compõem o grupo|

==== RespostaJustificativaDTO ====

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

|Atributo|Tipo|Ocorrência|Observações|
|__codigoPergunta__ |Integer|1| |
|resposta|String|1| |

==== PerguntaJustificativaDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|codigoPergunta|Integer|1| |
|pergunta|String|1| |

==== FiltroFuncionalProgramaticaDTO ====

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

|Atributo|Tipo|Ocorrência|Observações|
|codigoEsfera|String| | |
|codigoUO|String| | |
|codigoFuncao|String| | |
|codigoSubFuncao|String| | |
|codigoPrograma|String| | |
|codigoAcao|String| | |
|codigoTipoInclusaoAcao|Integer(1)| | |
|codigoLocalizador|String| | |
|codigoTipoInclusaoLocalizador|Integer(1)| | |

==== ClassificacaoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|__codigoClassificacaoAlteracao__ |Integer| | |
|descricao|String| | |
|snAtivo|Boolean| | |
|snTipoCredito|Boolean| | |

==== SaldosBloqueioDotacaoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|__anoExercicio__ |Integer| | |
|__anoReferencia__ |Integer| | |
|__codigoEsfera__ |String| | |
|__codigoUnidadeOrcamentaria__ |String| | |
|__codigoFuncao__ |String| | |
|__codigoSubFuncao__ |String| | |
|__codigoPrograma__ |String| | |
|__codigoAcao__ |String| | |
|__codigoLocalizador__ |String| | |
|__categoriaEconomica__ |String| | |
|__grupoNaturezaDespesa__ |String| | |
|__modalidadeDeAplicacao__ |String| | |
|__codigoFonte__ |String| | |
|__codigoIdOC__ |String| | |
|__codigoIdUso__ |String| | |
|__codigoRP__ |String| | |
|__codigoRPLei__ |String| | |
|__planoOrcamentario__ |String| | |
|__tipoCredito__ |String| | |
|__indicadorRap__ |boolean| | |
|__indicadorFuncionalPac__ |boolean| | |
|dotacaoAtual|BigDecimal| | |
|bloqueioAtual|BigDecimal| | |
|saldo|BigDecimal| | |
|dataGeracao|Date| | |
|celula|String| |Concatenação de UO, função, subfunção, programa, ação e localizador.|

==== SituacaoPedidoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|__codigoSituacaoPedidoAlteracao__ |Integer| | |
|descricao|String| | |
|snAtivo|Boolean| | |

==== TabelasApoioPedidoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|esferas|LISTA DE EsferaDTO| |Esferas|
|orgaos|LISTA DE OrgaoDTO| |Órgãos/UOs|
|funcoes|LISTA DE FuncaoDTO| |Funções|
|subFuncoes|LISTA DE SubFuncaoDTO| |Subfunções|
|programas|LISTA DE ProgramaDTO| |Programas|
|acoes|LISTA DE AcaoDTO| |Ações|
|localizadores|LISTA DE LocalizadorDTO| |Localizadores|
|tiposInclusao|LISTA DE TipoInclusaoDTO| |Tipos de inclusão (origem) de ações e localizadores|
|tiposAcao|LISTA DE TipoAcaoDTO| |Tipos de ação|
|produtos|LISTA DE ProdutoDTO| |Produtos|
|unidadesMedida|LISTA DE UnidadeMedidaDTO| |Unidades de medida|
|fontes|LISTA DE FonteDTO| |Fontes|
|idOcs|LISTA DE IdOcDTO| |IDOCs|
|idUsos|LISTA DE IdUsoDTO| |IDUSOs|
|naturezasDespesa|LISTA DE NaturezaDespesaDTO| |Naturezas de despesa|
|rps|LISTA DE ResultadoPrimarioDTO| |RPs|
|planosOrcamentarios|LISTA DE PlanoOrcamentarioDTO| |Planos orçamentários|
|classificacoesAlteracao|LISTA DE ClassificaoAlteracaoDTO| |Classificações de alteração|
|instrumentosLegais|LISTA DE InstrumentoLegalDTO| |Instrumentos legais|
|tiposInstrumentoLegal|LISTA DE TipoInstrumentoLegalDTO| |Tipos de instrumentos legais|

==== TipoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|codigoTipoAcao|String| | |
|descricao|String| | |
|snAtivo|Boolean| | |

==== TipoFonteRecursoDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|__codigoTipoFonteRecurso__ |Integer| | |
|descricao|String| | |

==== TipoInstrumentoLegalDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|__codigoTipoInstrumentoLegal__ |Integer| | |
|descricao|String| | |
|snAtivo|Boolean| | |

==== RetornoSaldosBloqueioPAC ====

|Atributo|Tipo|Ocorrência|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, quando sucesso for 'false'.|
|saldoBloqueioDotacao|LISTA DE SaldoBloqueioDotacaoDTO|0 ou mais| |

==== RetornoPedidoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|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, quando sucesso for 'false'.|
|registros|LISTA DE PedidoAlteracaoDTO|0| |

==== RetornoPedidoPACDTO ====

|Atributo|Tipo|Ocorrência|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, quando sucesso for 'false'.|
|identificadorUnico|Integer|1|Identificador único do pedido criado.|
|ESB|String|1|Identificação da fita SIAFI.|

==== RetornoPerguntaJustificativaDTO ====

|Atributo|Tipo|Ocorrência|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, quando sucesso for 'false'.|
|registros|LISTA DE PerguntaJustificativaDTO|0| |

==== RetornoApoioAlteracoesOrcamentariasDTO ====

|Atributo|Tipo|Ocorrência|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, quando sucesso for 'false'.|
|classificacoesAlteracao|LISTA DE ClassificaoAlteracaoDTO| | |
|tiposAlteracao|LISTA DE TipoAlteracaoDTO| | |
|situacoesPedidoAlteracao|LISTA DE SituacaoPedidoAlteracaoDTO| | |
|tiposInstrumentoLegal|LISTA DE TipoInstrumentoLegalDTO| | |
|tiposFonteRecurso|LISTA DE TipoFonteRecursoDTO| | |

==== RetornoSituacaoTransmissaoSiafiDTO ====

|Atributo|Tipo|Ocorrência|Observações|
|codigoSituacao|String| | |
|descricaoSituacao|String| | |
|ESB|String| | |

==== RetornoVerificacaoPedidoAlteracaoDTO ====

|Atributo|Tipo|Observações|
|sucesso|boolean|Indica 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.|
|verificacoes|VerificacaoPedidoAlteracaoDTO| |

==== RetornoGrupoPedidoAlteracaoDTO ====

|Atributo|Tipo|Ocorrência|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, quando sucesso for 'false'.|
|registros|LISTA DE GrupoPedidoAlteracaoDTO|0|Lista de registros retornados|
|tabelasApoio|TabelasApoioPedidoAlteracaoDTO|0-1|Estrutura contendo todos os cadastros de apoio utilizados pelo grupo de pedido de alteração retornado|

==== VerificacaoPedidoAlteracaoDTO ====

|Atributo|Tipo|Observações|
|regra|String|Descrição da regra de negócio a ser verificada.|
|passou|boolean|Indica se o pedido atende à regra.|
|snInformativa|boolean|Indica se a mensagem é apenas um aviso, quando true, ou um erro, quando false.|
|snConfirmacaoEnvio|boolean|Indica que a verificação exige uma ação de confirmação.|
|detalhes|List<String>|Os detalhes da verificação são retornados nesta lista, exceto quando o pedido atender a todas as regras.|

==== ArquivoAnexoDTO ====

|Atributo|Tipo|Observações|
|arquivo|base64Binary|Representação binária do arquivo codificado em Base 64.|
|nome|String|Nome do arquivo, inclusive com sua extensão.|
|descricao|String|Descrição do arquivo.|