Ir para o conteúdo principal

Dotação | Schema V1 | 2025 - ∞

Tipo Envio: Orçamento

Objeto Raiz
Campo Informações
timestamp Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
receitasPrevistasdotacoes

Item ProgramaDotação
Campo Chave Informações
codigoUnidadeGestora
exercicio
codigoReceitaOrcamentaria Código da Receita Orçamentária Prevista padrão da STN/TCE
codigoFuncaoTabela Função (Adicionar Link)
codigoSubfuncaoTabela Subfunção (Adicionar Link)
codigoProgramaCódigo do programa cadastrado pela Unidade Gestora para o exercício
codigoAcaoCódigo da ação cadastrado pela Unidade Gestora para o exercício
codigoCategoriaEconomicaTabela Categoria Economica (Adicionar Link)
codigoNaturezaDespesaTabela Natureza Despesa (Adicionar Link)
codigoModalidadeDespesaTabela Modalidade Despesa (Adicionar Link)
codigoElementoDespesaTabela Elemento Despesa (Adicionar Link)
codigoFonteRecurso Tabela Fonte Recursos
tipoReceitaLancadaexercicioFonteRecurso Tabela Tipo Receita Lançada (Adicionar Link)
exercicioFonteRecurso
valorReceitavalorDotacao
action Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão

Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Lista de Receitas Previstas"Dotações",
  "description": "Lista de objetos representando a entidade Receita Prevista"Dotação",
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "string",
      "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)\\.\\d{6}$",
      "examples": ["2025-09-11T15:30:00.123456"]
    },
    "receitasPrevistas"dotacoes": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "Receita Prevista"Dotação",
        "description": "Representação do schema para envio da entidade Receita Prevista"Dotação",
        "type": "object",
        "properties": {
          "codigoUnidadeGestora": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "exercicio": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "codigoReceitaOrcamentaria"codigoUnidadeOrcamentaria": {
            "description": "Código da Receita Orçamentária Prevista padrão da STN/TCE",
            "type": "string",
            "minLength": 8,5,
            "maxLength": 8,5,
            "pattern": "^[0-9]+$"
          },
          "codigoFuncao": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[0-9]+$"
          },
          "codigoSubFuncao": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "codigoPrograma": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "codigoAcao": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "codigoCategoriaEconomica": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "codigoNaturezaDespesa": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "codigoModalidadeDespesa": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[0-9]+$"
          },
          "codigoElementoDespesa": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[0-9]+$"
          },
          "exercicioFonteRecurso": {
            "type": "string",
            "enum": [
              "ATUAL",
              "ANTERIOR"
            ]
          },
          "codigoFonteRecurso": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "tipoReceitaLancada": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "valorReceita"valorDotacao": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "exercicio",
          "codigoReceitaOrcamentaria"codigoUnidadeOrcamentaria",
          "codigoFuncao",
          "codigoSubFuncao",
          "codigoPrograma",
          "codigoAcao",
          "codigoCategoriaEconomica",
          "codigoNaturezaDespesa",
          "codigoModalidadeDespesa",
          "codigoElementoDespesa",
          "exercicioFonteRecurso",
          "codigoFonteRecurso",
          "tipoReceitaLancada",
          "valorReceita"valorDotacao",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "receitasPrevistas"dotacoes"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "receitasPrevistas"dotacoes": [
    {
      "codigoUnidadeGestora": "123456",
      "exercicio": "2025",
      "codigoReceitaOrcamentaria"codigoUnidadeOrcamentaria": "11213001"54321",
      "codigoFuncao": "01",
      "codigoSubFuncao": "123",
      "codigoPrograma": "0001",
      "codigoAcao": "1001",
      "codigoCategoriaEconomica": "4",
      "codigoNaturezaDespesa": "3",
      "codigoModalidadeDespesa": "90",
      "codigoElementoDespesa": "39",
      "exercicioFonteRecurso": "ATUAL",
      "codigoFonteRecurso": "101",
      "tipoReceitaLancada"valorDotacao": "1",
      "valorReceita": 1500000.250000.75,
      "action": "CREATE"
    },
    {
      "codigoUnidadeGestora": "654321",
      "exercicio": "2025",
      "codigoReceitaOrcamentaria"codigoUnidadeOrcamentaria": "13322002"12345",
      "codigoFuncao": "02",
      "codigoSubFuncao": "456",
      "codigoPrograma": "0002",
      "codigoAcao": "2002",
      "codigoCategoriaEconomica": "3",
      "codigoNaturezaDespesa": "1",
      "codigoModalidadeDespesa": "30",
      "codigoElementoDespesa": "11",
      "exercicioFonteRecurso": "ANTERIOR",
      "codigoFonteRecurso": "202",
      "tipoReceitaLancada"valorDotacao": "2",
      "valorReceita": 835000.50,180000.00,
      "action": "UPDATE"
    }
  ]
}