Skip to content
HALOWERK

Formatwerk

contract dates ics

Extracts start date, initial term or fixed end date, renewal (fixed periods or indefinite), notice period and its reference date (end of term, month, quarter, year) and dated deadlines from the text with German and English patterns; overrides can correct or replace each value. Terms run from the start of the first day (§ 187 Abs. 2 BGB) and end with the day before the corresponding day (§ 188 Abs. 2, 3 BGB; § 189 for half years). The latest day on which a notice must be received is computed.

POST https://format.halowerk.com/v1/contract-dates-ics

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
textstringNoDocument as plain text (blank lines or line ends after full stops separate paragraphs; form feed separates pages).
content_base64stringNoPDF, DOCX or text file as base64 (a data: prefix is tolerated); at most 10 MB decoded.
formatstringNoFormat of content_base64; auto detects PDF and DOCX by their signature.
reference_datestringNoDate from which upcoming deadlines are listed (default: today, UTC).
statestringNoGerman state for public holidays (default: nationwide holidays only).
cyclesintegerNo
reminder_daysarrayNo
calendar_namestringNo
overridesobjectNoValues that replace or complete the extraction.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [],
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000000,
      "description": "Document as plain text (blank lines or line ends after full stops separate paragraphs; form feed separates pages)."
    },
    "content_base64": {
      "type": "string",
      "minLength": 8,
      "maxLength": 13981016,
      "description": "PDF, DOCX or text file as base64 (a data: prefix is tolerated); at most 10 MB decoded."
    },
    "format": {
      "type": "string",
      "enum": [
        "auto",
        "pdf",
        "docx",
        "text"
      ],
      "default": "auto",
      "description": "Format of content_base64; auto detects PDF and DOCX by their signature."
    },
    "reference_date": {
      "type": "string",
      "format": "date",
      "description": "Date from which upcoming deadlines are listed (default: today, UTC)."
    },
    "state": {
      "type": "string",
      "enum": [
        "BB",
        "BE",
        "BW",
        "BY",
        "HB",
        "HE",
        "HH",
        "MV",
        "NI",
        "NW",
        "RP",
        "SH",
        "SL",
        "SN",
        "ST",
        "TH"
      ],
      "description": "German state for public holidays (default: nationwide holidays only)."
    },
    "cycles": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10,
      "default": 3
    },
    "reminder_days": {
      "type": "array",
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 365
      },
      "default": [
        30,
        7
      ]
    },
    "calendar_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "default": "Contract deadlines"
    },
    "overrides": {
      "type": "object",
      "additionalProperties": false,
      "description": "Values that replace or complete the extraction.",
      "properties": {
        "start_date": {
          "type": "string",
          "format": "date"
        },
        "term_end": {
          "type": "string",
          "format": "date"
        },
        "initial_term_months": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600
        },
        "renewal_months": {
          "type": "integer",
          "minimum": 0,
          "maximum": 120,
          "description": "0 = no renewal."
        },
        "notice_months": {
          "type": "integer",
          "minimum": 0,
          "maximum": 60
        },
        "notice_days": {
          "type": "integer",
          "minimum": 1,
          "maximum": 730
        },
        "notice_reference": {
          "type": "string",
          "enum": [
            "end_of_term",
            "end_of_month",
            "end_of_quarter",
            "end_of_year",
            "unspecified"
          ]
        }
      }
    }
  }
}

Open original schema

Published input example

{
  "text": "§ 2 Laufzeit\n(1) Der Vertrag beginnt am 01.01.2025 und hat eine Mindestlaufzeit von 24 Monaten.\n(2) Er verlängert sich automatisch um jeweils 12 Monate, wenn er nicht mit einer Frist von drei Monaten zum Ende der jeweiligen Laufzeit gekündigt wird.",
  "reference_date": "2026-11-01"
}

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 →