Ir para o conteúdo principal

Receita Prevista | 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
unidadesOrcamentariasreceitasPrevistas

Item Programa
Campo Chave Informações
codigoUnidadeGestora
codigoUnidadeOrcamentaria
descricaoUnidadeOrcamentaria
nomeSecretario
cpfSecretario
tipoAtoJuridico Tabela Tipo Ato Juridico (Adicionar Link)
tipoNaturezaJuridica Tabela Tipo Natureza Juridica (Adicionar Link)
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 UnidadesReceitas Orçamentárias"Previstas",
  "description": "Lista de objetos representando a entidade UnidadeReceita Orçamentária"Prevista",
  "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"]
    },
    "unidadesOrcamentarias"receitasPrevistas": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "UnidadeReceita Orçamentária"Prevista",
        "description": "Representação do schema para envio da entidade Orçamentária"Receita Prevista",
        "type": "object",
        "properties": {
          "codigoUnidadeGestora": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "codigoUnidadeOrcamentaria"exercicio": {
            "type": "string",
            "minLength": 5,4,
            "maxLength": 5,4,
            "pattern": "^[0-9]+$"
          },
          "descricaoUnidadeOrcamentaria"codigoReceitaOrcamentaria": {
            "description": "Código da Receita Orçamentária Prevista padrão da STN/TCE",
            "type": "string",
            "minLength": 20,8,
            "maxLength": 50
          },
          "nomeSecretario": {
            "type": "string",
            "minLength": 15,
            "maxLength": 80
          },
          "cpfSecretario": {
            "type": "string",
            "minLength": 11,
            "maxLength": 11,8,
            "pattern": "^[0-9]+$"
          },
          "tipoAtoJuridico"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]+$"
          },
          "tipoNaturezaJuridica"valorReceita": {
            "type": "string"number",
            "minLength"exclusiveMinimum": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"0
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "codigoUnidadeOrcamentaria"exercicio",
          "descricaoUnidadeOrcamentaria"codigoReceitaOrcamentaria",
          "nomeSecretario"exercicioFonteRecurso",
          "cpfSecretario"codigoFonteRecurso",
          "tipoAtoJuridico"tipoReceitaLancada",
          "tipoNaturezaJuridica"valorReceita",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "unidadesOrcamentarias"receitasPrevistas"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "unidadesOrcamentarias"receitasPrevistas": [
    {
      "codigoUnidadeGestora": "123456",
      "codigoUnidadeOrcamentaria"exercicio": "10001"2025",
      "descricaoUnidadeOrcamentaria"codigoReceitaOrcamentaria": "Secretaria Municipal de Administração Pública"11213001",
      "nomeSecretario"exercicioFonteRecurso": "João Carlos da Silva Neto"ATUAL",
      "cpfSecretario"codigoFonteRecurso": "12345678901"101",
      "tipoAtoJuridico"tipoReceitaLancada": "1",
      "tipoNaturezaJuridica"valorReceita": "2",1500000.75,
      "action": "CREATE"
    },
    {
      "codigoUnidadeGestora": "654321",
      "codigoUnidadeOrcamentaria"exercicio": "20002"2025",
      "descricaoUnidadeOrcamentaria"codigoReceitaOrcamentaria": "Secretaria de Planejamento e Finanças Municipais"13322002",
      "nomeSecretario"exercicioFonteRecurso": "Maria Fernanda de Oliveira Santos"ANTERIOR",
      "cpfSecretario"codigoFonteRecurso": "98765432100"202",
      "tipoAtoJuridico"tipoReceitaLancada": "2",
      "tipoNaturezaJuridica"valorReceita": "1",835000.50,
      "action": "UPDATE"
    }
  ]
}