---
title: "Get Instrument Cashflows"
method: POST
path: "/api/instrument/{instrument_id}/cashflows"
tags: ["instruments"]
---

# Get Instrument Cashflows

`POST /api/instrument/{instrument_id}/cashflows`

## Request

- Base URL: `https://api.harmoney.in`
- URL: `https://api.harmoney.in/api/instrument/{instrument_id}/cashflows`
- Auth: API key in header `x-api-key`

Get cashflows for a debt instrument.

Returns calculated cashflows with database overrides applied.
If as_of_date is provided, returns only future cashflows (transaction_date >= as_of_date).
If as_of_date is None, returns all cashflows since inception.

## Path parameters

- `instrument_id` integer, required

## Request body

- CashflowRequest: Request schema for cashflows endpoint.
  - `quantum` union: Quantity/face value amount for cashflow calculation. Defaults to instrument's par value if not provided. Cannot be used together with 'quantity'.
    - number
    - string
  - `quantity` union: Number of units traded. If provided, quantum is calculated as quantity * par_value. Cannot be used together with 'quantum'.
    - number
    - string
  - `as_of_date` string, date, nullable: Date to calculate cashflows from. If not provided, returns all cashflows since inception
  - `termination_type` 'maturity' | 'call' | 'put': Termination type exposed via datafeed APIs.
  - `call_date` string, date, nullable: Optional call date to use for call termination calculations.
  - `put_date` string, date, nullable: Optional put date to use for put termination calculations.
  - `benchmark_rate` union: Current benchmark rate for floating/reset rate bonds. Used to calculate future coupon rates as (benchmark_rate + spread).
    - number
    - string

## Response `200`

Successful Response

- CashflowItem[]
  - `transaction_date` string, date, required: The transaction/payment date of the cashflow
  - `record_date` string, date, required: The record date of the cashflow (entitlement cutoff)
  - `transaction_type` string, required: Type of cashflow (Coupon Payment, Principal Payment, etc.)
  - `cashflow` string, required: Cashflow amount
  - `interest_days` integer, nullable: Number of interest days for coupon payments

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/inferedge/apis/india-fixed-income-data-feed.md) - [All operations](https://skmtc.dev/inferedge/apis/india-fixed-income-data-feed/llms.txt) - [OpenAPI document](https://skmtc.dev/inferedge/apis/india-fixed-income-data-feed/revisions/66687f780824?raw)