Webservices Módulo Módulo Conta Pública Fácil

Webservice disponibilizados para a integração com a Solução de Conta Pública

O acesso a este serviço é realizado utilizando o endereço {GRP}/service .

Para alguns dos serviços abaixo deve ser encaminhado a chave de autenticação, que deve ser obtida no serviço Autenticação.

Lista os grupos de despesas configurados via WebServices {GRP}/service/contabilidade/transparencia/grupoReceitas/grupoReceitas .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"modelo": "LDPT"
}

JSON Body RESPONSE:

{
        "descricao": "Grupo de Exemplo",
        "sequencia": 18,
        "movimento": "S",
        "cliente": null,
        "modelo": null,
        "nivel": null,
        "posicao": null,
        "tipo": null,
        "sequenciaSuperior": null,
        "adicao": null,
        "imagem": ""
}

Consulta dos valores totais empenhados, liquidados e pagos por credor para determinado grupo de despesa via WebServices {GRP}/service/balanceteDespesaRestService/recuperaDespesasPorCredorRest .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"",
	"exercicio":2020,
	"mes":"5",
	"recursoContabil":"",
	"codigoDestinacao":"",
	"modelo":"LDPT",
	"sequencia":18,
	"numeroEmpenho":null,
	"codigoRubricaEmpenho":null
}

JSON Body RESPONSE:

{
            "orgao": null,
            "unidade": null,
            "codigoOrcamentario": null,
            "identificacao": null,
            "codigoFormatado": null,
            "titulo": null,
            "administracao": null,
            "nomeOrgao": null,
            "nomeUnidade": null,
            "exercicio": null,
            "nomeRubrica": null,
            "dotacaoInicial": null,
            "dotacaoAtualizada": null,
            "empenhadoExercicio": null,
            "liquidadoExercicio": null,
            "pagoExercicio": null,
            "totalDotacaoInicial": null,
            "totalDotacaoAtualizada": null,
            "totalEmpenhado": "13823.95",
            "totalLiquidado": "5241.61",
            "totalPago": "2882.96",
            "nomeCliente": null,
            "codigo": null,
            "mostrarBalancete": false,
            "mes": null,
            "recurso": null,
            "destinacao": null,
            "anoMes": null,
            "nome": "EMPRESA EXEMPLO",
            "numeroEmpenho": null,
            "dataEmpenho": null,
            "empenho": null,
            "nomeCategoria": null,
            "rubrica": null,
            "valor": null,
            "anulado": null,
            "liquidado": 2895.45,
            "pago": 911.65,
            "totalAnulado": null,
            "empenhado": 8547.78,
            "identificacaoFormatada": "99.999.999/9999-99",
            "identificacaoCrypto": "ABCDFGHIJKLMNOPQRSTUVWXYZ0123456"
}

Consulta dos empenhos para determinado credor no grupo de despesa via WebServices {GRP}/service/balanceteDespesaRestService/recuperaDespesasPorEmpenhoRest .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":null,
	"exercicio":2020,
	"mes":"5",
	"recursoContabil":null,
	"codigoDestinacao":null,
	"identificacao":"ABCDFGHIJKLMNOPQRSTUVWXYZ0123456",
	"stnModelo":"LDPT",
	"stnSequencia":18,
	"numeroEmpenho":null,
	"codigoRubricaEmpenho":null,
	"dataEmpenhoInicial":"",
	"dataEmpenhoFinal":""
}

JSON Body RESPONSE:

{
            "orgao": null,
            "unidade": "01",
            "codigoOrcamentario": "33903000000000",
            "identificacao": null,
            "codigoFormatado": null,
            "titulo": null,
            "administracao": "1",
            "nomeOrgao": null,
            "nomeUnidade": null,
            "exercicio": null,
            "nomeRubrica": null,
            "dotacaoInicial": null,
            "dotacaoAtualizada": null,
            "empenhadoExercicio": null,
            "liquidadoExercicio": null,
            "pagoExercicio": null,
            "totalDotacaoInicial": null,
            "totalDotacaoAtualizada": null,
            "totalEmpenhado": "11091.78",
            "totalLiquidado": "4439.45",
            "totalPago": "911.65",
            "nomeCliente": null,
            "codigo": null,
            "mostrarBalancete": false,
            "mes": null,
            "recurso": "0001",
            "destinacao": "13100",
            "anoMes": null,
            "nome": "EMPRESA EXEMPLO",
            "numeroEmpenho": "9900021",
            "dataEmpenho": "2020-04-28T00:00:00-0300",
            "empenho": "1-2020/9900021",
            "nomeCategoria": "Categoria de Exemplo",
            "rubrica": "OUTROS MATERIAIS DE CONSUMO",
            "valor": 1000.0,
            "anulado": 0.0,
            "liquidado": 890.0,
            "pago": 890.0,
            "totalAnulado": 1000.0,
            "empenhado": null,
            "identificacaoFormatada": "99.999.999/9999-99",
            "identificacaoCrypto": null
}

Consulta dos detalhes de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/detalhes .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"anoMes":"20205",
	"recursoContabil":null,
	"codigoDestinacao":null,
	"orgaoContabil":null,
	"unidadeContabil":null,
	"codigoOrcamentario":null,
	"identificacao":null,
	"stnModelo":null,
	"stnSequencia":null,
	"numeroEmpenho":"9900021",
	"codigoRubricaEmpenho":null
}

JSON Body RESPONSE:

{
    "nomeOperacao": null,
    "dataOperacao": null,
    "exercicioOperacao": null,
    "numeroOperacao": null,
    "exercicioNumero": null,
    "valorOperacao": null,
    "descricaoOperacao": null,
    "empenho": "1-2020/9900021",
    "dataEmpenho": "2020-04-28T00:00:00-0300",
    "dsAdministracao": "Thema Informática Ltda",
    "orgao": null,
    "unidade": null,
    "funcao": null,
    "subFuncao": null,
    "programa": null,
    "subCodigo": null,
    "acao": null,
    "rubrica": null,
    "recurso": null,
    "destinacao": null,
    "descricao": "Aquisição de materiais de expediente",
    "valorEmpenhado": null,
    "valorAnulado": null,
    "valorLiquidado": null,
    "valorPago": null,
    "valorALiquidar": null,
    "valorAPagar": null,
    "matricula": null,
    "descricaoCargo": null,
    "administracao": "1",
    "exercicio": "2020",
    "numeroEmpenho": "9900021",
    "inscricao": "5169586",
    "categoriaEmpenho": "1",
    "identificacao": null,
    "nome": null,
    "tpPessoa": null,
    "nomeOrgao": null,
    "dotacaoInicial": null,
    "dotacaoAtualizada": null,
    "empenhadoExercicio": null,
    "liquidadoExercicio": null,
    "anoMes": null
}

Consulta as informações orçamentárias de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/detalhamentoOrcamentario .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"anoMes":"20205",
	"recursoContabil":null,
	"codigoDestinacao":null,
	"orgaoContabil":null,
	"unidadeContabil":null,
	"codigoOrcamentario":null,
	"identificacao":null,
	"stnModelo":null,
	"stnSequencia":null,
	"numeroEmpenho":"9900021",
	"codigoRubricaEmpenho":null
}

JSON Body RESPONSE:

{
    "nomeOperacao": null,
    "dataOperacao": null,
    "exercicioOperacao": null,
    "numeroOperacao": null,
    "exercicioNumero": null,
    "valorOperacao": null,
    "descricaoOperacao": null,
    "empenho": null,
    "dataEmpenho": null,
    "dsAdministracao": null,
    "orgao": "02 - ÓRGÃO EXEMPLO",
    "unidade": "01 - UNIDADE EXEMPLO",
    "funcao": "04 - FUNÇÃO EXEMPLO ",
    "subFuncao": "122 - SUBFUNÇÃO EXEMPLO",
    "programa": "0001 - PROGRAMA EXEMPLO ",
    "subCodigo": " - ",
    "acao": "2010 - AÇÃO EXEMPLO",
    "rubrica": "3.3.9.0.30.99.00.00.00 - OUTROS MATERIAIS DE CONSUMO",
    "recurso": "0001 - RECURSO LIVRE",
    "destinacao": "00001 - DESTINAÇÃO EXEMPLO",
    "descricao": null,
    "valorEmpenhado": null,
    "valorAnulado": null,
    "valorLiquidado": null,
    "valorPago": null,
    "valorALiquidar": null,
    "valorAPagar": null,
    "matricula": null,
    "descricaoCargo": null,
    "administracao": null,
    "exercicio": null,
    "numeroEmpenho": null,
    "inscricao": null,
    "categoriaEmpenho": null,
    "identificacao": null,
    "nome": null,
    "tpPessoa": null,
    "nomeOrgao": null,
    "dotacaoInicial": null,
    "dotacaoAtualizada": null,
    "empenhadoExercicio": null,
    "liquidadoExercicio": null,
    "anoMes": null
}

Consulta as informações dos valores de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/valores .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"anoMes":"20205",
	"recursoContabil":null,
	"codigoDestinacao":null,
	"orgaoContabil":null,
	"unidadeContabil":null,
	"codigoOrcamentario":null,
	"identificacao":null,
	"stnModelo":null,
	"stnSequencia":null,
	"numeroEmpenho":"9900021",
	"codigoRubricaEmpenho":null
}

JSON Body RESPONSE:

{
    "nomeOperacao": null,
    "dataOperacao": null,
    "exercicioOperacao": null,
    "numeroOperacao": null,
    "exercicioNumero": null,
    "valorOperacao": null,
    "descricaoOperacao": null,
    "empenho": null,
    "dataEmpenho": null,
    "dsAdministracao": null,
    "orgao": null,
    "unidade": null,
    "funcao": null,
    "subFuncao": null,
    "programa": null,
    "subCodigo": null,
    "acao": null,
    "rubrica": null,
    "recurso": null,
    "destinacao": null,
    "descricao": null,
    "valorEmpenhado": 1000.0,
    "valorAnulado": 0.0,
    "valorLiquidado": 890.0,
    "valorPago": 890.0,
    "valorALiquidar": 110.0,
    "valorAPagar": 110.0,
    "matricula": null,
    "descricaoCargo": null,
    "administracao": null,
    "exercicio": null,
    "numeroEmpenho": null,
    "inscricao": null,
    "categoriaEmpenho": null,
    "identificacao": null,
    "nome": null,
    "tpPessoa": null,
    "nomeOrgao": null,
    "dotacaoInicial": null,
    "dotacaoAtualizada": null,
    "empenhadoExercicio": null,
    "liquidadoExercicio": null,
    "anoMes": null
}

Consulta as informações do credor de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/credor .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"anoMes":"20205",
	"recursoContabil":null,
	"codigoDestinacao":null,
	"orgaoContabil":null,
	"unidadeContabil":null,
	"codigoOrcamentario":null,
	"identificacao":null,
	"stnModelo":null,
	"stnSequencia":null,
	"numeroEmpenho":"9900021",
	"codigoRubricaEmpenho":null
}

JSON Body RESPONSE:

{
    "nomeOperacao": null,
    "dataOperacao": null,
    "exercicioOperacao": null,
    "numeroOperacao": null,
    "exercicioNumero": null,
    "valorOperacao": null,
    "descricaoOperacao": null,
    "empenho": null,
    "dataEmpenho": null,
    "dsAdministracao": null,
    "orgao": null,
    "unidade": null,
    "funcao": null,
    "subFuncao": null,
    "programa": null,
    "subCodigo": null,
    "acao": null,
    "rubrica": null,
    "recurso": null,
    "destinacao": null,
    "descricao": null,
    "valorEmpenhado": null,
    "valorAnulado": null,
    "valorLiquidado": null,
    "valorPago": null,
    "valorALiquidar": null,
    "valorAPagar": null,
    "matricula": null,
    "descricaoCargo": null,
    "administracao": null,
    "exercicio": null,
    "numeroEmpenho": null,
    "inscricao": null,
    "categoriaEmpenho": null,
    "identificacao": "99.999.999/9999-99",
    "nome": "EMPRESA EXEMPLO",
    "tpPessoa": "J",
    "nomeOrgao": null,
    "dotacaoInicial": null,
    "dotacaoAtualizada": null,
    "empenhadoExercicio": null,
    "liquidadoExercicio": null,
    "anoMes": null
}

Consulta as informações de referências de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/baseLegal .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"exercicio":"2020",
	"numeroEmpenho":"9900021"
}

JSON Body RESPONSE:

{
    "tipoProtocoloNome": ADMINISTRATIVO,
    "exercicioNumeroProtocolo": "2020/1",
    "processo": "ADMINISTRATIVO 2020/1",
    "nomeBase": "Dispensado",
    "dsModalidade": "Dispensa Lei 8666",
    "numeroOrdem": "2020/100",
    "licitacaoEmpenho": "2020/50",
    "contratoEmpenho": "2020/15",
    "convenioEmpenho": "2020/18",
    "documentoCompras": "123456789",
    "formaPagamento": "A vista"
}

Consulta as informações de referências de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/itens .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"exercicio":"2020",
	"numeroEmpenho":"9900021"
}

JSON Body RESPONSE:

{
        "administracao": 1,
        "exercicio": "2020",
        "numeroEmpenho": 9900021,
        "sequencia": 1,
        "quantidade": 100.0,
        "unidade": "Unidade",
        "descricao": "Descrição do material/bem/serviço empenhado",
        "valorUnitario": 10.0,
        "valorTotal": 1000.0,
        "quantidadeInteira": 100
}

Consulta as informações dos movimentos de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/operacoes .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"anoMes":"20205",
	"recursoContabil":null,
	"codigoDestinacao":null,
	"orgaoContabil":null,
	"unidadeContabil":null,
	"exercicioEmpenho":null,
	"numeroEmpenho":"9900021"
}

JSON Body RESPONSE:

{
        "nomeOperacao": "Liquidação",
        "dataOperacao": "2020-04-28T00:00:00-0300",
        "exercicioOperacao": null,
        "numeroOperacao": null,
        "exercicioNumero": "2020/9900018",
        "valorOperacao": 1000.0,
        "descricaoOperacao": "[415444-1] Liquidação total do empenho",
        "empenho": null,
        "dataEmpenho": null,
        "dsAdministracao": null,
        "orgao": null,
        "unidade": null,
        "funcao": null,
        "subFuncao": null,
        "programa": null,
        "subCodigo": null,
        "acao": null,
        "rubrica": null,
        "recurso": null,
        "destinacao": null,
        "descricao": null,
        "valorEmpenhado": null,
        "valorAnulado": null,
        "valorLiquidado": null,
        "valorPago": null,
        "valorALiquidar": null,
        "valorAPagar": null,
        "matricula": null,
        "descricaoCargo": null,
        "administracao": null,
        "exercicio": null,
        "numeroEmpenho": null,
        "inscricao": null,
        "categoriaEmpenho": null,
        "identificacao": null,
        "nome": null,
        "tpPessoa": null,
        "nomeOrgao": null,
        "dotacaoInicial": null,
        "dotacaoAtualizada": null,
        "empenhadoExercicio": null,
        "liquidadoExercicio": null,
        "anoMes": null
}

Consulta as informações dos movimentos de determinado empenho via WebServices {GRP}/service/contabilidade/transparencia/detalhesEmpenho/liquidacoesComprovantes .
Para realizar a consulta devem ser informados os seguintes atributos:


Como resultado, são retornados as seguintes informações:

Este serviço é disponibilizado sem a necessidade de autenticação.
Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

JSON Body REQUEST:

{
	"administracao":"1",
	"exercicio":"2020",
	"numeroEmpenho":"9900021"
}

JSON Body RESPONSE:

    {
        "liquidacao": "1-2020/9900018",
        "dataLiquidacao": "2020-04-28T00:00:00-0300",
        "observacao": "Liquidação total do empenho",
        "valorLiquidacao": 1000.0,
        "tipoComprovante": "Nota Fiscal",
        "descricaoDocumento": "Data emissão: 28/04/2020, documento: 415444/1",
        "valorDocumento": 1000.0,
        "totalValorLiquidacao": 1000.0
    }