Skip to content
HALOWERK

Formatwerk

receivables aging

Days overdue = reference date minus due date (or invoice date plus payment terms, or invoice date as basis). Items are assigned to "not due", 1-30, 31-60, 61-90 and over 90 days (bucket limits configurable). Per currency: gross open amount, credit notes (negative items, kept separate), net open amount, overdue amount and share, amount-weighted average days overdue and amount, count and share per bucket; per customer: amounts per bucket and the oldest overdue item; plus the 20 oldest overdue.

POST https://format.halowerk.com/v1/receivables-aging

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
itemsarrayYesOpen items.
reference_datestringNoReference date, default today (UTC).
bucketsarrayNoUpper limits of the overdue buckets in days.
basisstringNoAge by due date or by invoice date.
payment_terms_daysintegerNoUsed when due_date is missing: due = invoice_date + terms.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100000,
      "description": "Open items.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "amount"
        ],
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 64,
            "description": "Item id."
          },
          "customer": {
            "type": "string",
            "maxLength": 140,
            "description": "Customer or supplier."
          },
          "amount": {
            "type": [
              "number",
              "string"
            ],
            "description": "Open amount; negative = credit note."
          },
          "due_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "description": "Due date."
          },
          "invoice_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "description": "Invoice date."
          },
          "currency": {
            "type": "string",
            "pattern": "^[A-Z]{3}$",
            "default": "EUR",
            "description": "Currency."
          }
        }
      }
    },
    "reference_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Reference date, default today (UTC)."
    },
    "buckets": {
      "type": "array",
      "minItems": 1,
      "maxItems": 8,
      "items": {
        "type": "integer",
        "minimum": 1,
        "maximum": 3650
      },
      "default": [
        30,
        60,
        90
      ],
      "description": "Upper limits of the overdue buckets in days."
    },
    "basis": {
      "type": "string",
      "enum": [
        "due_date",
        "invoice_date"
      ],
      "default": "due_date",
      "description": "Age by due date or by invoice date."
    },
    "payment_terms_days": {
      "type": "integer",
      "minimum": 0,
      "maximum": 365,
      "default": 0,
      "description": "Used when due_date is missing: due = invoice_date + terms."
    }
  }
}

Open original schema

Published input example

{
  "reference_date": "2026-11-01",
  "items": [
    {
      "id": "A1",
      "customer": "Alpha GmbH",
      "amount": "1000.00",
      "due_date": "2026-11-15"
    },
    {
      "id": "A2",
      "customer": "Alpha GmbH",
      "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 โ†’