v24

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-06-25129690.0 KB
transactions

Get the retirement capital transactions

Retrieves all transactions affecting the policy's retirement capital in the specified date range.

The resulting transaction list is sorted in chronological order, starting with the oldest transaction. If several transactions occurred on the same date, they are ordered such that adding the transaction amount to the previous transactions balance results in the balance provided by the current transaction.

The first transaction in the list is a pseudo transaction providing the carryover balance from the previous period. It is the only transaction with the category carryover.

The from date must be before or be equal to the to date.

The result contains a date range as well. It is usually equal to the request date range. However, if the requested from date is before the start of the policy or if the request to date is in the future, the date range may be adjusted to reflect the effective date range.

get/policies/{policyId}/transactions

Path parameters

policyIdstring required

Technical ID of policy used in API calls.

Example:Pol_56789-2024

Technical policy ID.

Query parameters

fromstring date required

Common date format.

Example:2018-04-13

Start of date range (inclusive).

tostring date required

Common date format.

Example:2018-04-13

End of date range (inclusive).

Response

Retirement capital transactions.

fromstring date required

Start of date range (inclusive).

tostring date required

End of date range (inclusive).

Example response

{
  "from": "2018-04-13",
  "to": "2018-04-13",
  "transactions": [
    {
      "amount": 10000,
      "balance": 63842.5,
      "category": "voluntaryPurchase",
      "date": "2018-04-13",
      "reason": "Freiwilliger Einkauf",
      "id": "TR-683463823"
    }
  ]
}