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
dotacoes

Item Dotação
Campo Chave Informações
codigoUnidadeGestora
exercicio
codigoReceitaOrcamentaria Código da Receita Orçamentária Prevista padrão da STN/TCE
codigoFuncao Tabela Função (Adicionar Link)
codigoSubfuncao Tabela Subfunção (Adicionar Link)
codigoPrograma Código do programa cadastrado pela Unidade Gestora para o exercício
codigoAcao Código da ação cadastrado pela Unidade Gestora para o exercício
codigoCategoriaEconomica Tabela Categoria Economica (Adicionar Link)
codigoNaturezaDespesa Tabela Natureza Despesa (Adicionar Link)
codigoModalidadeDespesa Tabela Modalidade Despesa (Adicionar Link)
codigoElementoDespesa Tabela Elemento Despesa (Adicionar Link)
codigoFonteRecurso Tabela Fonte Recursos
exercicioFonteRecurso
valorDotacao
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 Dotações",
  "description": "Lista de objetos representando a entidade 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"]
    },
    "dotacoes": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "Dotação",
        "description": "Representação do schema para envio da entidade 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]+$"
          },
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 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]+$"
          },
          "valorDotacao": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "exercicio",
          "codigoUnidadeOrcamentaria",
          "codigoFuncao",
          "codigoSubFuncao",
          "codigoPrograma",
          "codigoAcao",
          "codigoCategoriaEconomica",
          "codigoNaturezaDespesa",
          "codigoModalidadeDespesa",
          "codigoElementoDespesa",
          "exercicioFonteRecurso",
          "codigoFonteRecurso",
          "valorDotacao",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "dotacoes"
  ],
  "additionalProperties": false
}

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