Skip to content
HALOWERK

Rechenwerk

claim statement

Runs a ledger from the interest start dates to the statement date: default interest per claim (base rate table of the Deutsche Bundesbank as of 2026-10-30 plus § 288 points) accrues on the open principal only (§ 289: no interest on interest, no interest on costs) and is rounded to cents at each payment and at the statement date. Each payment is credited first to costs, then interest, then principal (§ 367(1) BGB), or costs, principal, interest for consumer loans (§ 497(3)); across several.

POST https://rechen.halowerk.com/v1/claim-statement

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
claimsarrayYes
costsarrayNo
paymentsarrayNo
as_ofstringYesStatement date; interest runs up to and including this day.
rate_typestringNoconsumer = § 288(1) BGB (+5 points, a consumer is involved or not a payment claim); business = § 288(2) BGB (+9 points, payment claim without consumer); real_estate_consumer_loan = § 497(4) BGB (+2.5 points).
allocationstringNobgb_367: costs, interest, principal (§ 367(1) BGB); consumer_credit_497: costs, principal, interest (§ 497(3) BGB).
day_countstringNoDay-count convention: act_365 (default, common for default interest), act_act, act_360, 30e_360.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "claims",
    "as_of"
  ],
  "properties": {
    "claims": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "amount"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "description": "Claim reference."
          },
          "amount": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000000,
            "description": "Principal in EUR."
          },
          "interest_from": {
            "type": "string",
            "format": "date",
            "description": "First day of default interest (inclusive); omit for no interest."
          },
          "rate_type": {
            "type": "string",
            "enum": [
              "consumer",
              "business",
              "real_estate_consumer_loan"
            ],
            "default": "consumer",
            "description": "consumer = § 288(1) BGB (+5 points, a consumer is involved or not a payment claim); business = § 288(2) BGB (+9 points, payment claim without consumer); real_estate_consumer_loan = § 497(4) BGB (+2.5 points)."
          }
        }
      }
    },
    "costs": {
      "type": "array",
      "maxItems": 100,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "amount"
        ],
        "properties": {
          "description": {
            "type": "string",
            "maxLength": 200,
            "description": "e.g. reminder fee, court fee."
          },
          "amount": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "Cost amount in EUR (not interest-bearing)."
          },
          "date": {
            "type": "string",
            "format": "date",
            "description": "Date the cost arose (for ordering)."
          }
        }
      }
    },
    "payments": {
      "type": "array",
      "maxItems": 500,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "date",
          "amount"
        ],
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "description": "Date the payment was credited."
          },
          "amount": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000000,
            "description": "Payment in EUR."
          }
        }
      }
    },
    "as_of": {
      "type": "string",
      "format": "date",
      "description": "Statement date; interest runs up to and including this day."
    },
    "rate_type": {
      "type": "string",
      "enum": [
        "consumer",
        "business",
        "real_estate_consumer_loan"
      ],
      "default": "consumer",
      "description": "consumer = § 288(1) BGB (+5 points, a consumer is involved or not a payment claim); business = § 288(2) BGB (+9 points, payment claim without consumer); real_estate_consumer_loan = § 497(4) BGB (+2.5 points)."
    },
    "allocation": {
      "type": "string",
      "enum": [
        "bgb_367",
        "consumer_credit_497"
      ],
      "default": "bgb_367",
      "description": "bgb_367: costs, interest, principal (§ 367(1) BGB); consumer_credit_497: costs, principal, interest (§ 497(3) BGB)."
    },
    "day_count": {
      "type": "string",
      "enum": [
        "act_365",
        "act_act",
        "act_360",
        "30e_360"
      ],
      "default": "act_365",
      "description": "Day-count convention: act_365 (default, common for default interest), act_act, act_360, 30e_360."
    }
  }
}

Open original schema

Published input example

{
  "claims": [
    {
      "id": "RE-1",
      "amount": 1000,
      "interest_from": "2026-01-01"
    }
  ],
  "costs": [
    {
      "description": "reminder fee",
      "amount": 10
    }
  ],
  "payments": [
    {
      "date": "2026-02-01",
      "amount": 500
    }
  ],
  "as_of": "2026-03-31"
}

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 →