Ferramentas do usuário

Ferramentas do site


Action unknown: addtobook
webservices:manual-wsprecatorios

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
Endereço do WSDL - Testes https://testews.siop.gov.br/services/precatorios/WSPrecatorios?wsdl
Endereço do WSDL - Produção 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
credencialcredencialDTO1Tipo complexo que contem os dados de acesso do usuário ao serviço. Ver detalhamento.
precatoriosprecatoriosDTO1Tipo complexo que contem os dados dos precatórios agrupados por tribunal. Ver detalhamento.

Exemplo de XML de entrada:

<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>2013</exercicio>
          <orgaoTribunal>
             <codigoOrgaoTribunal>11101</codigoOrgaoTribunal>
             <unidadeOrcamentariaExecutada>
                <codigoUnidadeExecutada>26236</codigoUnidadeExecutada>
                <precatorio>
                   <acaoOriginaria>MS 12.707/DF</acaoOriginaria>
                   <beneficiario>
                      <CPFCNPJ>3325327191</CPFCNPJ>
                      <nome>Paulo</nome>
                      <snPessoaFisica></snPessoaFisica>
                      <valor>304097.52</valor>
                   </beneficiario>
                   <dataAjuizamento>2004-03-19</dataAjuizamento>
                   <dataTransitadoJulgado>2004-09-22</dataTransitadoJulgado>
                   <dataAutuacao>2005-05-30</dataAutuacao>
                   <numPrecatorio>d</numPrecatorio>
                   <observacoes>teste</observacoes>
                   <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                   <valor>304097.52</valor>
                   <vara>000001</vara>
                  <tipoDespesa>11</tipoDespesa>
                   <varaDescricao>vara bla bla bla</varaDescricao>
                </precatorio>
                <precatorio>
                   <acaoOriginaria>MS 11.438-DF</acaoOriginaria>
                   <beneficiario>
                      <CPFCNPJ>45646</CPFCNPJ>
                      <nome>Fulano</nome>
                      <valor>304097.53</valor>
                   </beneficiario>
                   <dataAjuizamento>2006-03-23</dataAjuizamento>
                   <dataTransitadoJulgado>2013-02-22</dataTransitadoJulgado>
                   <dataAutuacao>2013-03-30</dataAutuacao>
                   <naturezaDespesa></naturezaDespesa>
                   <numPrecatorio>193d93d314447</numPrecatorio>
                   <observacoes>teste</observacoes>
                   <snSupenso>false</snSupenso>
                   <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                   <valor>304097.53</valor>
                   <vara>000001</vara>
                   <tipoDespesa>11</tipoDespesa>
                   <varaDescricao>vara bla bla bla</varaDescricao>
                </precatorio>
             </unidadeOrcamentariaExecutada>
          </orgaoTribunal>
       </input>
    </prec:incluirPrecatorios>
 </soapenv:Body>
</soapenv:Envelope>

Parâmetro(s) de saída

O método retorna uma estrutura similar àquela informada na entrada. Caso o webservice tenha acatado os dados informados será acrescido um campo “sucesso” com o valor “true” em cada tag do tipo AGRUPADOR. 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.

As mensagens de erro bem como o valor do campo “sucesso” são propagados para níveis hierarquicamente superiores do XML. Dessa forma, por exemplo, caso ocorra algum erro em um campo de beneficiário, as mensagens de erro serão apresentadas tanto no campo agrupador do “beneficiário” no qual o erro foi constatado, quanto nos campos hierarquicamente superiores como “precatorio”, “unidadeOrcamentariaExecutada”, “OrgaoTribunal“ e na raiz no XML.

Parâmetro Tipo Ocorrência mínima Observações
WSPrecatoriosDTOWSPrecatorioDTO1

Exemplo de XML de saída:

Exemplo sem mensagem de erro:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
<env:Header>
<sof:recibo>D74934AE90E38EBCCB08F1987AA4A2DA</sof:recibo>
</env:Header>
 <env:Body>
    <ns2:incluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <exercicio>2013</exercicio>
          <orgaoTribunal>
             <sucesso>true</sucesso>
             <codigoOrgaoTribunal>11101</codigoOrgaoTribunal>
             <unidadeOrcamentariaExecutada>
                <sucesso>true</sucesso>
                <codigoUnidadeExecutada>26236</codigoUnidadeExecutada>
                <precatorio>
                   <sucesso>true</sucesso>
                   <acaoOriginaria>MS 12.707/DF</acaoOriginaria>
                   <beneficiario>
                      <sucesso>true</sucesso>
                      <CPFCNPJ>3325327191</CPFCNPJ>
                      <nome>Paulo</nome>
                      <valor>304097.52</valor>
                   </beneficiario>
                   <dataAjuizamento>2004-03-19</dataAjuizamento>
                   <dataAutuacao>2005-05-30</dataAutuacao>
                   <dataTransitadoJulgado>2004-09-22</dataTransitadoJulgado>
                   <numPrecatorio>d4</numPrecatorio>
                   <observacoes>teste</observacoes>
                   <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                   <tipoDespesa>11</tipoDespesa>
                   <valor>304097.52</valor>
                   <vara>000001</vara>
                   <varaDescricao>vara bla bla bla</varaDescricao>
                </precatorio>
                <precatorio>
                   <sucesso>true</sucesso>
                   <acaoOriginaria>MS 11.438-DF</acaoOriginaria>
                   <beneficiario>
                      <sucesso>true</sucesso>
                      <CPFCNPJ>45646</CPFCNPJ>
                      <nome>Fulano</nome>
                      <valor>304097.53</valor>
                   </beneficiario>
                   <dataAjuizamento>2006-03-23</dataAjuizamento>
                   <dataAutuacao>2013-03-30</dataAutuacao>
                   <dataTransitadoJulgado>2013-02-22</dataTransitadoJulgado>
                   <naturezaDespesa/>
                   <numPrecatorio>1933d93d314447</numPrecatorio>
                   <observacoes>teste</observacoes>
                   <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                   <tipoDespesa>11</tipoDespesa>
                   <valor>304097.53</valor>
                   <vara>000001</vara>
                   <varaDescricao>vara bla bla bla</varaDescricao>
                </precatorio>
             </unidadeOrcamentariaExecutada>
          </orgaoTribunal>
       </return>
    </ns2:incluirPrecatoriosResponse>
 </env:Body>
</env:Envelope>
Exemplo com mensagem de erro:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
<env:Header>
<sof:recibo>8435AD3BB4A38361065A729B43DFB3F8</sof:recibo>
</env:Header>
 <env:Body>
    <ns2:incluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <mensagensErro>Precatório d com exercício 2013 já existente</mensagensErro>
          <mensagensErro>O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
          <mensagensErro>Precatório 1933d93d314447: O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
          <mensagensErro>Precatório 1933d93d314447: Nenhum beneficiário pode ter o valor igual a zero.</mensagensErro>
          <mensagensErro>Precatório 1933d93d314447: O valor informado para o precatório é superior à soma dos valores dos beneficiários.</mensagensErro>
          <sucesso>false</sucesso>
          <exercicio>2013</exercicio>
          <orgaoTribunal>
             <mensagensErro>Precatório d com exercício 2013 já existente</mensagensErro>
             <mensagensErro>O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
             <mensagensErro>Precatório 1933d93d314447: O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
             <mensagensErro>Precatório 1933d93d314447: Nenhum beneficiário pode ter o valor igual a zero.</mensagensErro>
             <mensagensErro>Precatório 1933d93d314447: O valor informado para o precatório é superior à soma dos valores dos beneficiários.</mensagensErro>
             <sucesso>false</sucesso>
             <codigoOrgaoTribunal>11101</codigoOrgaoTribunal>
             <unidadeOrcamentariaExecutada>
                <mensagensErro>Precatório d com exercício 2013 já existente</mensagensErro>
                <mensagensErro>O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
                <mensagensErro>Precatório 1933d93d314447: O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
                <mensagensErro>Precatório 1933d93d314447: Nenhum beneficiário pode ter o valor igual a zero.</mensagensErro>
                <mensagensErro>Precatório 1933d93d314447: O valor informado para o precatório é superior à soma dos valores dos beneficiários.</mensagensErro>
                <sucesso>false</sucesso>
                <codigoUnidadeExecutada>26236</codigoUnidadeExecutada>
                <precatorio>
                   <mensagensErro>Precatório d com exercício 2013 já existente</mensagensErro>
                   <sucesso>false</sucesso>
                   <acaoOriginaria>MS 12.707/DF</acaoOriginaria>
                   <dataAjuizamento>2004-03-19</dataAjuizamento>
                   <dataAutuacao>2005-05-30</dataAutuacao>
                   <dataTransitadoJulgado>2004-09-22</dataTransitadoJulgado>
                   <numPrecatorio>d</numPrecatorio>
                   <observacoes>teste</observacoes>
                   <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                   <tipoDespesa>11</tipoDespesa>
                   <valor>304097.52</valor>
                   <vara>000001</vara>
                   <varaDescricao>vara bla bla bla</varaDescricao>
                </precatorio>
                <precatorio>
                   <mensagensErro>O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
                   <mensagensErro>Precatório 1933d93d314447: O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
                   <mensagensErro>Precatório 1933d93d314447: Nenhum beneficiário pode ter o valor igual a zero.</mensagensErro>
                   <mensagensErro>Precatório 1933d93d314447: O valor informado para o precatório é superior à soma dos valores dos beneficiários.</mensagensErro>
                   <sucesso>false</sucesso>
                   <acaoOriginaria>MS 11.438-DF</acaoOriginaria>
                   <beneficiario>
                      <mensagensErro>O campo Valor deve ser informado para todos os beneficiários.</mensagensErro>
                      <sucesso>false</sucesso>
                      <CPFCNPJ>45646</CPFCNPJ>
                      <nome>Fulano</nome>
                   </beneficiario>
                   <dataAjuizamento>2006-03-23</dataAjuizamento>
                   <dataAutuacao>2013-03-30</dataAutuacao>
                   <dataTransitadoJulgado>2013-02-22</dataTransitadoJulgado>
                   <naturezaDespesa/>
                   <numPrecatorio>1933d93d314447</numPrecatorio>
                   <observacoes>teste</observacoes>
                   <tipoCausa>Administrativo - Militar - Anistia</tipoCausa>
                   <tipoDespesa>11</tipoDespesa>
                   <valor>304097.53</valor>
                   <vara>000001</vara>
                   <varaDescricao>vara bla bla bla</varaDescricao>
                </precatorio>
             </unidadeOrcamentariaExecutada>
          </orgaoTribunal>
       </return>
    </ns2:incluirPrecatoriosResponse>
 </env:Body>
</env:Envelope>

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
credencialcredencialDTO1Tipo complexo que contem os dados de acesso do usuário ao serviço. Ver detalhamento.
exercicioInt1Exercício da proposta orçamentária.
orgaoTribunalorgaoTribunalDTO1Tipo complexo que contem os códigos dos tribunais que terão seus precatórios excluídos. Ver detalhamento.
codigoOrgaoTribunalString1Campo 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:

<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>2013</exercicio>
          <orgaoTribunal>
                    <codigoOrgaoTribunal>12105</codigoOrgaoTribunal>
               </orgaoTribunal>
       </input>
    </prec:excluirPrecatorios>
 </soapenv:Body>
</soapenv:Envelope>

Parâmetro(s) de saída

O método retorna uma estrutura similar àquela informada na entrada. Caso o webservice tenha acatado os dados informados será acrescida um campo “sucesso” com o valor “true” em cada tag do tipo “OrgaoTribunal”. 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.

As mensagens de erro bem como o valor do campo “sucesso” são propagados para níveis hierarquicamente superiores do XML. Dessa forma, por exemplo, caso ocorra algum erro no campo “OrgaoTribunal“, a mensagem de erro será exibida no nível desse campo além de ser propagada para a raiz no XML.

Parâmetro Tipo Ocorrência mínima Observações
WSPrecatoriosDTOWSPrecatorioDTO1

Exemplo de XML de saída:

Exemplo sem mensagem de erro:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
<env:Header>
<sof:recibo>D74934AE90E38EBCCB08F1987AA4A2DA</sof:recibo>
</env:Header>
 <env:Body>
    <ns2:excluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <sucesso>true</sucesso>
          <exercicio>2013</exercicio>
          <orgaoTribunal>
             <sucesso>true</sucesso>
             <codigoOrgaoTribunal>12105</codigoOrgaoTribunal>
          </orgaoTribunal>
       </return>
    </ns2:excluirPrecatoriosResponse>
 </env:Body>
</env:Envelope>
Exemplo com mensagem de erro:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
<env:Header>
<sof:recibo>D74934AE90E38EBCCB08F1987AA4A2DA</sof:recibo>
</env:Header>
 <env:Body>
    <ns2:excluirPrecatoriosResponse xmlns:ns2="http://precatorios.servicoweb.siop.sof.planejamento.gov.br/">
       <return>
          <mensagensErro>Tribunal: 12155 para o exercício: 2013 não encontrado</mensagensErro>
          <sucesso>false</sucesso>
          <exercicio>2013</exercicio>
          <orgaoTribunal>
             <mensagensErro>Tribunal: 12155 para o exercício: 2013 não encontrado</mensagensErro>
             <sucesso>false</sucesso>
             <codigoOrgaoTribunal>12155</codigoOrgaoTribunal>
          </orgaoTribunal>
       </return>
    </ns2:excluirPrecatoriosResponse>
 </env:Body>
</env:Envelope>

Tipo(s) Complexo(s)

credencialDTO

Parâmetro Tipo Observações
perfilIntCampo obrigatório que representa o código do perfil do usuário.
senhaStringCampo obrigatório que representa a senha do usuário.
usuarioStringCampo obrigatório que representa o login do usuário.

precatoriosDTO

Parâmetro Tipo Observações
exerciciointCampo obrigatório que representa o exercício da proposta orçamentária.
orgaosTribunalorgaoTribunalDTOCampo obrigatório que agrupa todos os precatórios expedidos por um determinado tribunal.

orgaoTribunalDTO

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

unidadeExecutadaDTO

Parâmetro Tipo Observações
codigoUnidadeExecutadaStringCampo 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.
precatorioprecatorioDTOCampo obrigatório que contem os dados detalhados de cada precatório.

precatorioDTO

Parâmetro Tipo Observações
acaoOriginariaStringCampo obrigatório (texto livre) com o número da ação originária.
dataAjuizamentoStringCampo obrigatório com a data do ajuizamento da ação data no formato yyyy-MM-dd. Exemplo: 2004-03-19. Deve ser menor ou igual à dataTransitadoJulgado e à dataAutuacao.
dataAutuacaoStringCampo obrigatório com a data da autuação no formato yyyy-MM-dd. Exemplo: 2004-03-19. Deve ser menor ou igual à dataTransitadoJulgado.
dataTransitadoJulgadoStringCampo obrigatório com a data do trânsito em julgado da ação no formato yyyy-MM-dd. Exemplo: 2004-03-19.
numPrecatorioStringCampo obrigatório (texto livre) com o número do precatório.
observacoesStringCampo texto livre com qualquer observação em relação ao precatório.
tipoCausaStringCampo texto livre com o tipo de causa do Precatório. Exemplo: Administrativo - Militar - Anistia.
tipoDespesaStringCampo 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 - ACIDENTÁRIO; 21 - NATUREZA NÃO ALIMENTÍCIA; 31 - DESAPROPRIAÇÕES - Único imóvel residencial do credor; 39 - DESAPROPRIAÇÕES - Demais; 99 - PRECATÓRIOS SEM PARCELAMENTO - Exercícios anteriores.
valorStringCampo obrigatório com o valor nominal do precatório. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52
varaStringCampo texto livre com o número da vara. Ex.: 000001
varaDescricaoStringCampo texto livre com a descrição do campo “vara”.
beneficiariosbeneficiarioDTOCampo obrigatório que agrupa todos os beneficiários de um determinado precatório.

beneficiarioDTO

Parâmetro Tipo Observações
CPFCNPJStringCampo obrigatório com 11 posições (pessoa física) ou 14 posições (pessoa jurídica). Informar com eventuais zeros na esquerda e não informar separadores. Ex. 11111111111 ou 11111111111111.
nomeStringCampo obrigatório (texto livre) com o nome do beneficiário detentor do CPFCNPJ.
participacaoString
snPessoaFisicaBooleanCampo obrigatório que informa se o beneficiário é pessoa física ou jurídica. Ex.: 'true' caso o beneficiário seja uma pessoa física e 'false' caso seja pessoa jurídica. Informar sem as aspas.
snPrincipalBooleanCampo obrigatório que informa se o beneficiário é o principal daquele precatório. Ex. 'true' caso o beneficiário seja o principal e 'false' caso não seja. Informar sem as aspas.
valordoubleCampo obrigatório com o valor nominal referente ao beneficiário. Formato: sem agrupador de milhar e ponto representando separador de centavos. Ex.: 304097.52