Ir para o conteúdo principal

Estorno Empenho | 2025 ~

Tipo Envio: Diário
Chave Unicidade

[  Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Estorno ]

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
elementos –
Item
Campo Chave Informações
codigoUnidadeOrcamentaria ✅ Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício
numeroEmpenho ✅ –
numeroEstornoEmpenho ✅ –
valorEstornoEmpenho – –
motivo – –
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": "Estornos de Empenho",
  "description": "Schema para envio de estornos de empenho por unidade gestora",
  "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"]
    },
    "elementos": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "properties": {
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "numeroEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroEstornoEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "valorEstornoEmpenho": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "motivo": {
            "type": "string",
            "maxLength": 500
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "numeroEstornoEmpenho",
          "valorEstornoEmpenho",
          "motivo",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2026-03-02T11:32:45.123456",
  "elementos": [
    {
      "codigoUnidadeOrcamentaria": "54321",
      "numeroEmpenho": "0000001",
      "numeroEstornoEmpenho": "0000001",
      "valorEstornoEmpenho": 150000.50,
      "motivo": "Estorno referente a empenho emitido com valor incorreto",
      "action": "CREATE"
    },
    {
      "codigoUnidadeOrcamentaria": "12345",
      "numeroEmpenho": "0000002",
      "numeroEstornoEmpenho": "0000002",
      "valorEstornoEmpenho": 82500.00,
      "motivo": "Estorno de empenho com despesa previamente liquidada",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
ESTORNO_EMPENHO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
ESTORNO_EMPENHO_EMPENHO_CADASTRADO O Empenho deve ter sido cadastrado para a Unidade Gestora no exercício do envio
ESTORNO_EMPENHO_VALOR_ESTORNADO_EXCEDE_EMPENHADO A soma do valor estornado não pode superar o valor empenhado

Nenhum comentário para exibir

Voltar ao topo