Technical documentation Pensioenuitgaven API
This document provides an overview of input and the output data from Pensioenuitgaven API. Not all input data are required. The API is designed to handle the optional input data by assigning a default input value. This makes it flexible to deliver the output shown to the user in different ways.
POST Platform
The API can be called using HTTP Post and it can accept JSON or XML input types.
1. JSON Input
The JSON input consists of an object with several keys:
JSON Key
JSON Data Type
Hoofdpersonen
Kinderen
Autos
Woning
NettoBesteedbaarInkomenPerMaand
Array
Array
Array
Object
Number
Hoofdpersonen must have at least one and a maximum of two Hoofdpersoon object(s) . Hoofdpersoon objects have the following keys::
Key
Data type
Enums
Geslacht
Number/String
0 / Man | 1 / Vrouw
Kinderen can be an empty array or can contain Kind objects. Kind objects have the following keys:
Key
Data type
Enums
Leeftijd
Geslacht (Optional)
Integer
Number/String
NA
0 / Man, 1 / Vrouw
Autos can be an empty array or can contain Auto objects. Auto objects have the following keys:
Key
Data type
Enums
AutoKilometersPerJaar
TypeAuto
StatusAuto
Number / String
Number / String
Number/String
0 / Minderdan10K
1 / Tussen10Ken20K
2 / Meerdan20K
0 / Klein
1 / Compact
2 / CompactMiddenklasse
3 / Middenklasse
0 / Nieuw, 1 / Tweedehands
NettoBesteedbaarInkomenPerMaand is a JSON data with number as data type. It must have a value.
Woning is an object with the following keys and functions. Please supply only WozWaarde OR WozWaardeCategorie.:
Key
Data type
Enums
SoortWoning
TypeWoning
WozWaardeCategorie
WozWaarde
Number / String
Number/String
Number/String
Number
0 / Huurwoning, 1 / Koopwoning
0 / Appartement
1 / Tussenwoning
2 / Hoekwoning
3 / Vrijstaand
0 / WozKleinerDan150K
1 / WozVan150KTot300K
2 / WozVan300KTot450K
3 / WozGroterDan450K
An example of JSON input
3. The Output
The output contains different household expenditures targeted at financial institutions in the process of retirement. If a different grouping is required, you can use the Uitgaven API. This can be discussed with Nibud for the different household expenditures in order to provide best suited output format for the application where the Uitgaven/Pensioenuitgaven API is being used.
For each expenditure the reference amount is returned by the API. The amounts returned depend on the income.
Key
Value Json
Bedrag
Uitgavepost
Number
Number
Every uitgavepost is identified by a unique id:
Uitgavepost
Json Id
Woning
Energie en lokale lasten
Vervoer
Andere vaste lasten
Onverwachte uitgaven
Vrijetijdsuitgaven
Huishoudelijke uitgaven
Overige uitgaven
0
1
2
3
4
5
6
7
Every uitgavepost of pensioenuitgaven is mapped to uitgaven. In the table below you will find this mapping
An example of JSON output
