Skip to content
HALOWERK

Finopswerk

participating debt waterfall

Allocates two equal modeled periods of participating debt cash under a synthetic contractual waterfall: opening coupon arrears first, current coupon second, all overdue plus newly due principal third, residual cash split between lender participation and sponsor last. Current coupon = opening outstanding principal * rate_bp/10000. An unpaid coupon carries without interest-on-interest. Cash is already net of operating costs, other creditors, taxes and fees.

POST https://finops.halowerk.com/v1/participating-debt-waterfall

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
principal_nintegerYes
coupon_arrears_nintegerYes
cash_narrayYes
new_principal_due_narrayYes
rate_bpintegerYes
participation_bpintegerYes
amount_denominatorintegerYes
reportobjectYes
Show full input schema
{
  "type": "object",
  "required": [
    "principal_n",
    "coupon_arrears_n",
    "cash_n",
    "new_principal_due_n",
    "rate_bp",
    "participation_bp",
    "amount_denominator",
    "report"
  ],
  "properties": {
    "principal_n": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "coupon_arrears_n": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "cash_n": {
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 1000000
      }
    },
    "new_principal_due_n": {
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 1000000
      }
    },
    "rate_bp": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    },
    "participation_bp": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    },
    "amount_denominator": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "report": {
      "type": "object",
      "minProperties": 26,
      "maxProperties": 26,
      "propertyNames": {
        "enum": [
          "p1_coupon",
          "p1_old_coupon_paid",
          "p1_current_coupon_paid",
          "p1_principal_due",
          "p1_principal_paid",
          "p1_residual_pool",
          "p1_participation",
          "p1_sponsor",
          "p1_closing_principal",
          "p1_closing_coupon_arrears",
          "p1_closing_principal_arrears",
          "p1_cash_gap",
          "p2_coupon",
          "p2_old_coupon_paid",
          "p2_current_coupon_paid",
          "p2_principal_due",
          "p2_principal_paid",
          "p2_residual_pool",
          "p2_participation",
          "p2_sponsor",
          "p2_closing_principal",
          "p2_closing_coupon_arrears",
          "p2_closing_principal_arrears",
          "p2_cash_gap",
          "total_lender_cash",
          "total_sponsor_cash"
        ]
      },
      "additionalProperties": {
        "type": "object",
        "required": [
          "n",
          "d"
        ],
        "properties": {
          "n": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "d": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}

Open original schema

Published input example

{
  "principal_n": 100,
  "coupon_arrears_n": 5,
  "cash_n": [
    3,
    130
  ],
  "new_principal_due_n": [
    20,
    80
  ],
  "rate_bp": 1000,
  "participation_bp": 2500,
  "amount_denominator": 1,
  "report": {
    "p1_coupon": {
      "n": "10",
      "d": "1"
    },
    "p1_old_coupon_paid": {
      "n": "3",
      "d": "1"
    },
    "p1_current_coupon_paid": {
      "n": "0",
      "d": "1"
    },
    "p1_principal_due": {
      "n": "20",
      "d": "1"
    },
    "p1_principal_paid": {
      "n": "0",
      "d": "1"
    },
    "p1_residual_pool": {
      "n": "0",
      "d": "1"
    },
    "p1_participation": {
      "n": "0",
      "d": "1"
    },
    "p1_sponsor": {
      "n": "0",
      "d": "1"
    },
    "p1_closing_principal": {
      "n": "100",
      "d": "1"
    },
    "p1_closing_coupon_arrears": {
      "n": "12",
      "d": "1"
    },
    "p1_closing_principal_arrears": {
      "n": "20",
      "d": "1"
    },
    "p1_cash_gap": {
      "n": "0",
      "d": "1"
    },
    "p2_coupon": {
      "n": "10",
      "d": "1"
    },
    "p2_old_coupon_paid": {
      "n": "12",
      "d": "1"
    },
    "p2_current_coupon_paid": {
      "n": "10",
      "d": "1"
    },
    "p2_principal_due": {
      "n": "100",
      "d": "1"
    },
    "p2_principal_paid": {
      "n": "100",
      "d": "1"
    },
    "p2_residual_pool": {
      "n": "8",
      "d": "1"
    },
    "p2_participation": {
      "n": "2",
      "d": "1"
    },
    "p2_sponsor": {
      "n": "6",
      "d": "1"
    },
    "p2_closing_principal": {
      "n": "0",
      "d": "1"
    },
    "p2_closing_coupon_arrears": {
      "n": "0",
      "d": "1"
    },
    "p2_closing_principal_arrears": {
      "n": "0",
      "d": "1"
    },
    "p2_cash_gap": {
      "n": "0",
      "d": "1"
    },
    "total_lender_cash": {
      "n": "127",
      "d": "1"
    },
    "total_sponsor_cash": {
      "n": "6",
      "d": "1"
    }
  }
}

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 โ†’