Babylon Icon

/compute/cashflows

Base URL
https://api.babylon.app/v1

POST /compute/cashflows

Compute known and estimated future cashflows: bond coupons/redemptions, term-deposit interest/maturities, and equity dividends.
You can derive cashflows from a segment and/or a ladder.

Query parameters

  • segmentLedger (optional*) – The ID of the segment to analyse.
  • ladder (optional*) – The ID of the ladder to analyse.
  • reportingCurrency (optional) – ISO 4217 code (GBP, USD, ZAR, etc.) for reporting; defaults to each row’s own currency.
  • format (optional) – Use csv for CSV output, otherwise JSON.
  • columns (optional) – Comma-separated list to select and order fields in the response.

* At least one of segmentLedger or ladder must be provided. If both are provided, results are combined.

Example request

POST /compute/cashflows

{
	segmentLedger: "MyGBSegment",
	reportingCurrency: "GBP"
}

Example response

{
  "cashflows": {
    "date": ["2025-01-31", "2025-03-15", "2025-06-30", "2025-08-31", "2025-09-30"],
    "amount": [1250.00, 410.50, 1250.00, 275.00, 10000.00],
    "currency": ["GBP", "GBP", "GBP", "GBP", "GBP"],
    "type": ["BondCoupon", "DividendKnown", "BondCoupon", "TermDepositCoupon", "TermDepositMaturity"],
    "source": ["LSE:UKTB202701", "LSE:PNL", "LSE:UKTB202701", "HL-CashLadder-1", "HL-CashLadder-1"],
    "amountInReporting": [1250.00, 410.50, 1250.00, 275.00, 10000.00],
    "reportingCurrency": ["GBP", "GBP", "GBP", "GBP", "GBP"]
  }
}

Example request (CSV)

POST /compute/cashflows

{
	segmentLedger: "MyGBSegment"
	format: "csv"
}

Example response (CSV)

Date,Amount,Currency,Type,Source,AmountInReporting,ReportingCurrency
2025-01-31,1250.00,GBP,BondCoupon,LSE:UKTB202701,1250.00,GBP
2025-03-15,410.50,GBP,DividendKnown,LSE:PNL,410.50,GBP
2025-06-30,1250.00,GBP,BondCoupon,LSE:UKTB202701,1250.00,GBP
2025-08-31,275.00,GBP,TermDepositCoupon,HL-CashLadder-1,275.00,GBP
2025-09-30,10000.00,GBP,TermDepositMaturity,HL-CashLadder-1,10000.00,GBP

GET /compute/cashflows

Similar to POST, however POST is preferred.

Notes

  • Types are standardised values describing the nature of each cashflow.
  • Source provides the specific origin: bourse:symbol for securities (bonds, dividends) and accountAlias for ladder entries (term deposits).

← Back to API