List a bond's remaining cash flows
cashflow_schedule_toolGenerate a bond's remaining payment schedule with dates, amounts, and discount factors from a yield, handling fractional settlement periods.
Instructions
Remaining payments, with discount factors when a yield is supplied.
The first flow sits a fraction of a period away rather than a whole one. That exponent is what makes an ACT/ACT ICMA yield differ from a naive one, so it is reported explicitly as periods_from_settlement.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"face_value": "<face_value>",
"coupon_rate_pct": "<coupon_rate_pct>",
"payments_per_year": "<payments_per_year>",
"issue_date": "<issue_date>",
"maturity_date": "<maturity_date>",
"settlement_date": "<settlement_date>"
},
"name": "cashflow_schedule_tool"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ytm_pct | No | Nominal annual yield as a percentage, e.g. 4.6867. Supply either this or clean_price_pct_of_face, never both. | |
| day_count | No | Day-count convention used for accrual. ACT/ACT ICMA is the standard for most government and corporate bonds. | ACT/ACT ICMA |
| face_value | Yes | Redemption amount in currency units, e.g. 1000. | |
| issue_date | Yes | Issue (dated) date in ISO format, e.g. 2024-03-15. | |
| maturity_date | Yes | Redemption date in ISO format, e.g. 2029-03-15. | |
| coupon_rate_pct | Yes | Annual coupon rate as a PERCENTAGE. Pass 4.0 for a 4% coupon, not 0.04. Zero for a zero-coupon bond. | |
| settlement_date | Yes | Valuation date in ISO format. Must fall between issue and maturity, e.g. 2025-09-11. | |
| payments_per_year | Yes | Coupon payments per year: 1 annual, 2 semi-annual, 4 quarterly, 12 monthly. Most government bonds pay semi-annually. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||