{ "openapi": "3.0.1", "info": { "title": "ÁGILIBlue - Contabilidade", "description": "Documentação da Api da Transparência \r\n
É necessário obter alguns dados com a Entidade para obter acesso a API.\r\n
Para solicitar a chave de acesso entre em contato com a Entidade e informe o 'Identificador da chave': 'Contabilidade' \r\n
", "contact": { "name": "Suporte Técnico Ágili Software Brasil", "url": "http://cliente.agili.com.br/" }, "version": "V1" }, "paths": { "/public/v1/Autenticacao/login": { "post": { "tags": [ "Autenticacao" ], "summary": "Criação do Token de acesso a API.", "parameters": [ { "name": "cnpjEntidade", "in": "query", "description": "CNPJ da Entidade que deseja acessar a API", "schema": { "type": "string" } }, { "name": "identificadorChave", "in": "query", "description": "Identificador da chave que foi informado pela Entidade.", "schema": { "type": "string" } }, { "name": "chave", "in": "query", "description": "Chave de acesso fornecido pela Entidade.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterUnidadesGestoras": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnumValue" } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterDadosEmpenhosPorExercicio": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "Lista os empenhos por exercício", "parameters": [ { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "exercicio", "in": "query", "description": "Exercício", "schema": { "type": "integer", "format": "int32" } }, { "name": "valoresAte", "in": "query", "description": "Valores até a data (formato DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } }, { "name": "adicionaTotalPaginas", "in": "query", "description": "Indica se irá retornar o total de paginas/registros, só solicitar com total no primeiro acionamento, pois há um custo para executar esta contabilização\r\n fazendo com que o resultado seja mais lento com o tempo. No primeiro acionamento você terá o total para determinado filtro, até que o filtro modifique manter o total de páginas do primeiro acionamento", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Sucess", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmpenhosPorExercicioGridDtoPageResult" } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterSaldosEmpenho": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "Exibe os saldos do empenho", "parameters": [ { "name": "id", "in": "query", "description": "id do empenho", "schema": { "type": "integer", "format": "int64" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaldosEmpenhoDto" } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterDadosDetalhados": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "Exibe os dados detalhados do empenho", "parameters": [ { "name": "id", "in": "query", "description": "id do empenho", "schema": { "type": "integer", "format": "int64" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosDetalhadosDespesaDto" } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterFasesRelacionadas": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "Lista as fases relacionadas ao empenho", "parameters": [ { "name": "id", "in": "query", "description": "id do empenho", "schema": { "type": "integer", "format": "int64" } }, { "name": "exercicio", "in": "query", "description": "Exercício do empenho", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FasesRelacionadasGridDto" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterItens": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "Lista os itens do empenho", "parameters": [ { "name": "id", "in": "query", "description": "id do empenho", "schema": { "type": "integer", "format": "int64" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItensDespesaGridDto" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/despesas/EmpenhosPorExercicio/ObterDocumentosFiscais": { "get": { "tags": [ "EmpenhosPorExercicio" ], "summary": "Lista os documentos fiscais do empenho", "parameters": [ { "name": "id", "in": "query", "description": "id do empenho", "schema": { "type": "integer", "format": "int64" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentosFiscaisGridDto" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/{cnpjcliente}/nucleo/PublicacaoAPI/ObterArquivoPublicacao": { "get": { "tags": [ "PublicacaoAPI" ], "parameters": [ { "name": "idTransparenciaArquivo", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "cnpjcliente", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/receitas/ReceitasPorPeriodo/ObterDadosReceitasPorPeriodo": { "get": { "tags": [ "ReceitasPorPeriodo" ], "summary": "Lista os movimentos das receitas por período", "parameters": [ { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dataMovimentoInicial", "in": "query", "description": "Data do movimento (valor inicial formato DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "dataMovimentoFinal", "in": "query", "description": "Data do movimento (valor final formato DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "idEspecie", "in": "query", "description": "id da espécie", "schema": { "type": "integer", "format": "int64" } }, { "name": "idReceita", "in": "query", "description": "id da receita", "schema": { "type": "integer", "format": "int64" } }, { "name": "covid19", "in": "query", "description": "COVID-19", "schema": { "type": "boolean" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReceitasPorPeriodoGridDto" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/receitas/ReceitasPorPeriodo/ObterEspecie": { "get": { "tags": [ "ReceitasPorPeriodo" ], "summary": "Lista as espécies", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/receitas/ReceitasPorPeriodo/ObterReceita": { "get": { "tags": [ "ReceitasPorPeriodo" ], "summary": "Lista as receitas", "parameters": [ { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } }, "/public/v1/contabilidade/receitas/ReceitasPorPeriodo/ObterDestinacaoRecursos": { "get": { "tags": [ "ReceitasPorPeriodo" ], "summary": "Lista a destinação dos recursos provenientes da receita", "parameters": [ { "name": "id", "in": "query", "description": "id do movimento da receita", "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Número da página atual (iniciando em 1) (Valor mínimo: 1)", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Quantidade de registros por página (Intervalo permitido: 1-1000)", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "idUnidadeGestora", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FonteRecursosGridDto" } } } } }, "401": { "description": "Não autorizado. Você não possui token de acesso válido." }, "403": { "description": "Acesso negado. Você não tem permissão para acessar." }, "400": { "description": "Solicitação Incorreta. Indica que o servidor não pode ou não irá processar a requisição." }, "429": { "description": "Muitas requisições. Permitido 600 requisições por minuto." }, "500": { "description": "Validações ou erro interno." } } } } }, "components": { "schemas": { "AcessoModulo": { "type": "object", "properties": { "modulo": { "$ref": "#/components/schemas/ModuloEnum" }, "shortName": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "dataAcesso": { "type": "string", "format": "date-time" }, "dataAcessoAnterior": { "type": "string", "format": "date-time", "nullable": true }, "primeiroAcesso": { "type": "boolean" }, "exercicio": { "type": "integer", "format": "int32" }, "mes": { "type": "integer", "format": "int32" }, "exercicioMes": { "type": "string", "nullable": true }, "descricaoMes": { "type": "string", "nullable": true }, "dia": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AlignEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "ArquivoDocumentoDownloadDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "idDocumento": { "type": "integer", "format": "int64" }, "nomeArquivo": { "type": "string", "nullable": true }, "nomeArquivoComExtensao": { "type": "string", "nullable": true, "readOnly": true }, "extensaoArquivo": { "type": "string", "nullable": true }, "idExtensaoArquivo": { "$ref": "#/components/schemas/ExtensaoArquivoEnum" }, "arquivo": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "ClassificacaoDespesaEnum": { "enum": [ -10, -9, -8, -7, -6, -5, -4, -3, -2, -1 ], "type": "integer", "format": "int64" }, "CorTemaEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "format": "int32" }, "DadosDetalhadosDespesaDto": { "type": "object", "properties": { "historico": { "type": "string", "nullable": true }, "esfera": { "type": "string", "nullable": true }, "fonteRecurso": { "type": "string", "nullable": true }, "unidadeOrcamentaria": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "subFuncao": { "type": "string", "nullable": true }, "programa": { "type": "string", "nullable": true }, "acao": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "grupo": { "type": "string", "nullable": true }, "modalidade": { "type": "string", "nullable": true }, "elementoDespesa": { "type": "string", "nullable": true }, "subElementoDespesa": { "type": "string", "nullable": true }, "numeroProcesso": { "type": "string", "nullable": true }, "licitacao": { "type": "string", "nullable": true }, "modalidadeLicitacao": { "type": "string", "nullable": true }, "formaRealizacaoLicitacao": { "type": "string", "nullable": true, "readOnly": true }, "idFormaRealizacaoLicitacao": { "type": "integer", "format": "int64", "nullable": true }, "descricaoObjetoLicitacao": { "type": "string", "nullable": true }, "convenio": { "type": "string", "nullable": true }, "contrato": { "type": "string", "nullable": true }, "codUO": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentosFiscaisGridDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tipo": { "type": "string", "nullable": true }, "data": { "type": "string", "format": "date-time", "nullable": true }, "numero": { "type": "string", "nullable": true }, "cpfCnpjFormatado": { "type": "string", "nullable": true, "readOnly": true }, "cpfcnpj": { "type": "string", "nullable": true }, "nomeRazaoSocial": { "type": "string", "nullable": true }, "serie": { "type": "string", "nullable": true }, "aidf": { "type": "string", "nullable": true }, "chaveVerificacao": { "type": "string", "nullable": true }, "pathDocumentoFiscal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmpenhosPorExercicioGridDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "unidadeGestora": { "type": "string", "nullable": true }, "numeroAno": { "type": "string", "nullable": true }, "tipoEmpenho": { "type": "string", "nullable": true, "readOnly": true }, "dataEmpenho": { "type": "string", "format": "date-time", "nullable": true }, "orgao": { "type": "string", "nullable": true }, "unidadeOrc": { "type": "string", "nullable": true }, "funcao": { "type": "string", "nullable": true }, "subfuncao": { "type": "string", "nullable": true }, "naturezaDespesa": { "type": "string", "nullable": true }, "elementoDespesa": { "type": "string", "nullable": true }, "fonteRecurso": { "type": "string", "nullable": true }, "classificacaoDespesa": { "type": "string", "nullable": true, "readOnly": true }, "cpfCnpjFavorecidoFormatado": { "type": "string", "nullable": true, "readOnly": true }, "cpfcnpjFavorecido": { "type": "string", "nullable": true }, "nomeFavorecido": { "type": "string", "nullable": true }, "empenhado": { "type": "number", "format": "double", "nullable": true }, "licitacao": { "type": "string", "nullable": true }, "idUnidadeGestora": { "type": "integer", "format": "int64" }, "idEstrutFonteRecurso": { "type": "integer", "format": "int64" }, "idFuncaoGoverno": { "type": "integer", "format": "int64" }, "idSubFuncaoGoverno": { "type": "integer", "format": "int64" }, "idNaturezaDespesa": { "type": "integer", "format": "int64" }, "idTipoEmpenho": { "$ref": "#/components/schemas/TipoEmpenhoEnum" }, "idElementoDespesa": { "type": "integer", "format": "int64" }, "idClassifDespesaCovid19": { "type": "boolean" }, "filtroExercicio": { "type": "integer", "format": "int32" }, "filtroDataLimite": { "type": "string", "format": "date-time", "nullable": true }, "favorecido": { "type": "string", "nullable": true }, "idFundo": { "type": "integer", "format": "int64", "nullable": true }, "idClassificacaoDespesa": { "$ref": "#/components/schemas/ClassificacaoDespesaEnum" }, "idContrato": { "type": "integer", "format": "int64" }, "idLicitacao": { "type": "integer", "format": "int64" }, "valorFixadoDespesa": { "type": "number", "format": "double", "nullable": true }, "modalidadeDespesa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmpenhosPorExercicioGridDtoPageResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmpenhosPorExercicioGridDto" }, "nullable": true }, "totalResult": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "sizePerPage": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "command": { "type": "string", "nullable": true }, "extraResults": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraResults" }, "nullable": true } }, "additionalProperties": false }, "EnumValue": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "nome": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "codigo": { "type": "string", "nullable": true }, "detalhamento": { "type": "string", "nullable": true }, "codigoDescricao": { "type": "string", "nullable": true, "readOnly": true }, "extra": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EstiloTemaEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "ExtensaoArquivoEnum": { "enum": [ -7, -6, -5, -4, -3, -2, -1 ], "type": "integer", "format": "int64" }, "ExtraResults": { "type": "object", "properties": { "ordem": { "type": "integer", "format": "int32" }, "nome": { "type": "string", "nullable": true }, "command": { "type": "string", "nullable": true }, "dateTimeResult": { "type": "string", "format": "date-time" }, "intResult": { "type": "integer", "format": "int32" }, "longResult": { "type": "integer", "format": "int64" }, "decimalResult": { "type": "number", "format": "double" }, "stringResult": { "type": "string", "nullable": true }, "listaResult": { "type": "array", "items": { }, "nullable": true }, "result": { "nullable": true } }, "additionalProperties": false }, "FasesRelacionadasGridDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "documento": { "type": "string", "nullable": true }, "tipoDocumento": { "type": "string", "nullable": true }, "data": { "type": "string", "format": "date-time", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true }, "historico": { "type": "string", "nullable": true }, "idEmpenho": { "type": "integer", "format": "int64" }, "idLiquidacao": { "type": "integer", "format": "int64", "nullable": true }, "idPagamento": { "type": "integer", "format": "int64", "nullable": true }, "idAnulacao": { "type": "integer", "format": "int64", "nullable": true }, "fase": { "type": "string", "nullable": true }, "especie": { "type": "string", "nullable": true }, "documentoRelacionado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldComplete": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "tamanhoProporcional": { "type": "number", "format": "double" }, "field": { "$ref": "#/components/schemas/IFieldView" }, "posicao": { "type": "string" } }, "additionalProperties": false }, "FieldView": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "width": { "type": "number", "format": "double" }, "alignment": { "$ref": "#/components/schemas/AlignEnum" }, "format": { "$ref": "#/components/schemas/FormatViewer" }, "order": { "type": "integer", "format": "int32" }, "useAlias": { "type": "boolean" }, "checked": { "type": "boolean" }, "visible": { "type": "boolean" }, "totalizable": { "type": "boolean" }, "defaultTotalizer": { "type": "boolean" }, "defaultGroup": { "type": "boolean" } }, "additionalProperties": false }, "FieldsFilterDto": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueFinnaly": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "nameFieldTable": { "type": "string", "nullable": true }, "aliasTable": { "type": "string", "nullable": true }, "urlStore": { "type": "string", "nullable": true }, "enumStore": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/TypeEnum" }, "typeParam": { "$ref": "#/components/schemas/TypeEnum" }, "operatorDefault": { "$ref": "#/components/schemas/OperadorComparacaoEnum" }, "valueDefault": { "type": "string", "nullable": true }, "valueDefaultFinally": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "parameterFilterType": { "$ref": "#/components/schemas/ParameterFilterType" }, "valueToReplace": { "type": "string", "nullable": true }, "loadAutomatically": { "type": "boolean" }, "allowFilter": { "type": "boolean" }, "valueDefaultKey": { "type": "string", "nullable": true }, "operatorValue": { "$ref": "#/components/schemas/OperadorComparacaoEnum" }, "operators": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "checked": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "numberOfDaysDateRangeForValidation": { "type": "integer", "format": "int32" }, "formatViewer": { "$ref": "#/components/schemas/FormatViewer" }, "requiredOr": { "type": "boolean" }, "maskFormat": { "type": "string", "nullable": true }, "maskFormatString": { "type": "boolean" }, "placeholder": { "type": "string", "nullable": true }, "filterConcatAutomatically": { "type": "boolean" }, "cssClass": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FonteRecursosGridDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "descricaoFonteRecurso": { "type": "string", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "FormatViewer": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "GlossarioDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "verbete": { "type": "string", "nullable": true }, "definicao": { "type": "string", "nullable": true }, "primeiraLetra": { "type": "string", "nullable": true }, "fonte": { "type": "string", "nullable": true }, "dataHoraInicioVigencia": { "type": "string", "format": "date-time" }, "dataHoraFimVigencia": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GroupDefinition": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "dummyGroup": { "type": "boolean" }, "direction": { "$ref": "#/components/schemas/SortDirection" }, "isASC": { "type": "boolean", "readOnly": true }, "field": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "exibitionName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GrupoDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "titulo": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "categoria": { "type": "string", "nullable": true }, "tipoExibicao": { "$ref": "#/components/schemas/TipoExibicaoGrupoEnum" }, "ordem": { "type": "integer", "format": "int32" }, "idUsuario": { "type": "integer", "format": "int32" }, "dataHoraInicioVigencia": { "type": "string", "format": "date-time" }, "dataHoraFimVigencia": { "type": "string", "format": "date-time", "nullable": true }, "dataHoraGravacaoFiltro": { "type": "string", "format": "date-time" }, "tipoGrupo": { "$ref": "#/components/schemas/TipoGrupoEnum" } }, "additionalProperties": false }, "GrupoPublicacaoDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "descricao": { "type": "string", "nullable": true }, "ordem": { "type": "integer", "format": "int32" }, "ordemCompleta": { "type": "string", "nullable": true }, "idGrupoPublicacaoSuperior": { "type": "integer", "format": "int64", "nullable": true }, "vinculaPublicacoes": { "type": "boolean" }, "idTransparenciaSituacaoPublicacao": { "$ref": "#/components/schemas/TransparenciaSituacaoPublicacaoEnum" }, "apareceMenu": { "type": "boolean" }, "idTipoExibicao": { "$ref": "#/components/schemas/TipoExibicaoGrupoPublicacao" } }, "additionalProperties": false }, "IFieldView": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "visible": { "type": "boolean" }, "displayName": { "type": "string", "nullable": true }, "width": { "type": "number", "format": "double" }, "alignment": { "$ref": "#/components/schemas/AlignEnum" }, "format": { "$ref": "#/components/schemas/FormatViewer" }, "useAlias": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "totalizable": { "type": "boolean" } }, "additionalProperties": false }, "ItemGrupoPaginaInicialDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "idGrupo": { "type": "integer", "format": "int64" }, "titulo": { "type": "string", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "tipoExibicao": { "$ref": "#/components/schemas/TipoExibicaoItemGrupoEnum" }, "ordem": { "type": "integer", "format": "int32" }, "idUsuario": { "type": "integer", "format": "int64" }, "dataHoraInicioVigencia": { "type": "string", "format": "date-time" }, "dataHoraFimVigencia": { "type": "string", "format": "date-time", "nullable": true }, "dataHoraGravacaoFiltro": { "type": "string", "format": "date-time" }, "idConteudo": { "type": "integer", "format": "int64", "nullable": true }, "conteudo": { "type": "string", "nullable": true }, "conteudoSemFormatacao": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "icone": { "type": "string", "nullable": true }, "idItemMenu": { "type": "integer", "format": "int64", "nullable": true }, "idGrupoPublicacao": { "type": "integer", "format": "int64", "nullable": true }, "idTranspArquivoImagemLink": { "type": "integer", "format": "int64", "nullable": true }, "arquivoImagemLink": { "type": "string", "nullable": true }, "nomeArquivoImagemLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ItemMenuDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "idTranspMenu": { "type": "integer", "format": "int64" }, "idTranspTipoItemMenu": { "type": "integer", "format": "int64" }, "idTranspItemMenuSuperior": { "type": "integer", "format": "int64", "nullable": true }, "nome": { "type": "string", "nullable": true }, "nomePadrao": { "type": "string", "nullable": true }, "flVisivel": { "type": "boolean" }, "ordem": { "type": "integer", "format": "int32" }, "ordemCompleta": { "type": "string", "nullable": true }, "rota": { "type": "string", "nullable": true }, "linkExterno": { "type": "string", "nullable": true }, "identificadorIcone": { "type": "string", "nullable": true }, "tipoItemMenu": { "$ref": "#/components/schemas/TipoItemMenu" } }, "additionalProperties": false }, "ItensDespesaGridDto": { "type": "object", "properties": { "item": { "type": "string", "nullable": true }, "unidadeMedida": { "type": "string", "nullable": true }, "especificacao": { "type": "string", "nullable": true }, "quantidade": { "type": "number", "format": "double" }, "valorUnitario": { "type": "number", "format": "double", "nullable": true }, "valorTotal": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MenuDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "flAtivo": { "type": "boolean" }, "itensMenu": { "type": "array", "items": { "$ref": "#/components/schemas/ItemMenuDto" }, "nullable": true } }, "additionalProperties": false }, "ModoExportacaoDados": { "enum": [ 1, 2, 3, 4, 6, 7, 15 ], "type": "integer", "format": "int32" }, "ModuloEnum": { "enum": [ -18, -17, -15, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1 ], "type": "integer", "format": "int64" }, "OperadorComparacaoEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "format": "int32" }, "ParameterFilterType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "ParametroTransparenciaDto": { "type": "object", "properties": { "temaBase": { "$ref": "#/components/schemas/TemaBaseEnum" }, "estiloTema": { "$ref": "#/components/schemas/EstiloTemaEnum" }, "corTema": { "$ref": "#/components/schemas/CorTemaEnum" }, "cor": { "type": "string", "nullable": true, "readOnly": true }, "rodape": { "type": "string", "nullable": true }, "dataInicioVigencia": { "type": "string", "format": "date-time" }, "idArquivoBrasaoLateral": { "type": "integer", "format": "int64", "nullable": true }, "arquivoBrasaoLateral": { "type": "string", "nullable": true }, "nomeArquivoBrasaoLateral": { "type": "string", "nullable": true }, "localizacao": { "type": "string", "nullable": true }, "horarioAtendimento": { "type": "string", "nullable": true }, "telefoneContato": { "type": "string", "nullable": true }, "whatsappContato": { "type": "string", "nullable": true }, "emailContato": { "type": "string", "nullable": true }, "textoExtraRodape": { "type": "string", "nullable": true }, "flExibeContratoPessoal": { "type": "boolean" } }, "additionalProperties": false }, "PrintConfiguration": { "type": "object", "properties": { "titleReport": { "type": "string", "nullable": true }, "reportSubtitle": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldView" }, "nullable": true }, "reportColumns": { "type": "array", "items": { "$ref": "#/components/schemas/FieldComplete" }, "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/SortDefinition" }, "nullable": true }, "group": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDefinition" }, "nullable": true }, "total": { "type": "array", "items": { "$ref": "#/components/schemas/TotalDefinition" }, "nullable": true }, "hasTotal": { "type": "boolean", "readOnly": true }, "portrait": { "type": "boolean" }, "useStyle": { "type": "boolean" }, "headerOnlyFirstPage": { "type": "boolean" }, "useDefaultReferencedAssemblies": { "type": "boolean" }, "referencedAssemblies": { "type": "array", "items": { "type": "string" }, "nullable": true }, "modoExportacaoDados": { "$ref": "#/components/schemas/ModoExportacaoDados" } }, "additionalProperties": false }, "PrintHeader": { "type": "object", "properties": { "brasaoEsquerdo": { "type": "string", "format": "byte", "nullable": true }, "cabecalhoRTF": { "type": "string", "nullable": true }, "nomeRazaoSocial": { "type": "string", "nullable": true }, "nomeMunicipio": { "type": "string", "nullable": true }, "estado": { "type": "string", "nullable": true }, "uf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "nomeTipoLogradouro": { "type": "string", "nullable": true }, "nomeLogradouro": { "type": "string", "nullable": true }, "numero": { "type": "string", "nullable": true }, "complemento": { "type": "string", "nullable": true }, "nomeBairro": { "type": "string", "nullable": true }, "cepFormatado": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PrintSetting": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "filtros": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "export": { "$ref": "#/components/schemas/ReportExport" }, "headerAccept": { "type": "string", "nullable": true }, "titleReport": { "type": "string", "nullable": true }, "printConfiguration": { "$ref": "#/components/schemas/PrintConfiguration" }, "printHeader": { "$ref": "#/components/schemas/PrintHeader" } }, "additionalProperties": false }, "ReceitasPorPeriodoGridDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "unidadeGestora": { "type": "string", "nullable": true }, "tipoOperacaoReceitaOrc": { "type": "string", "nullable": true }, "dataMovimento": { "type": "string", "format": "date-time", "nullable": true }, "sequenciaLctoData": { "type": "integer", "format": "int64" }, "receita": { "type": "string", "nullable": true, "readOnly": true }, "codigoReceita": { "type": "string", "nullable": true }, "descricaoReceita": { "type": "string", "nullable": true }, "valorPrevisto": { "type": "number", "format": "double", "nullable": true }, "valor": { "type": "number", "format": "double", "nullable": true }, "idUnidadeGestora": { "type": "integer", "format": "int64" }, "anoExercicio": { "type": "integer", "format": "int32" }, "idTipoOperacaoReceitaOrc": { "type": "integer", "format": "int64" }, "idEstrutNaturezaReceita": { "type": "integer", "format": "int64" }, "flReceitaCovid19": { "type": "boolean" }, "idUnidadeOrgao": { "type": "integer", "format": "int64" }, "descricaoMovimento": { "type": "string", "nullable": true }, "nomeUnidadeGestora": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportExport": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "SaldosEmpenhoDto": { "type": "object", "properties": { "anulado": { "type": "number", "format": "double", "nullable": true }, "saldoEmLiquidacao": { "type": "number", "format": "double", "nullable": true }, "liquidado": { "type": "number", "format": "double", "nullable": true }, "pago": { "type": "number", "format": "double", "nullable": true }, "saldoALiquidar": { "type": "number", "format": "double", "nullable": true }, "saldoAPagar": { "type": "number", "format": "double", "nullable": true }, "saldoEmpenhado": { "type": "number", "format": "double", "nullable": true }, "tipoEmpenho": { "type": "string", "nullable": true }, "classificacaoDespesa": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SortDefinition": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/SortDirection" }, "isASC": { "type": "boolean", "readOnly": true }, "field": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "exibitionName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SortDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "TemaBaseEnum": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "TipoEmpenhoEnum": { "enum": [ -3, -2, -1 ], "type": "integer", "format": "int64" }, "TipoExibicaoGrupoEnum": { "enum": [ 0, -3, -2, -1 ], "type": "integer", "format": "int32" }, "TipoExibicaoGrupoPublicacao": { "enum": [ -2, -1 ], "type": "integer", "format": "int64" }, "TipoExibicaoItemGrupoEnum": { "enum": [ 0, -5, -4, -3, -2, -1 ], "type": "integer", "format": "int32" }, "TipoGrupoEnum": { "enum": [ -2, -1 ], "type": "integer", "format": "int32" }, "TipoItemMenu": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "TotalDefinition": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "exibitionName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "TransparenciaSituacaoPublicacaoEnum": { "enum": [ -2, -1 ], "type": "integer", "format": "int64" }, "TransparenciaTipoPublicacaoEnum": { "enum": [ -5, -4, -3, -2, -1 ], "type": "integer", "format": "int64" }, "TypeEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "format": "int32" }, "UsuarioAcessoDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "login": { "type": "string", "nullable": true }, "nome": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "senha": { "type": "string", "nullable": true }, "sss": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "blue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WeatherForecast": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "temperatureC": { "type": "integer", "format": "int32" }, "temperatureF": { "type": "integer", "format": "int32", "readOnly": true }, "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Filtro", "description": "Responsável por informações do Filtro." }, { "name": "Monitoramento", "description": "" }, { "name": "DespesasComVeiculosMaquinarios", "description": "" }, { "name": "Autenticacao", "description": "Realiza o Login" } ] }