Ir para o conteúdo principal

Estorno Pagamento | 2025 ~

Tipo Envio: Diário
Chave Unicidade

[ Exercício - Código Unidade Gestora - Número Empenho - Número Pagamento - Número Estorno Liquidação - Número Estorno Pagamento ]

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 ✅ –
numeroEmpenho ✅ –
numeroLiquidacao ✅ –
numeroPagamento ✅ –
numeroEstornoPagamento ✅ –
motivoEstornoPagamento – –
valorEstornoPagamento – –
action – CREATE / UPDATE / DELETE 
Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Estornos de Pagamento",
  "description": "Schema para envio de estornos de pagamento 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]+$"
          },
          "numeroLiquidacao": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroEstornoPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "motivoEstornoPagamento": {
            "type": "string",
            "maxLength": 500
          },
          "valorEstornoPagamento": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "numeroLiquidacao",
          "numeroPagamento",
          "numeroEstornoPagamento",
          "motivoEstornoPagamento",
          "valorEstornoPagamento",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "estornosPagamento": [
    {
      "codigoUnidadeOrcamentaria": "17050",
      "numeroEmpenho": "0001234",
      "numeroLiquidacao": "0000001",
      "numeroPagamento": "0000001",
      "numeroEstornoPagamento": "0000001",
      "motivoEstornoPagamento": "Pagamento realizado em duplicidade referente ao processo administrativo nº 001/2025.",
      "valorEstornoPagamento": 15000.00,
      "action": "CREATE"
    },
    {
      "codigoUnidadeOrcamentaria": "17050",
      "numeroEmpenho": "0001235",
      "numeroLiquidacao": "0000021",
      "numeroPagamento": "0000002",
      "numeroEstornoPagamento": "0000002",
      "motivoEstornoPagamento": "Erro na identificação do credor. Pagamento efetuado para fornecedor incorreto conforme processo nº 002/2025.",
      "valorEstornoPagamento": 8500.50,
      "action": "CREATE"
    }
  ]
}

Regras

ID Regra
ESTORNO_PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
ESTORNO_PAGAMENTO_PAGAMENTO_CADASTRADO O pagamento deve ter sido cadastrado para a Unidade Gestora no exercício do envio
ESTORNO_PAGAMENTO_VALOR_ESTORNADO_EXCEDE_VALOR_PAGO A soma do valor estornado não pode superar o valor pago

Nenhum comentário para exibir

Voltar ao topo