====== WEB-Service Precatórios ======

===== Informações Gerais =====

==== Serviço ====

|Nome:|Web Service Precatórios do SIOP|
|Nome na interface:|WSPrecatorio|
|Início da operação:|Julho/2013|
|Documentação atualizada em:|Março/2025|
|Endereço do WSDL - Testes|[[https://testews.siop.gov.br/services/precatorios/WSPrecatorios?wsdl|https://testews.siop.gov.br/services/precatorios/WSPrecatorios?wsdl]]|
|Endereço do WSDL - Produção|[[https://webservice.siop.gov.br/services/precatorios/WSPrecatorios?wsdl|https://webservice.siop.gov.br/services/precatorios/WSPrecatorios?wsdl]]|

==== Objetivo ====

Registrar anualmente informações de precatórios com seus respectivos beneficiários fornecidas pelos tribunais responsáves por sua definição.

===== Informações detalhadas do serviço =====

==== Considerações gerais sobre parâmetros de entrada ====

Todas operações de entrada têm como um de seus parâmatros uma estrutura de dados com encapsula o login, senha (hash md5 da senha) e perfil do usuário, esta estrutura é definida em CredencialDTO (ver mais adiante).

A credencial é determinante para as respostas dos serviços. Usuários do órgão central, que em princípio têm perfil associado aos demais órgãos, receberão respostas referentes a todos os órgãos, enquanto que os demais órgãos só terão acesso aos itens que tenham relação com as suas unidades.

==== Considerações gerais sobre parâmetros de saída ====

Os tipos de retorno consistem basicamente de um valor booleano que indica o sucesso da operação (se foi executada sem erros), uma lista de strings com as mensagens de erro (caso não tenha sucesso) e a lista de dados que devem ser retornados em caso de sucesso.

==== Considerações sobre a janela de tempo disponível para utilização do serviço ====

O WSPrecatorios é um serviço disponível apenas por períodos de tempo determinados pela Secretaria de Orçamento Federal. Caso o serviço seja utilizado fora desses períodos será retornada mensagem de erro a seguir:

<mensagensErro>Janela para informe de precatórios encontra-se fechada</mensagensErro>

===== Operações =====

==== incluirPrecatorios ====

Método para inclusão de precatórios, espera como entrada as informações de precatórios agrupadas por unidade executada.

=== Parâmetro(s) de entrada ===

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|credencial|credencialDTO|1|Tipo complexo que contem os dados de acesso do usuário ao serviço. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|
|precatorios|precatoriosDTO|1|Tipo complexo que contem os dados dos precatórios agrupados por tribunal. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|

=== Exemplo de XML de entrada: ===
<code>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prec="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <prec:incluirPrecatorios>
       <credencial>
          <perfil>106</perfil>
          <senha>XXXXXXXXXXXXXXXXX</senha>
          <usuario>I08</usuario>
       </credencial>
       <input>
          <exercicio>2023</exercicio>
          <orgaosTribunal>
             <codigoOrgaoTribunal>11101</codigoOrgaoTribunal>
             <unidadeOrcamentariaExecutada>
                <codigoUnidadeExecutada>26236</codigoUnidadeExecutada>
                 <precatorio>
                  <beneficiarios>
                   <participacao>PARTE</participacao>
                   <snPessoaFisica>true</snPessoaFisica>
                   <valor>304097.52</valor>
                  </beneficiarios>
                  <classificacoes>
                   <classificacao>A</classificacao>
                   <valor>304097.52</valor>
                  </classificacoes>
                  <vinculosServidor>
                   <codigoOrgao>24101</codigoOrgao>
                   <valor>304097.52</valor>
                  </vinculosServidor>
                  <dataAjuizamento>2004-09-22</dataAjuizamento>
                  <dataTransitadoJulgado>2004-09-22</dataTransitadoJulgado>
                  <dataAutuacao>2005-05-30</dataAutuacao>
                  <dataTransitadoJulgadoExecucao>2025-01-01</dataTransitadoJulgadoExecucao>
                  <dataBase>2020-01-01</dataBase>
		  <valorDataBase>300000</valorDataBase>    
                  <numProcessoUnico>0000456-78.9012.3.45.6789</numProcessoUnico>
                  <numPrecatorio>XXXXXXXXXX</numPrecatorio>
                  <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                  <valor>304097.52</valor>
                  <tipoDespesa>11</tipoDespesa>
                  <numAcaoOrig>aaaaaaaaaaa</numAcaoOrig>
                  <numProcessoExecucao>bbbbbbbbbb</numProcessoExecucao>
                  <vara>XXXX</vara>
                  <varaDescricao>Vara descrição</varaDescricao>
                  <tributario>false</tributario>
                 </precatorio>
                 <precatorio>
                  <beneficiarios>
                   <snPessoaFisica>false</snPessoaFisica>
                   <valor>300000.00</valor>
                  </beneficiarios>
                  <classificacoes>
                   <classificacao>D</classificacao>
                   <valor>300000.00</valor>
                  </classificacoes>
                  <dataAjuizamento>2010-12-24</dataAjuizamento>
                  <dataTransitadoJulgado>2013-02-22</dataTransitadoJulgado>
                  <dataAutuacao>2013-03-30</dataAutuacao>
                  <dataTransitadoJulgadoExecucao>2025-01-01</dataTransitadoJulgadoExecucao>
                  <dataBase>2020-01-01</dataBase>
		  <valorDataBase>300000</valorDataBase>    
                  <numProcessoUnico>0123456-78.9012.3.45.6789</numProcessoUnico>
                  <numPrecatorio>193d93d314447</numPrecatorio>
                  <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                  <valor>304097.53</valor>
                  <tipoDespesa>11</tipoDespesa>
                  <numAcaoOrig>cccccccccc</numAcaoOrig>
                  <vara>YYYY</vara>
                  <varaDescricao>Vara descrição</varaDescricao>
                  <tributario>true</tributario>
                </precatorio>
             </unidadeOrcamentariaExecutada>
          </orgaoTribunal>
       </input>
    </prec:incluirPrecatorios>
 </soapenv:Body>
</soapenv:Envelope>

</code>

=== Parâmetro(s) de saída ===

Caso o webservice tenha acatado os dados informados será retornado um campo “sucesso” com o valor “true”. Em caso de falha na gravação das informações, além do campo “sucesso”, agora com valor “false”, serão acrescidos campos “mensagensErro” para cada erro encontrado.

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|RetornoPrecatoriosDTO|RetornoPrecatoriosDTO|1|   |

=== Exemplo de XML de saída: ===

== Exemplo sem mensagem de erro: ==
<code>

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

</code>

== Exemplo com mensagem de erro: ==

<code>
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
   <env:Header>
      <sof:request>05D2D096F4C305FC0E8E4D185CC029E1</sof:request>
   </env:Header>
   <env:Body>
      <ns2:incluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
         <return>
            <mensagensErro>Precatório XXXXXXXXXX com exercício 2023 já existente</mensagensErro>
            <mensagensErro>Precatório 1933d93d314447: O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
            <mensagensErro>Precatório 1933d93d314447: O valor informado para o precatório é superior à soma dos valores dos beneficiários.</mensagensErro>
            <mensagensErro>Precatório 1933d93d314447: A classificação do precatório é obrigatória.</mensagensErro>
            <sucesso>false</sucesso>
         </return>
      </ns2:incluirPrecatoriosResponse>
   </env:Body>
</env:Envelope>

</code>

==== excluirPrecatorios ====

Exclui todos os precatórios já informados por um tribunal para um determinado exercício.

=== Parâmetro(s) de entrada ===

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|credencial|credencialDTO|1|Tipo complexo que contem os dados de acesso do usuário ao serviço. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|
|exercicio|Int|1|Exercício da proposta orçamentária.|
|orgaosTribunal|orgaoTribunalDTO|1|Tipo complexo que contem os códigos dos tribunais que terão seus precatórios excluídos. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|
|codigoOrgaoTribunal|String|1|Campo obrigatório que representa o código do tribunal (5 posições). Exemplo: 11101.|

Obs.: para a exclusão dos precatórios, não é necessário informar os dados de todos os precatórios que foram incluídos. A exclusão é feita por tribunal, ou seja, todos os precatórios do tribunal informado serão excluídos, para o exercício em questão. Veja os exemplos abaixo.

=== Exemplo de XML de entrada: ===
<code>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prec="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
 <soapenv:Header/>
 <soapenv:Body>
    <prec:excluirPrecatorios>
       <credencial>
           <perfil>106</perfil>
          <senha>XXXXXXXXXXXXXXXX</senha>
          <usuario>I08</usuario>
       </credencial>
       <input>
          <exercicio>2023</exercicio>
          <orgaosTribunal>
             <codigoOrgaoTribunal>15102</codigoOrgaoTribunal>
          </orgaosTribunal>
          <orgaosTribunal>
             <codigoOrgaoTribunal>15125</codigoOrgaoTribunal>
          </orgaosTribunal>
       </input>
    </prec:excluirPrecatorios>
 </soapenv:Body>
</soapenv:Envelope>

</code>

=== Parâmetro(s) de saída ===

Caso o webservice tenha acatado os dados informados será acrescida um campo “sucesso” com o valor “true”. Em caso de falha na deleção das informações, além do campo “sucesso”, agora com valor “false” serão acrescidos campos “mensagensErro” para cada erro encontrado.

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|RetornoPrecatoriosDTO|RetornoPrecatoriosDTO|1|   |

=== Exemplo de XML de saída: ===

== Exemplo sem mensagem de erro: ==
<code>

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
   <env:Header>
      <sof:request>530A4CA00B11599B32D6C8A6C50DC17E</sof:request>
   </env:Header>
   <env:Body>
      <ns2:excluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
         <return>
            <sucesso>true</sucesso>
         </return>
      </ns2:excluirPrecatoriosResponse>
   </env:Body>
</env:Envelope>

</code>

== Exemplo com mensagem de erro: ==

<code>
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
   <env:Header>
      <sof:request>505603CAAFCF2DC43A60EC14275180CB</sof:request>
   </env:Header>
   <env:Body>
      <ns2:excluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
         <return>
            <mensagensErro>Tribunal 15925 para o exercício 2023 não encontrado.</mensagensErro>
            <sucesso>false</sucesso>
         </return>
      </ns2:excluirPrecatoriosResponse>
   </env:Body>
</env:Envelope>

</code>

==== alterarPrecatorios ====

Método para alteração do valor total dos precatórios. Alteração do valor total de um precatório implica também que as seguintes alterações sejam realizadas:

  - Adequação dos valores de cada Beneficiário (cujo somatório deve corresponder ao novo valor total do precatório);
  - Adequação dos valores das Classificações de Prioridade A, B, C e D - conforme §8º do art. 107-A do ADCT. (o somatório dos valores de classificação  deve corresponder ao novo valor total do precatório);
  - Adequação dos valores de Vínculo de Servidor (se houver);

=== Parâmetro(s) de entrada ===

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|credencial|credencialDTO|1|Tipo complexo que contem os dados de acesso do usuário ao serviço. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|
|precatorios|precatoriosAlteradosDTO|1|Tipo complexo que contem os precatórios alterados, agrupados por tribunal. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|

=== Exemplo de XML de entrada: ===
<code>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prec="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <prec:alterarPrecatorios>
         <credencial xmlns="">
        <perfil>106</perfil>
        <senha>**********</senha>
        <usuario>WS-TESTE</usuario>
      </credencial>
      <input>
            <exercicioAlteracao>2025</exercicioAlteracao>
            <tribunal>
               <codigoTribunal>11101</codigoTribunal>
               <precatorio>
              <beneficiarios>
                <participacao>Requerente</participacao>
                <snPessoaFisica>false</snPessoaFisica>
                <valor>24989.75</valor>
              </beneficiarios>
              <classificacoes>
                <classificacao>B</classificacao>
                <valor>24989.75</valor>
              </classificacoes>
              <exercicio>2025</exercicio>
              <numPrecatorio>XXXXXXXXXXXX</numPrecatorio>
              <valor>24989.75</valor>
            </precatorio>
            <precatorio>
              <beneficiarios>
                <participacao>Requerente</participacao>
                <snPessoaFisica>true</snPessoaFisica>
                <valor>38826.83</valor>
              </beneficiarios>
              <beneficiarios>
                <participacao>Advogado</participacao>
                <snPessoaFisica>false</snPessoaFisica>
                <valor>4314.09</valor>
              </beneficiarios>
              <classificacoes>
                <classificacao>A</classificacao>
                <valor>43140.92</valor>
              </classificacoes>
              <exercicio>2025</exercicio>
              <numPrecatorio>YYYYYYYYYY</numPrecatorio>
              <valor>43140.92</valor>
            </precatorio>
            <precatorio>
              <beneficiarios>
                <participacao>Requerente</participacao>
                <snPessoaFisica>false</snPessoaFisica>
                <valor>4376.32</valor>
              </beneficiarios>
              <classificacoes>
                <classificacao>B</classificacao>
                <valor>4376.32</valor>
              </classificacoes>
              <exercicio>2025</exercicio>
              <numPrecatorio>ZZZZZZZZZZ</numPrecatorio>
              <valor>4376.32</valor>
            </precatorio>
            <precatorio>
              <beneficiarios>
                <participacao>Requerente</participacao>
                <snPessoaFisica>false</snPessoaFisica>
                <valor>30513.65</valor>
              </beneficiarios>
              <classificacoes>
                <classificacao>B</classificacao>
                <valor>30513.65</valor>
              </classificacoes>
              <exercicio>2025</exercicio>
              <numPrecatorio>AAAAAAAAAAA</numPrecatorio>
              <valor>30513.65</valor>
            </precatorio>
            <precatorio>
              <beneficiarios>
                <participacao>Requerente</participacao>
                <snPessoaFisica>false</snPessoaFisica>
                <valor>26073.24</valor>
              </beneficiarios>
              <classificacoes>
                <classificacao>B</classificacao>
                <valor>26073.24</valor>
              </classificacoes>
              <exercicio>2025</exercicio>
              <numPrecatorio>BBBBBBBBBBBB</numPrecatorio>
              <valor>26073.24</valor>
            </precatorio>
            <precatorio>
              <beneficiarios>
                <participacao>P</participacao>
                <snPessoaFisica>true</snPessoaFisica>
                <valor>344420.0</valor>
              </beneficiarios>
              <beneficiarios>
                <participacao>A</participacao>
                <snPessoaFisica>false</snPessoaFisica>
                <valor>60780.0</valor>
              </beneficiarios>
              <classificacoes>
                <classificacao>A</classificacao>
                <valor>216030</valor>
              </classificacoes>
              <classificacoes>
                <classificacao>C</classificacao>
                <valor>38130</valor>
              </classificacoes>
              <classificacoes>
                <classificacao>D</classificacao>
                <valor>151040.0</valor>
              </classificacoes>
              <exercicio>2025</exercicio>
              <numPrecatorio>098742598764967843987654</numPrecatorio>
              <valor>405200.0</valor>
              <vinculosServidor>
                <codigoOrgao>25103</codigoOrgao>
                <valor>344430.64</valor>
              </vinculosServidor>
            </precatorio>
            </tribunal>
         </input>
      </prec:alterarPrecatorios>
   </soapenv:Body>
</soapenv:Envelope>

</code>

=== Parâmetro(s) de saída ===

Caso o webservice tenha processado os dados enviados ciom sucesso, o campo “sucesso” da mensagem de retorno será setado com o valor “true”. Em caso de falha no processamento dos dados, além do campo “sucesso”, agora setado com o valor “false”, serão acrescidos campos “mensagensErro” para cada erro encontrado.

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|RetornoPrecatoriosDTO|RetornoPrecatoriosDTO|1|   |

=== Exemplo de XML de saída: ===

== Exemplo sem mensagem de erro: ==
<code>

<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:sof='http://precatorios.servicoweb.siop.sof.planejamento.gov.br/'>
  <env:Header>
    <sof:request>B62C0A10045AFE4928DB43012CDC3721</sof:request>
  </env:Header>
  <env:Body>
    <ns2:alterarPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>true</sucesso>
      </return>
    </ns2:alterarPrecatoriosResponse>
  </env:Body>
</env:Envelope>

</code>

== Exemplo com mensagem de erro: ==

<code>
<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:sof='http://precatorios.servicoweb.siop.sof.planejamento.gov.br/'>
  <env:Header>
    <sof:request>4F257AF3FB7B5FA958E17DBD9246E28C</sof:request>
  </env:Header>
  <env:Body>
    <ns2:alterarPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>false</sucesso>
        <mensagensErro>Precatório XXXXXXX: O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
            <mensagensErro>Precatório YYYYYYY: O valor informado para o precatório é superior à soma dos valores dos beneficiários.</mensagensErro>
            <mensagensErro>Precatório YYYYYYY: A classificação do precatório é obrigatória.</mensagensErro>
      </return>
    </ns2:alterarPrecatoriosResponse>
  </env:Body>
</env:Envelope>

</code>

==== cancelarPrecatorios ====

Método para cancelamento de precatórios.

=== Parâmetro(s) de entrada ===

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|credencial|credencialDTO|1|Tipo complexo que contem os dados de acesso do usuário ao serviço. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|
|precatorios|precatoriosCanceladosDTO|1|Tipo complexo que contem os precatórios cancelados, agrupados por tribunal. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|

=== Exemplo de XML de entrada: ===
<code>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prec="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <prec:cancelarPrecatorios>
      <credencial>
        <perfil>106</perfil>
        <senha>**********</senha>
        <usuario>ws-teste</usuario>
      </credencial>
      <input>
        <exercicioCancelamento>2025</exercicioCancelamento>
        <tribunal>
          <codigoTribunal>12104</codigoTribunal>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01697246120204039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01712797920214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01580063320214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>00413959420214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01252039420214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01187741420214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>00234015320214039XYZ</numPrecatorio>
          </precatorio>
        </tribunal>
      </input>
      </prec:cancelarPrecatorios>
   </soapenv:Body>
</soapenv:Envelope>

</code>

=== Parâmetro(s) de saída ===

Caso o webservice tenha processado os dados enviados ciom sucesso, o campo “sucesso” da mensagem de retorno será setado com o valor “true”. Em caso de falha no processamento dos dados, além do campo “sucesso”, agora setado com o valor “false”, serão acrescidos campos “mensagensErro” para cada erro encontrado.

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|RetornoPrecatoriosDTO|RetornoPrecatoriosDTO|1|   |

=== Exemplo de XML de saída: ===

== Exemplo sem mensagem de erro: ==
<code>

<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:sof='http://precatorios.servicoweb.siop.sof.planejamento.gov.br/'>
  <env:Header>
    <sof:request>B62C0A10045AFE4928DB43012CDC3721</sof:request>
  </env:Header>
  <env:Body>
    <ns2:cancelarPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>true</sucesso>
      </return>
    </ns2:cancelarPrecatoriosResponse>
  </env:Body>
</env:Envelope>

</code>

== Exemplo com mensagem de erro: ==

<code>
<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:sof='http://precatorios.servicoweb.siop.sof.planejamento.gov.br/'>
  <env:Header>
    <sof:request>4F257AF3FB7B5FA958E17DBD9246E28C</sof:request>
  </env:Header>
  <env:Body>
    <ns2:cancelarPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>false</sucesso>
        <mensagensErro>Precatório XXXXXXX: Os campos de Número do Precatório e de Exercício devem ser preenchidos.</mensagensErro>
      </return>
    </ns2:cancelarPrecatoriosResponse>
  </env:Body>
</env:Envelope>

</code>

==== suspenderPrecatorios ====

Método para suspensão de precatórios.

=== Parâmetro(s) de entrada ===

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|credencial|credencialDTO|1|Tipo complexo que contem os dados de acesso do usuário ao serviço. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|
|precatorios|precatoriosSuspensosDTO|1|Tipo complexo que contem os precatórios suspensos, agrupados por tribunal. [[.:manual-wsprecatorios#tipo_s_complexo_s|Ver detalhamento]].|

=== Exemplo de XML de entrada: ===
<code>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prec="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <prec:suspenderPrecatorios>
      <credencial>
        <perfil>106</perfil>
        <senha>**********</senha>
        <usuario>ws-teste</usuario>
      </credencial>
      <input>
        <exercicioCancelamento>2025</exercicioCancelamento>
        <tribunal>
          <codigoTribunal>12104</codigoTribunal>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01697246120204039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01712797920214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01580063320214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>00413959420214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01252039420214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>01187741420214039XYZ</numPrecatorio>
          </precatorio>
          <precatorio>
            <exercicio>2022</exercicio>
            <numPrecatorio>00234015320214039XYZ</numPrecatorio>
          </precatorio>
        </tribunal>
      </input>
      </prec:suspenderPrecatorios>
   </soapenv:Body>
</soapenv:Envelope>

</code>

=== Parâmetro(s) de saída ===

Caso o webservice tenha processado os dados enviados ciom sucesso, o campo “sucesso” da mensagem de retorno será setado com o valor “true”. Em caso de falha no processamento dos dados, além do campo “sucesso”, agora setado com o valor “false”, serão acrescidos campos “mensagensErro” para cada erro encontrado.

|**Parâmetro** |**Tipo** |**Ocorrência mínima** |**Observações** |
|RetornoPrecatoriosDTO|RetornoPrecatoriosDTO|1|   |

=== Exemplo de XML de saída: ===

== Exemplo sem mensagem de erro: ==
<code>

<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:sof='http://precatorios.servicoweb.siop.sof.planejamento.gov.br/'>
  <env:Header>
    <sof:request>B62C0A10045AFE4928DB43012CDC3721</sof:request>
  </env:Header>
  <env:Body>
    <ns2:suspenderPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>true</sucesso>
      </return>
    </ns2:suspenderPrecatoriosResponse>
  </env:Body>
</env:Envelope>

</code>

== Exemplo com mensagem de erro: ==

<code>
<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:sof='http://precatorios.servicoweb.siop.sof.planejamento.gov.br/'>
  <env:Header>
    <sof:request>4F257AF3FB7B5FA958E17DBD9246E28C</sof:request>
  </env:Header>
  <env:Body>
    <ns2:suspenderPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>false</sucesso>
        <mensagensErro>Precatório XXXXXXX: Os campos de Número do Precatório e de Exercício devem ser preenchidos.</mensagensErro>
      </return>
    </ns2:suspenderPrecatoriosResponse>
  </env:Body>
</env:Envelope>

</code>

==== Tipo(s) Complexo(s) ====

=== credencialDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|perfil|Int|Campo obrigatório que representa o código do perfil do usuário.|
|senha|String|Campo obrigatório que representa o hash MD5 da senha do usuário.|
|usuario|String|Campo obrigatório que representa o login do usuário.|

=== precatoriosDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicio|int|Campo obrigatório que representa o exercício da proposta orçamentária.|
|orgaosTribunal|orgaoTribunalDTO|Campo obrigatório que agrupa todos os precatórios expedidos por um determinado tribunal.|

=== orgaoTribunalDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|codigoOrgaoTribunal|String|Campo obrigatório que representa o código do tribunal (5 posições). Exemplo: 11101.|
|unidadeOrcamentariaExecutada|unidadeExecutadaDTO|Campo obrigatório que agrupa os precatórios de determinado tribunal por unidade orçamentária executada.|

=== unidadeExecutadaDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|codigoUnidadeExecutada|String|Campo obrigatório que representa o código da unidade orçamentária (5 posições) contra a qual o precatório foi expedido. Exemplo: 26236.|
|precatorio|precatorioDTO|Campo obrigatório que contem os dados detalhados de cada precatório.|

=== precatorioDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|dataAjuizamento|String|Campo obrigatório com a data de ajuizamento da ação no formato yyyy-MM-dd. Exemplo: 2004-03-19.|
|dataAutuacao|String|Campo obrigatório com a data da autuação no formato yyyy-MM-dd. Exemplo: 2004-03-19. Deve ser menor ou igual à dataTransitadoJulgado.|
|dataTransitadoJulgado|String|Campo obrigatório com a data do trânsito em julgado da ação no formato yyyy-MM-dd. Exemplo: 2004-03-19. Refere-se à data do trânsito em julgado da sentença ou do acórdão lavrado na fase de conhecimento do processo judicial.|
|dataTransitadoJulgadoExecucao|String|Campo obrigatório com a data do trânsito em julgado dos embargos à execução, da decisão que resolveu a impugnação ao cálculo no cumprimento de sentença ou do decurso do prazo para sua apresentação ou, se for o caso, da decisão que reconheceu parcela incontroversa, no formato yyyy-MM-dd. Exemplo: 2004-03-19.|
|dataBase|String|Campo obrigatório com a data-base utilizada na definição do valor do crédito, no formato yyyy-MM-dd. Exemplo: 2004-03-19.|
|numPrecatorio|String|Campo obrigatório (texto livre) com o número do precatório.|
|numProcessoUnico |String|Campo obrigatório com a numeração única do processo judicial, no padrão de 20 dígitos numéricos (NNNNNNNDDAAAAJTROOOO) da Resolução CNJ nº 65/2008.|
|numAcaoOrig|String|Campo obrigatório (texto livre) com o número da ação originária.|
|numProcessoExecucao|String|Campo opcional (texto livre) com o número do processo de execução. Caso o número do processo de execução seja diferente do número da ação originária, esse campo deve ser preenchido.|
|tipoCausa|String|Campo texto livre com o tipo de causa do Precatório. Exemplo: Administrativo - Militar - Anistia.|
|tipoDespesa|String|Campo obrigatório. Possíveis valores: 11 - NATUREZA ALIMENTÍCIA - Salários, vencimentos, proventos, pensões e suas complementações; 12 - NATUREZA ALIMENTÍCIA - Benefícios previdenciários e indenizações por morte ou invalidez; 13 - NATUREZA ALIMENTÍCIA (ACIDENTÁRIO) - Benefício previdenciário por acidente de trabalho; 14 - NATUREZA ALIMENTÍCIA - Demais; 21 - NATUREZA NÃO ALIMENTÍCIA; 31 - DESAPROPRIAÇÕES - Único imóvel residencial do credor; 39 - DESAPROPRIAÇÕES - Demais; 41 - FUNDEF; 99 - PRECATÓRIOS SEM PARCELAMENTO - Exercícios anteriores.|
|valor|Double|Campo obrigatório com o valor nominal do precatório. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52|
|valorDataBase|Double|Campo obrigatório com o valor principal do precatório, na data-base de definição do valor do crédito. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52. Deve ser menor ou igual ao valor do precatório.|
|vara|String|Campo de texto livre obrigatório com o número da vara. Ex.: 000001.|
|varaDescricao|String|Campo texto livre obrigatório com a descrição do campo “vara”.|
|tributario|Boolean|Campo booleano obrigatório que indica se o precatório é tributário. Ex.: 'true' caso o precatório seja tributário.|
|uf|String|Sigla da UF (Campo obrigatório apenas para os precatórios enviados pelo CNJ).|
|beneficiarios|beneficiarioDTO|Campo obrigatório que agrupa todos os beneficiários de um determinado precatório.|
|classificacoes|classificacaoDTO|Campo obrigatório que agrupa todas as classificações (A, B, C e D) de um determinado precatório, conforme classes de prioridades dispostas no § 8º do art. 107-A do Ato de Disposições Constitucionais Transitórias- ADCT. Referência legal: Inciso XIV do art. 31 da LDO 2024.  |
|vinculosServidor|vinculoServidorDTO|Campo que agrupa, por órgão, os valores de um dado precatório que se referem a demandas salariais de servidores públicos. Referência legal: Inciso XVIII do art. 31 da LDO 2024.  |

=== beneficiarioDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|participacao|String|Campo opcional (texto livre) para informar a forma de participação do benefíciário do precatório (ex.: advogado ou parte).|
|snPessoaFisica|Boolean|Campo obrigatório que informa se o beneficiário é pessoa física ou jurídica. Ex.: 'true' caso o beneficiário seja pessoa física e 'false' caso seja pessoa jurídica. Informar sem as aspas.|
|valor|Double|Campo obrigatório com o valor nominal referente ao beneficiário. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52|

=== classificacaoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|classificacao|String|Campo obrigatório de 1 posição que representa a classificação de prioridade para pagamento do precatório. Valores possíveis: A, B, C ou D.|
|valor|Double|Campo obrigatório com o valor nominal referente à classificação informada. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52|

=== vinculoServidorDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|orgao|String|Campo obrigatório que representa o código do órgão do qual faz parte o servidor (5 posições). Exemplo: 24101.|
|valor|Double|Campo obrigatório com o valor nominal referente ao somatório de todos os beneficiários que são servidores. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52|

=== precatoriosAlteradosDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicioAlteracao|int|Campo obrigatório que representa o exercício no qual a alteração de valor está acontecendo.|
|tribunal|tribunalAlteracaoDTO|Campo obrigatório que agrupa todos os precatórios alterados por um determinado tribunal.|

=== tribunalAlteracaoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|codigoTribunal|String|Campo obrigatório que representa o código do tribunal (5 posições). Exemplo: 11101.|
|precatorio|precatorioAlteradoDTO|Campo obrigatório que contem os dados do precatório alterado.|

=== precatorioAlteradoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicio|int|Campo obrigatório que representa o exercício do precatório alterado.|
|numPrecatorio|String|Campo obrigatório que representa o número do precatório alterado.|
|valor|Double|Campo obrigatório que representa o novo valor do precatório. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 118827.27. Deve ser maior que zero.|
|beneficiarios|beneficiarioDTO|Campo obrigatório que agrupa todos os beneficiários de um determinado precatório.|
|classificacoes|classificacaoDTO|Campo obrigatório que agrupa todas as classificações (A, B, C e D) de um determinado precatório, conforme classes de prioridades dispostas no § 8º do art. 107-A do Ato de Disposições Constitucionais Transitórias- ADCT. Referência legal: Inciso XIV do art. 31 da LDO 2024.  |
|vinculosServidor|vinculoServidorDTO|Campo que agrupa, por órgão, os valores de um dado precatório que se referem a demandas salariais de servidores públicos. Referência legal: Inciso XVIII do art. 31 da LDO 2024.|

=== precatoriosCanceladosDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicioCancelamento|int|Campo obrigatório que representa o exercício no qual o cancelamento do precatório está acontecendo.|
|tribunal|tribunalAlteracaoDTO|Campo obrigatório que agrupa todos os precatórios cancelados por um determinado tribunal.|

=== tribunalCancelamentoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|codigoTribunal|String|Campo obrigatório que representa o código do tribunal (5 posições). Exemplo: 11101.|
|precatorio|precatorioCanceladoDTO|Campo obrigatório que contem os dados do precatório cancelado.|

=== precatorioCanceladoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicio|int|Campo obrigatório que representa o exercício do precatório cancelado.|
|numPrecatorio|String|Campo obrigatório que representa o número do precatório cancelado.|


=== precatoriosSuspensosDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicioSuspensao|int|Campo obrigatório que representa o exercício no qual a suspensão do precatório está acontecendo.|
|tribunal|tribunalSuspensaoDTO|Campo obrigatório que agrupa todos os precatórios suspensos por um determinado tribunal.|

=== tribunalSuspensaoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|codigoTribunal|String|Campo obrigatório que representa o código do tribunal (5 posições). Exemplo: 11101.|
|precatorio|precatorioSuspensaoDTO|Campo obrigatório que contem os dados do precatório suspenso.|

=== precatorioSuspensoDTO ===

|**Parâmetro** |**Tipo** |**Observações** |
|exercicio|int|Campo obrigatório que representa o exercício do precatório suspenso.|
|numPrecatorio|String|Campo obrigatório que representa o número do precatório suspenso.|