Ir para o conteúdo principal

[WIP] - Relacionamento Empenho Licitação | 2025 -

Tipo Envio: Balancete - Contabilidade

Chave Unicidade

 [ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Código Unidade Gestora ObraLicitação - Número ObraLicitação - AnoModalidade EmpenhoLicitação ]


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
codigoUnidadeGestoraObracodigoUnidadeGestoraLicitacao
numeroObranumeroLicitacao
anoEmpenhocodigoModalidadeLicitacao Tabela Modalidade Licitação
action Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão

Schema
{
  "$schema": "https://jsojson-schema.org/draft/2020-12/schema",
  "title": "Lista de Relacionamentos Empenho Obra"Licitação",
  "description": "Lista de objetos representando a entidade Relacionamento Empenho Obra"Licitação",
  "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": {
        "title": "Relacionamento Empenho Obra"Licitação",
        "description": "Representação do schema para envio da entidade Relacionamento Empenho Obra"Licitação",
        "type": "object",
        "properties": {
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "numeroEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroObra"codigoUnidadeGestoraLicitacao": {
            "type": "string",
            "minLength": 8,6,
            "maxLength": 86,
            "pattern": "^[0-9]+$"
          },
          "anoEmpenho"numeroLicitacao": {
            "type": "string",
            "minLength": 4,10,
            "maxLength": 4,10,
            "pattern": "^\\d{5}/\\d{4}$"
          },
          "codigoModalidadeLicitacao": {
            "type": "string",
            "minLength": 2,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "codigoUnidadeGestoraObra"codigoUnidadeGestoraLicitacao",
          "numeroObra"numeroLicitacao",
          "anoEmpenho"codigoModalidadeLicitacao",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigoUnidadeOrcamentaria": "12345",
      "numeroEmpenho": "0000001",
      "codigoUnidadeGestoraObra"codigoUnidadeGestoraLicitacao": "123456",
      "numeroObra"numeroLicitacao": "OBRA0001"00001/2025",
      "anoEmpenho"modalidadeLicitacao": "2025"01",
      "action": "CREATE"
    },
    {
      "codigoUnidadeOrcamentaria": "54321",
      "numeroEmpenho": "0000002",
      "codigoUnidadeGestoraObra"codigoUnidadeGestoraLicitacao": "654321",
      "numeroObra"numeroLicitacao": "OBRA0002"00002/2025",
      "anoEmpenho"modalidadeLicitacao": "2024"02",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
RELACIONAMENTO_EMPENHO_OBRA_DUPLICIDADE_NAO_PERMITIDARELACIONAMENTO_EMPENHO_LICITACAO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
RELACIONAMENTO_EMPENHO_OBRA_CADASTRADA_GEO_OBRASEMPENHO_LICITACAO_CADASTRADA_TRAMITA QuandoA informada, a obralicitação deve ter sido cadastrada no Geo ObrasTramita