Skip to content
HALOWERK

Datenwerk

dunning run plan

Per open item the run decides: dun at the next level (after grace days past the due date and the interval since the last reminder), wait, below minimum, on hold (disputed) or escalate (maximum level reached). Items are grouped into one letter per customer at the highest level, with the fee of that level. Default interest is computed per § 288 Abs. 1/2 BGB (base rate + 5 points for consumers, + 9 points otherwise) from the first day of default to the run date, actual/365, split at each.

POST https://daten.halowerk.com/v1/dunning-run-plan

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
run_datestringYes
policyobjectNo
itemsarrayYes
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "run_date",
    "items"
  ],
  "properties": {
    "run_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "policy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "grace_days": {
          "type": "integer",
          "minimum": 0,
          "maximum": 90,
          "default": 7,
          "description": "Days after the due date before the first reminder."
        },
        "interval_days": {
          "type": "integer",
          "minimum": 1,
          "maximum": 90,
          "default": 14,
          "description": "Minimum days between two dunning levels."
        },
        "max_level": {
          "type": "integer",
          "minimum": 1,
          "maximum": 5,
          "default": 3
        },
        "min_amount": {
          "type": "string",
          "pattern": "^\\d{1,12}(\\.\\d{1,2})?$",
          "default": "5.00"
        },
        "fees": {
          "type": "array",
          "maxItems": 5,
          "items": {
            "type": "string",
            "pattern": "^\\d{1,12}(\\.\\d{1,2})?$"
          },
          "description": "Fee per letter for level 1..n."
        },
        "payment_deadline_days": {
          "type": "integer",
          "minimum": 1,
          "maximum": 60,
          "default": 10
        },
        "compute_interest": {
          "type": "boolean",
          "default": true
        },
        "claim_flat_fee": {
          "type": "boolean",
          "default": false,
          "description": "Add the 40 EUR flat fee of § 288 Abs. 5 BGB for non-consumers in default."
        }
      }
    },
    "items": {
      "type": "array",
      "minItems": 1,
      "maxItems": 2000,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "customer_id",
          "amount",
          "due_date"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "customer_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "amount": {
            "type": "string",
            "pattern": "^\\d{1,12}(\\.\\d{1,2})?$",
            "description": "Open amount."
          },
          "due_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "last_level": {
            "type": "integer",
            "minimum": 0,
            "maximum": 5,
            "default": 0
          },
          "last_dunning_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "consumer": {
            "type": "boolean",
            "default": false
          },
          "consumer_notice_on_invoice": {
            "type": "boolean",
            "default": false
          },
          "first_reminder_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "default_since": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "description": "First day of default if known."
          },
          "disputed": {
            "type": "boolean",
            "default": false
          }
        }
      }
    }
  }
}

Open original schema

Published input example

{
  "run_date": "2026-11-02",
  "policy": {
    "fees": [
      "0.00",
      "5.00",
      "10.00"
    ]
  },
  "items": [
    {
      "id": "R-100",
      "customer_id": "K-1",
      "amount": "500.00",
      "due_date": "2026-10-20"
    }
  ]
}

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 →