/compute/cash-ladder-flows

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

POST `/compute/cash-ladder-flows`

Compute cash flows on or after a value date for the term deposits in a cash ladder.

JSON request body

cashLadder (required) — cash-ladder identifier.
valueDate (optional) — earliest calculation date in YYYY-MM-DD format; defaults to the current date.

Example request

POST /compute/cash-ladder-flows
Content-Type: application/json

{
  "cashLadder": "MyCashLadder",
  "valueDate": "2026-01-01"
}

Example response — 200

{
  "flows": {
    "name": "Ladder Flows",
    "description": "MyCashLadder flows on or after 2026-01-01.",
    "columns": ["accountAlias", "type", "amount", "currency", "paymentDate", "startDate", "endDate", "notional", "rate"],
    "columnTypes": {
      "amount": "Decimal",
      "notional": "Decimal",
      "rate": "Decimal"
    },
    "rows": [
      {
        "accountAlias": "Aldermore-Sep28",
        "type": "Interest",
        "amount": "210.00",
        "currency": "GBP",
        "paymentDate": "2026-03-01",
        "startDate": "2025-09-01",
        "endDate": "2026-03-01",
        "notional": "10000",
        "rate": "0.042"
      }
    ]
  },
  "ladders": {
    "MyCashLadder": {
      "name": "MyCashLadder",
      "description": "",
      "columns": ["ladder", "accountAlias"],
      "columnTypes": {},
      "rows": [
        {"ladder": "MyCashLadder", "accountAlias": "Aldermore-Sep28"}
      ]
    }
  },
  "monthlyReport": {
    "name": "Ladder Flows",
    "description": "MyCashLadder flows as of 2026-01-01, aggregated by month in GBP.",
    "columns": ["monthIndex", "monthYear", "label", "amount", "currency"],
    "columnTypes": {},
    "rows": [
      {"monthIndex": 0, "monthYear": "2026-01-01", "label": "Jan 26", "amount": 0.0, "currency": "GBP"}
    ]
  }
}

The ladders object is keyed by cash-ladder identifier and contains the source ladder table. Cash-flow types are Interest, CompoundInterest, Principal and, where applicable, CapitalisedInterest.

The composite response is JSON. CSV output is not supported for this endpoint.

GET `/compute/cash-ladder-flows`

GET supplies the same operation parameters in the query string.

GET /compute/cash-ladder-flows?cashLadder=MyCashLadder&valueDate=2026-01-01

The response has the same shape as the POST response.

← Back to API