/compute/cash-ladder-taxable-flows

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

POST `/compute/cash-ladder-taxable-flows`

Compute interest flows whose calculation-period end dates fall within a tax year.

JSON request body

cashLadder (required) — cash-ladder identifier.
taxAuthority (required) — HMRC or SARS.
taxYear (optional) — tax year such as 2024/25; defaults to the current tax year for the selected authority.

Example request

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

{
  "cashLadder": "MyCashLadder",
  "taxAuthority": "HMRC",
  "taxYear": "2024/25"
}

Example response — 200

{
  "name": "Ladder Taxable Flows",
  "description": "MyCashLadder. Tax authority HMRC, tax year 2024/25.",
  "columns": ["accountAlias", "type", "amount", "currency", "paymentDate", "startDate", "endDate", "notional", "rate", "taxAuthority", "taxYear"],
  "columnTypes": {
    "amount": "Decimal",
    "notional": "Decimal",
    "rate": "Decimal"
  },
  "rows": [
    {
      "accountAlias": "Aldermore-Sep28",
      "type": "Interest",
      "amount": "210.00",
      "currency": "GBP",
      "paymentDate": "2025-01-01",
      "startDate": "2024-07-01",
      "endDate": "2025-01-01",
      "notional": "10000",
      "rate": "0.042",
      "taxAuthority": "HMRC",
      "taxYear": "2024/25"
    }
  ]
}

For CSV, send Accept: text/csv.

GET `/compute/cash-ladder-taxable-flows`

GET supplies the same operation parameters in the query string.

GET /compute/cash-ladder-taxable-flows?cashLadder=MyCashLadder&taxAuthority=HMRC&taxYear=2024%2F25

The response has the same shape as the POST response.

← Back to API