Unidade Orçamentária | 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
unidadesOrcamentarias
–
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 Unidades Orçamentárias",
"description": "Lista de objetos representando a entidade Unidade Orçamentária",
"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{3, 6}$",
"examples": ["2025-09-11T15:30:00.123456"]
},
"unidadesOrcamentarias": {
"type": "array",
"uniqueItems": true,
"items": {
"title": "Unidade Orçamentária",
"description": "Representação do schema para envio da entidade Orçamentária",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"descricaoUnidadeOrcamentaria": {
"type": "string",
"minLength": 20,
"maxLength": 50
},
"nomeSecretario": {
"type": "string",
"minLength": 15,
"maxLength": 80
},
"cpfSecretario": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"tipoAtoJuridico": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"tipoNaturezaJuridica": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoUnidadeOrcamentaria",
"descricaoUnidadeOrcamentaria",
"nomeSecretario",
"cpfSecretario",
"tipoAtoJuridico",
"tipoNaturezaJuridica",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"unidadesOrcamentarias"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"unidadesOrcamentarias": [
{
"codigoUnidadeGestora": "123456",
"codigoUnidadeOrcamentaria": "10001",
"descricaoUnidadeOrcamentaria": "Secretaria Municipal de Administração Pública",
"nomeSecretario": "João Carlos da Silva Neto",
"cpfSecretario": "12345678901",
"tipoAtoJuridico": "1",
"tipoNaturezaJuridica": "2",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"codigoUnidadeOrcamentaria": "20002",
"descricaoUnidadeOrcamentaria": "Secretaria de Planejamento e Finanças Municipais",
"nomeSecretario": "Maria Fernanda de Oliveira Santos",
"cpfSecretario": "98765432100",
"tipoAtoJuridico": "2",
"tipoNaturezaJuridica": "1",
"action": "UPDATE"
}
]
}