LElemon
Accounts: General

List Contribution Caps

Changed on
get/accounts/{account_id}/contribution_caps

Request

Path parameters

account_idstring required

An account identifier.

Query parameters

yearstring

Filter contribution caps by year.

productstring

Filter contribution caps by the identifier of a retirement product. If omitted, contribution caps for all retirement products of the account are returned. Responds with 404 if the product is not a retirement product of the account.

Headers

LMG-Data-Privacy-Access-Principalstring required
LMG-Data-Privacy-Access-Justificationstring required

Response

Successful Response

yearstring required

The year for the contribution cap.

productstring required

The identifier of the retirement product the contribution cap belongs to, used to retrieve its details via GET /accounts/{account_id}/products/{id}.

amount_totalstring required

The total contribution cap amount for the year and product.

amount_usedstring required

The amount of the contribution cap that has been used. Use the difference between amount_total - amount_used to determine the amount still available.

currencystring required

An ISO 4217 three-letter currency code. Its value represents the currency for the amount_total and amount_used listed here. The only currently available currency is "EUR".

Example response

[
  {
    "year": "2027",
    "product": "ret_7d1a8c0e5b8f4f3a9c2e6b1d4f0a9e57",
    "amount_total": "6840.00",
    "amount_used": "0.00",
    "currency": "EUR"
  }
]

Changes