Loading...
Skip to content
Governo do Estado do Rio de Janeiro
Portal Transparência Fiscal
Aumentar Fonte Tamanho Normal Diminuir Fonte Alto Contraste
ENTRARFALE CONOSCOMAPA DO SITE

Web Service - Transparência Fiscal Estadual

Manual Técnico - WS TFE

Objetivo

O objetivo desse manual é orientar os usuários na utilização dos serviços web, em consonância com o Decreto Estadual nº 46.205, de forma a permitir o acesso automatizado por sistemas externos. Estão abrangidas as informações mensais e acumuladas sobre a execução das despesas e das receitas do Estado do Rio de Janeiro.

  1. Parâmetros do Sistema;
  2. Web Service de Requisição de Dados;
  3. Mensagens de Retorno das Requisições dos Web Services;

1. Parâmetros do Sistema

No quadro abaixo estão listados os parâmetros da despesa acumulada.

Ref.
Parâmetro
Definição
Obrigatório
Valor
Mensagens
1
posicao
Posição
Sim
DD/MM/AAAA
Ex.: 01/07/2015
MSG001 – Caso o parâmetro seja inválido
MSG002 – Caso o parâmetro não seja informado.
MSG003 – Caso a posição não seja informada.
MSG004 – Caso a posição esteja no formato errado.
2
codigoUo
Código da Unidade Orçamentária
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
3
codigoUg
Código da Unidade Gestora
Não
6 numéricos
MSG001 – Caso o parâmetro seja inválido  
4
codigoFonte
Código da Fonte de Recursos
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido  
5
codigoFuncao
Código da Função
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
6
codigoSubfuncao
Código da Sub Função
Não
3 numéricos
MSG001 – Caso o parâmetro seja inválido  
7
codigoGrupo
Código do Grupo de Despesa
Não
1 numérico
MSG001 – Caso o parâmetro seja inválido  
8
codigoPrograma
Código do Programa de Trabalho
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
9
codigoProjeto
Código do Projeto/Atividade
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
10
codigoGestao
Código da Gestão
Não
5 numéricos
MSG001 – Caso o parâmetro seja inválido
11
codigoModalidade
Código da Modalidade
Não
2 numéricos
MSG010 – Caso o parâmetro seja inválido
12
codigoClassificacao
Código da Classificação Econômica
Não
1 numérico
MSG001 – Caso o parâmetro seja inválido
13
codigoPoder
Código do Poder
Não
1 numérico
MSG001 – Caso o parâmetro seja inválido
14
codigoOrgao
Código do Órgão
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
15
codigoSubElemento
Código do Sub Elemento
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
16
codigoElemento
Código do Elemento
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido

No quadro abaixo estão listados os parâmetros da despesa mensal.

Ref.
Parâmetro
Definição
Obrigatório
Valor
Mensagens
1
posicao
Posição
Sim
MM/AAAA
Ex.: 07/2015
MSG001 – Caso o parâmetro seja inválido
MSG002 – Caso o parâmetro não seja informado.
MSG003 – Caso a posição não seja informada.
MSG004 – Caso a posição esteja no formato errado.
2
codigoUo
Código da Unidade Orçamentária
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
3
codigoUg
Código da Unidade Gestora
Não
6 numéricos
MSG001 – Caso o parâmetro seja inválido
4
codigoFonte
Código da Fonte de Recursos
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
5
codigoFuncao
Código da Função
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
6
codigoSubfuncao
Código da Sub Função
Não
3 numéricos
MSG001 – Caso o parâmetro seja inválido
7
codigoGrupo
Código do Grupo de Despesa
Não
1 numérico
MSG001 – Caso o parâmetro seja inválido
8
codigoPrograma
Código do Programa de Trabalho
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
9
codigoProjeto
Código do Projeto/Atividade
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
10
codigoGestao
Código da Gestão
Não
5 numéricos
MSG001 – Caso o parâmetro seja inválido
11
codigoModalidade
Código da Modalidade
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
12
codigoClassificacao
Código da Classificação Econômica
Não
1 numérico
MSG001 – Caso o parâmetro seja inválido
13
codigoPoder
Código do Poder
Não
1 numérico
MSG001 – Caso o parâmetro seja inválido
14
codigoOrgao
Código do Órgão
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
15
codigoSubElemento
Código do Sub Elemento
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
16
codigoElemento
Código do Elemento
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido

No quadro abaixo estão listados os parâmetros da receita acumulada.

Ref.
Parâmetro
Definição
Obrigatório
Valor
Mensagens
1
posicao
Posição
Sim
DD/MM/AAAA
Ex.: 01/07/2015
MSG001 – Caso o parâmetro seja inválido
MSG002 – Caso o parâmetro não seja informado.
MSG003 – Caso a posição não seja informada.
MSG004 – Caso a posição esteja no formato errado.
2
codigoPoder
Código do Porder
Não
1 numéricos
MSG001 – Caso o parâmetro seja inválido
3
codigoUo
Código da Unidade Orçamentária
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
4
codigoFonte
Código da Fonte de Recursos
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
5
codigoFontedetalhada
Código da Sub Função
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
6
codigoCategoria
Código de Categoria Econômica
Não
8 numérico
MSG001 – Caso o parâmetro seja inválido
7
codigoUg
Código da Unidade Gestora
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
8
codigoRecfonte
Código de Receita por Fonte
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
9
codigoRecsubfonte
Código de Receita por Subfonte
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
10
codigoRecrubrica
Código de Receita por Rubrica
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
11
codigoRecalinea
Código de Receita por Alínea
Não
8 numérico
MSG001 – Caso o parâmetro seja inválido
12
codigoRecsubalinea
Código de Receita por Subalínea
Não
8 numérico
MSG001 – Caso o parâmetro seja inválido

No quadro abaixo estão listados os parâmetros da receita mensal.

Ref.
Parâmetro
Definição
Obrigatório
Valor
Mensagens
1
posicao
Posição
Sim
MM/AAAA
Ex.: 07/2015
MSG001 – Caso o parâmetro seja inválido
MSG002 – Caso o parâmetro não seja informado.
MSG003 – Caso a posição não seja informada.
MSG004 – Caso a posição esteja no formato errado.
2
codigoPoder
Código do Porder
Não
1 numéricos
MSG001 – Caso o parâmetro seja inválido
3
codigoUo
Código da Unidade Orçamentária
Não
4 numéricos
MSG001 – Caso o parâmetro seja inválido
4
codigoFonte
Código da Fonte de Recursos
Não
2 numéricos
MSG001 – Caso o parâmetro seja inválido
5
codigoFontedetalhada
Código da Sub Função
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
6
codigoCategoria
Código de Categoria Econômica
Não
8 numérico
MSG001 – Caso o parâmetro seja inválido
7
codigoUg
Código da Unidade Gestora
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
8
codigoRecfonte
Código de Receita por Fonte
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
9
codigoRecsubfonte
Código de Receita por Subfonte
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
10
codigoRecrubrica
Código de Receita por Rubrica
Não
8 numéricos
MSG001 – Caso o parâmetro seja inválido
11
codigoRecalinea
Código de Receita por Alínea
Não
8 numérico
MSG001 – Caso o parâmetro seja inválido
12
codigoRecsubalinea
Código de Receita por Subalínea
Não
8 numérico
MSG001 – Caso o parâmetro seja inválido

2. Web Service de Requisição de Dados

Este serviço recebe as requisições dos sistemas de informação que é implementado pelo método TransparenciaERJ, localizado na classe br.gov.rj.fazenda.tfews.services.impl.TransparenciaERJ.

Ao iniciar a aplicação, o serviço é publicado na URL http://<IP do server>:<porta>/tfe-ws-web/TransparenciaERJService?wsdl.

Para alterar o nome do serviço, pode-se utilizar o parâmetro serviceName, da anotação @WebService, que anota a classe TransparenciaERJ.

        
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://fazenda.rj.gov.br/ws/Financas/TransparenciaERJ">
       <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://fazenda.rj.gov.br/ws/Financas/TransparenciaERJ">
       <soapenv:Header/>
       <soapenv:Body>
          <tran:TransparenciaERJDespesa>
             <!--Optional:-->
             <arg0>
                <posicao>?</posicao>
                <!--Optional:-->
                <codigoUo>?</codigoUo>
                <!--Optional:-->
                <codigoUg>?</codigoUg>
                <!--Optional:-->
                <codigoFonte>?</codigoFonte>
                <!--Optional:-->
                <codigoFuncao>?</codigoFuncao>
                <!--Optional:-->
                <codigoSubfuncao>?</codigoSubfuncao>
                <!--Optional:-->
                <codigoGrupo>?</codigoGrupo>
                <!--Optional:-->
                <codigoPrograma>?</codigoPrograma>
                <!--Optional:-->
                <codigoProjeto>?</codigoProjeto>
                <!--Optional:-->
                <codigoGestao>?</codigoGestao>
                <!--Optional:-->
                <codigoModalidade>?</codigoModalidade>
                <!--Optional:-->
                <codigoClassificacao>?</codigoClassificacao>
                <!--Optional:-->
                <codigoPoder>?</codigoPoder>
                <!--Optional:-->
                <codigoOrgao>?</codigoOrgao>
                <!--Optional:-->
                <codigoSubElemento>?</codigoSubElemento>
                <!--Optional:-->
                <codigoElemento>?</codigoElemento>
             </arg0>
          </tran:TransparenciaERJDespesa>
       </soapenv:Body>
    </soapenv:Envelope>
    
    

Listagem 1. Exemplo de chamada ao serviço de informações da despesa acumulada.

        
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://fazenda.rj.gov.br/ws/Financas/TransparenciaERJ">
       <soapenv:Header/>
       <soapenv:Body>
          <tran:TransparenciaERJDespesaMensal>
             <!--Optional:-->
             <arg0>
                <posicao>?</posicao>
                <!--Optional:-->
                <codigoUo>?</codigoUo>
                <!--Optional:-->
                <codigoUg>?</codigoUg>
                <!--Optional:-->
                <codigoFonte>?</codigoFonte>
                <!--Optional:-->
                <codigoFuncao>?</codigoFuncao>
                <!--Optional:-->
                <codigoSubfuncao>?</codigoSubfuncao>
                <!--Optional:-->
                <codigoGrupo>?</codigoGrupo>
                <!--Optional:-->
                <codigoPrograma>?</codigoPrograma>
                <!--Optional:-->
                <codigoProjeto>?</codigoProjeto>
                <!--Optional:-->
                <codigoGestao>?</codigoGestao>
                <!--Optional:-->
                <codigoModalidade>?</codigoModalidade>
                <!--Optional:-->
                <codigoClassificacao>?</codigoClassificacao>
                <!--Optional:-->
                <codigoPoder>?</codigoPoder>
                <!--Optional:-->
                <codigoOrgao>?</codigoOrgao>
                <!--Optional:-->
                <codigoSubElemento>?</codigoSubElemento>
                <!--Optional:-->
                <codigoElemento>?</codigoElemento>
             </arg0>
          </tran:TransparenciaERJDespesaMensal>
       </soapenv:Body>
    </soapenv:Envelope>
    
    

Listagem 2. Exemplo de chamada ao serviço de informações da despesa mensal.

        
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://fazenda.rj.gov.br/ws/Financas/TransparenciaERJ">
       <soapenv:Header/>
       <soapenv:Body>
          <tran:TransparenciaERJReceita>
             <!--Optional:-->
             <arg0>
                <posicao>?</posicao>
                <!--Optional:-->
                <codigoPoder>?</codigoPoder>
                <!--Optional:-->
                <codigoUo>?</codigoUo>
                <!--Optional:-->
                <codigoFonte>?</codigoFonte>
                <!--Optional:-->
                <codigoCategoria>?</codigoCategoria>
                <!--Optional:-->
                <codigoUg>?</codigoUg>
                <!--Optional:-->
                <codigoRecfonte>?</codigoRecfonte>
                <!--Optional:-->
                <codigoRecsubfonte>?</codigoRecsubfonte>
                <!--Optional:-->
                <codigoRecrubrica>?</codigoRecrubrica>
                <!--Optional:-->
                <codigoRecalinea>?</codigoRecalinea>
                <!--Optional:-->
                <codigoRecsubalinea>?</codigoRecsubalinea>
             </arg0>
          </tran:TransparenciaERJReceita>
       </soapenv:Body>
    </soapenv:Envelope>
    
    

Listagem 3. Exemplo de chamada ao serviço de informações da receita acumulada.

        
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://fazenda.rj.gov.br/ws/Financas/TransparenciaERJ">
       <soapenv:Header/>
       <soapenv:Body>
          <tran:TransparenciaERJReceita>
             <!--Optional:-->
             <arg0>
                <posicao>?</posicao>
                <!--Optional:-->
                <codigoPoder>?</codigoPoder>
                <!--Optional:-->
                <codigoUo>?</codigoUo>
                <!--Optional:-->
                <codigoFonte>?</codigoFonte>
                <!--Optional:-->
                <codigoCategoria>?</codigoCategoria>
                <!--Optional:-->
                <codigoUg>?</codigoUg>
                <!--Optional:-->
                <codigoRecfonte>?</codigoRecfonte>
                <!--Optional:-->
                <codigoRecsubfonte>?</codigoRecsubfonte>
                <!--Optional:-->
                <codigoRecrubrica>?</codigoRecrubrica>
                <!--Optional:-->
                <codigoRecalinea>?</codigoRecalinea>
                <!--Optional:-->
                <codigoRecsubalinea>?</codigoRecsubalinea>
             </arg0>
          </tran:TransparenciaERJReceita>
       </soapenv:Body>
    </soapenv:Envelope>
    
    

Listagem 4. Exemplo de chamada ao serviço de informações da receita mensal.

3. Mensagens de Retorno das Requisições dos Web Services

  • MSG001: “Parâmetro [nome do parâmetro] inválidos.”
  • MSG002: “Parâmetro [nome do parâmetro] não informado.”
  • MSG003: “Não foi informada a posição.”
  • MSG004: “Posição com formato inválido.”

SECRETARIA DE ESTADO DE FAZENDA
DO RIO DE JANEIRO

Av Presidente Vargas, n° 670 - Rio de Janeiro /RJ
CEP: 20071-001 - Telefone Geral: (21) 2334-4300

FALE COM A EQUIPE DO
PORTAL TRANSPARÊNCIA

E-mail: transparencia@fazenda.rj.gov.br
Horário de Atendimento: segunda-feira a sexta-feira das 10h às 18h