¶ Schemas da API de Transparência
Esta seção documenta todos os schemas retornados pela API. Cada objeto representa o modelo de dados utilizado nas respostas JSON.
¶ Dicionário de Schemas (Completo)
Clique nos títulos abaixo para expandir e visualizar todos os campos de cada objeto.
ContratoConvenioDto
| Campo | Tipo | Atributos |
|---|---|---|
| origem | string | nullable |
| numeroDocumento | string | nullable |
| numeroProcesso | string | nullable |
| dataElaboracao | string($date-time) | nullable |
| dataVigencia | string($date-time) | nullable |
| dataRetorno | string | nullable |
| empresa | string | nullable |
| cnpj_Cpf | string | nullable |
| objeto | string | nullable |
| valorInicial | string | nullable |
| valorContrapartida | string | nullable |
| siglaUg | string | nullable |
| nomeUg | string | nullable |
| codigoUg | string | nullable |
| dataAssinatura | string($date-time) | nullable |
DespesaDotacaoDto
| Campo | Tipo | Atributos |
|---|---|---|
| codigoUg | string | nullable |
| nomeUg | string | nullable |
| programaTrabalho | string | nullable |
| codigoNatureza | string | nullable |
| descricaoNatureza | string | nullable |
| exercicio | integer($int32) | - |
| dotacaoInicial | number($double) | nullable |
DespesaDto
| Campo | Tipo | Atributos |
|---|---|---|
| codigoUg, secretaria_Orgao | string | nullable |
| codigoFuncao, funcao | string | nullable |
| codigoSubFuncaostring, subfuncaostring | string | nullable |
| codigoProgramastring, programastring | string | nullable |
| codigoAcaostring, acaostring | string | nullable |
| codigoCategoriaEconomicastring, categoriaEconomicastring | string | nullable |
| codigoModalidadeAplicacaostring, modalidadeAplicacaostring | string | nullable |
| codigoElementoDespesastring, elementoDespesastring | string | nullable |
| codigoFontestring, nomeFonestring | string | nullable |
| codigoNaturezastring, nomeNaturezastring | string | nullable |
| cdGrupoNaturezaDespesastring, NomeGrupoNaturezaDespesastring | string | nullable |
| dotacaoInicial, dotacaoAtualizada | number($double) | nullable |
| despesaEmpenhadanumber, despesaLiquidadanumber, despesaPaganumber | number($double) | nullable |
| datastring | string($date-time) | - |
FornecedorImpedidoDto
| Campo | Tipo | Atributos |
|---|---|---|
| codigo | integer($int32) | - |
| cpfCnpj, numeroProcesso, siglastring | string | nullable |
| nomeUG, razaoSocial, informacaoPublicastring | string | nullable |
| dataIniciostring, dataFinalstring, dataPublicacaostring | string($date-time) | nullable |
| penasEventuais, sancaostring | string | nullable |
PagamentoFornecedor
| Campo | Tipo | Atributos |
|---|---|---|
| pagamentoFornecedorId | string($uuid) | - |
| exercicio, codNomeDespesa, codCategoriaDespesa | integer | - |
| processostring, eventostring, naturezaDespesastring | string | nullable |
| codGrupoDespesa, codModalidadeAplicacaoDespesa | integer | - |
| projetostring, programastring, acaostring, funcaostring | string | nullable |
| unidadeGestorastring, credorstring, docCredorstring | string | nullable |
| documentostring, documentoNEstring, documentoOBstring | string | nullable |
| dataDocumentostring, dataEmpenhostring | string($date-time) | nullable |
| valorPaganumber | number($double) | nullable |
| numeroDocumentoLiquidacaostring, dataDocumentoLiquidacaostring | string | nullable |
| objetivoDocumentoLiquidacaostring | string | nullable |
ReceitaDto
| Campo | Tipo | Atributos |
|---|---|---|
| datastring | string($date-time) | - |
| codigoUginteger, unidadeGestorastring, anointeger | mixed | - |
| poderstring, messtring, categoriaEconomicastring | string | nullable |
| origemstring, especiestring, naturezastring, fontestring | string | nullable |
| bancostring, agenciastring, contastring | string | nullable |
| previsaoInicial, previsaoAtualizada, receitaArrecadada | number($double) | - |
ServidorDto
| Campo | Tipo | Atributos |
|---|---|---|
| nomestring, lotacaostring, cargostring | string | nullable |
| dataAdmissao, dataDesligamento, dataInativo | string | nullable |
| cargaSemanalnumber | number($double) | nullable |
| situacaoFuncionalstring, rotinastring | string | nullable |
| descontos | Array[Descontos] | {descricao, valor} |
| proventos | Array[Proventos] | {descricao, valor} |
Estrutura de Listagem PagedList
Esta estrutura é aplicada a todos os retornos que terminam em PagedList (ex: ContratoConvenioDtoPagedList).
| pagina, registrosPorPagina, totalElementos | integer($int32) | readOnly |
| totalDePaginas | integer($int32) | readOnly |
| ultimaPagina | boolean | readOnly |
| resultados | Array[Objeto] | Contém a lista de itens detalhados acima. |