Skip to content
HALOWERK

Finopswerk

tips settlement redemption ledger

Reconciles one US Treasury Inflation-Protected Security's original face with the buyer's settlement invoice, current coupon and a separately supplied maturity redemption observation. The caller supplies index_ratios_1e6 with [0] = settlement ratio and [1] = final maturity ratio, each integer/1e6; annual_coupon_1e5/100000 is the stated coupon (125 = 0.125%). It does not verify published ratios or forecast future CPI; the caller must verify the source.

POST https://finops.halowerk.com/v1/tips-settlement-redemption-ledger

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
face_dollarsintegerYes
index_ratios_1e6arrayYes
annual_coupon_1e5integerYes
clean_price_micros_per100integerYes
accrual_daysintegerYes
coupon_period_daysintegerYes
capture_indexintegerYes
captured_ratio_domain_1e6arrayYes
reportobjectYes
Show full input schema
{
  "type": "object",
  "properties": {
    "face_dollars": {
      "type": "integer",
      "minimum": 100,
      "maximum": 10000000
    },
    "index_ratios_1e6": {
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "items": {
        "type": "integer",
        "minimum": 500000,
        "maximum": 3000000
      }
    },
    "annual_coupon_1e5": {
      "type": "integer",
      "minimum": 125,
      "maximum": 10000
    },
    "clean_price_micros_per100": {
      "type": "integer",
      "minimum": 1,
      "maximum": 300000000
    },
    "accrual_days": {
      "type": "integer",
      "minimum": 0,
      "maximum": 183
    },
    "coupon_period_days": {
      "type": "integer",
      "minimum": 181,
      "maximum": 184
    },
    "capture_index": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1
    },
    "captured_ratio_domain_1e6": {
      "type": "array",
      "minItems": 1,
      "maxItems": 2,
      "uniqueItems": true,
      "items": {
        "type": "integer",
        "minimum": 500000,
        "maximum": 3000000
      }
    },
    "report": {
      "type": "object",
      "minProperties": 24,
      "maxProperties": 24,
      "propertyNames": {
        "enum": [
          "original_face",
          "settlement_index_ratio",
          "maturity_index_ratio",
          "settlement_adjusted_principal",
          "settlement_principal_adjustment",
          "annual_coupon_rate",
          "settlement_semiannual_coupon",
          "accrual_fraction",
          "unadjusted_accrued_interest",
          "adjusted_accrued_interest",
          "clean_price_per100",
          "unadjusted_clean_value",
          "adjusted_clean_value",
          "settlement_invoice",
          "unadjusted_invoice",
          "invoice_indexation_delta",
          "maturity_adjusted_principal",
          "maturity_principal_payable",
          "maturity_floor_topup",
          "maturity_final_coupon",
          "maturity_total_payable",
          "settlement_rounding_delta",
          "invoice_components_gap",
          "maturity_floor_bridge_gap"
        ]
      },
      "additionalProperties": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "n",
          "d"
        ],
        "properties": {
          "n": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "d": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          }
        }
      }
    }
  },
  "required": [
    "face_dollars",
    "index_ratios_1e6",
    "annual_coupon_1e5",
    "clean_price_micros_per100",
    "accrual_days",
    "coupon_period_days",
    "capture_index",
    "captured_ratio_domain_1e6",
    "report"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "face_dollars": 100,
  "index_ratios_1e6": [
    999999,
    1000001
  ],
  "annual_coupon_1e5": 125,
  "clean_price_micros_per100": 100000000,
  "accrual_days": 1,
  "coupon_period_days": 181,
  "capture_index": 1,
  "captured_ratio_domain_1e6": [
    1000001
  ],
  "report": {
    "original_face": {
      "n": "10000",
      "d": "1"
    },
    "settlement_index_ratio": {
      "n": "999999",
      "d": "1000000"
    },
    "maturity_index_ratio": {
      "n": "1000001",
      "d": "1000000"
    },
    "settlement_adjusted_principal": {
      "n": "999999",
      "d": "100"
    },
    "settlement_principal_adjustment": {
      "n": "-1",
      "d": "100"
    },
    "annual_coupon_rate": {
      "n": "1",
      "d": "800"
    },
    "settlement_semiannual_coupon": {
      "n": "999999",
      "d": "160000"
    },
    "accrual_fraction": {
      "n": "1",
      "d": "181"
    },
    "unadjusted_accrued_interest": {
      "n": "69",
      "d": "2000"
    },
    "adjusted_accrued_interest": {
      "n": "69",
      "d": "2000"
    },
    "clean_price_per100": {
      "n": "100",
      "d": "1"
    },
    "unadjusted_clean_value": {
      "n": "10000",
      "d": "1"
    },
    "adjusted_clean_value": {
      "n": "999999",
      "d": "100"
    },
    "settlement_invoice": {
      "n": "20000049",
      "d": "2000"
    },
    "unadjusted_invoice": {
      "n": "20000069",
      "d": "2000"
    },
    "invoice_indexation_delta": {
      "n": "-1",
      "d": "100"
    },
    "maturity_adjusted_principal": {
      "n": "1000001",
      "d": "100"
    },
    "maturity_principal_payable": {
      "n": "1000001",
      "d": "100"
    },
    "maturity_floor_topup": {
      "n": "0",
      "d": "1"
    },
    "maturity_final_coupon": {
      "n": "1000001",
      "d": "160000"
    },
    "maturity_total_payable": {
      "n": "1601001601",
      "d": "160000"
    },
    "settlement_rounding_delta": {
      "n": "69",
      "d": "2000000000"
    },
    "invoice_components_gap": {
      "n": "0",
      "d": "1"
    },
    "maturity_floor_bridge_gap": {
      "n": "0",
      "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 โ†’