Retenção | Schema V1 | 2025 - ∞

Tipo Envio: Diário

---

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
retencoes	–

---

Item

Campo	Chave	Informações
codigoUnidadeGestora	✅	–
anoEmissaoEmpenho	✅	–
codigoUnidadeOrcamentaria	✅	Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício
numeroEmpenho	✅	–
numeroPagamentonumeroPaganmento	✅	–
tipoRetencao	✅	Tabela Tipo Retenção
valorRetencao	–	–
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": "Retenções",
  "description": "Schema para envio de retenções 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"]
    },
    "retencoes": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "properties": {
          "codigoUnidadeGestora": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "anoEmissaoEmpenho": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4
          },
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "numeroEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "valor": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "tipoRetencao": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "anoEmissaoEmpenho",
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "numeroPagamento",
          "valorRetencao",
          "tipoRetencao"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "retencoes"],
  "additionalProperties": false
}

---

Exemplo de Payload

{
  "timestamp": "2026-03-02T11:32:45.123456",
  "retencoes": [
    {
      "codigoUnidadeGestora": "123456",
      "anoEmissaoEmpenho": "2026",
      "codigoUnidadeOrcamentaria": "54321",
      "numeroEmpenho": "0000001",
      "numeroPagamento": "0000001",
      "valorRetencao": 15000.50,
      "tipoRetencao": "1",
      "action": "CREATE"
    },
    {
      "codigoUnidadeGestora": "654321",
      "anoEmissaoEmpenho": "2026",
      "codigoUnidadeOrcamentaria": "12345",
      "numeroEmpenho": "0000002",
      "numeroPagamento": "0000002",
      "valorRetencao": 8250.00,
      "tipoRetencao": "2",
      "action": "UPDATE"
    }
  ]
}