Skip to content
HALOWERK

Formatwerk

gaeb generate

Builds an X83 (Angebotsaufforderung, prices are not part of X83) from categories (lots and hierarchy levels with labels) and items with item number (OZ), short and long text, quantity, unit and the item kinds lump sum, provisional with/without total, alternative group/serial and quantity to be entered by the bidder (GAEB DA XML 3.3 Fachdokumentation 2023-01 (© DIN e. V., Gemeinsamer Ausschuss Elektronik im Bauwesen) and the XSD schemas 3.3 (2021-05) and 3.2 (2013-10),.

POST https://format.halowerk.com/v1/gaeb-generate

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
versionstringNo
datestringNoGAEBInfo date (default boq.date or today).
projectobjectNo
awardobjectNo
boqobjectYes
structureobjectNoBreakdown; derived from the OZ if omitted.
pad_numeric_partsbooleanNoZero-pad numeric OZ parts (1 -> 0001).
categoriesarrayNo
itemsarrayYes
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "boq",
    "items"
  ],
  "properties": {
    "version": {
      "type": "string",
      "enum": [
        "3.3",
        "3.2"
      ],
      "default": "3.3"
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "GAEBInfo date (default boq.date or today)."
    },
    "project": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "label": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      }
    },
    "award": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "procedure": {
          "type": "string",
          "enum": [
            "OpenProc",
            "ClosedProc",
            "NegProc",
            "OpenCall",
            "SelectCall",
            "NegCont",
            "IntNATO",
            "SelectCallPostOpen",
            "NegProcOpen",
            "CompetDialog",
            "InnovationPartnership"
          ],
          "description": "GAEB procedure code (11.2.4)."
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "default": "EUR"
        },
        "currency_label": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "opening_date": {
          "type": "string",
          "format": "date"
        },
        "opening_time": {
          "type": "string",
          "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$"
        },
        "submission_place": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "construction_start": {
          "type": "string",
          "format": "date"
        },
        "construction_end": {
          "type": "string",
          "format": "date"
        }
      }
    },
    "boq": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "label"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 20,
          "description": "Short name (default LV)."
        },
        "label": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60,
          "description": "Title."
        },
        "date": {
          "type": "string",
          "format": "date"
        }
      }
    },
    "structure": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "item_length"
      ],
      "description": "Breakdown; derived from the OZ if omitted.",
      "properties": {
        "lot": {
          "type": "boolean",
          "default": false,
          "description": "First level is a lot."
        },
        "levels": {
          "type": "array",
          "maxItems": 5,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "length"
            ],
            "properties": {
              "length": {
                "type": "integer",
                "minimum": 1,
                "maximum": 12
              },
              "numeric": {
                "type": "boolean",
                "default": true
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 40
              }
            }
          }
        },
        "item_length": {
          "type": "integer",
          "minimum": 1,
          "maximum": 14
        },
        "item_numeric": {
          "type": "boolean",
          "default": true
        }
      }
    },
    "pad_numeric_parts": {
      "type": "boolean",
      "default": true,
      "description": "Zero-pad numeric OZ parts (1 -> 0001)."
    },
    "categories": {
      "type": "array",
      "maxItems": 5000,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "oz",
          "label"
        ],
        "properties": {
          "oz": {
            "type": "string",
            "pattern": "^[0-9A-Za-z_]{1,14}(\\.[0-9A-Za-z_]{1,14}){0,5}$"
          },
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          }
        }
      }
    },
    "items": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20000,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "oz",
          "unit"
        ],
        "properties": {
          "oz": {
            "type": "string",
            "pattern": "^[0-9A-Za-z_]{1,14}(\\.[0-9A-Za-z_]{1,14}){0,5}$",
            "description": "Levels and item number, e.g. 01.02.0010."
          },
          "index": {
            "type": "string",
            "pattern": "^[0-9A-Za-z_]$"
          },
          "short_text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "long_text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100000,
            "description": "Blank lines separate paragraphs."
          },
          "quantity": {
            "type": "number",
            "minimum": 0,
            "maximum": 99999999.999
          },
          "unit": {
            "type": "string",
            "minLength": 1,
            "maxLength": 4,
            "description": "e.g. m2, St, psch"
          },
          "qty_tbd": {
            "type": "boolean",
            "description": "Quantity entered by the bidder."
          },
          "lump_sum": {
            "type": "boolean"
          },
          "provisional": {
            "type": "string",
            "enum": [
              "with_total",
              "without_total"
            ]
          },
          "alternative": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "group",
              "serial"
            ],
            "properties": {
              "group": {
                "type": "integer",
                "minimum": 0,
                "maximum": 999
              },
              "serial": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9,
                "description": "0 base, 1-9 alternative"
              }
            }
          }
        }
      }
    }
  }
}

Open original schema

Published input example

{
  "boq": {
    "name": "LV 1",
    "label": "Painting works"
  },
  "date": "2026-11-01",
  "categories": [
    {
      "oz": "01",
      "label": "Interior walls"
    }
  ],
  "items": [
    {
      "oz": "01.0010",
      "short_text": "Wall paint, two coats",
      "quantity": 120,
      "unit": "m2"
    }
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →