API Reference

DraftLast reviewed 2026-06-23

List cashflows for a deal

GET 
/api/v1/cashflows/deal/:dealId

Returns the cashflow schedule for a deal, including each cashflow's id, type, status, payment date, and amount. The id is required to fix a PROJECTED FLOAT_COUPON via POST /api/v1/cashflows/{id}/fix.

Request

Responses

200

Cashflows returned (empty list if none)

401

Authentication required

403

Insufficient scope — requires deals:read

404

Deal not found or not visible to the caller