Uitgaven API

 

The Uitgaven API helps you get the reference data for expenditures of a particular household.

 

Referentiebedragen

Based on the information provided for a household type get the reference amount for different expenditure type. Updated with 2021 data/calculations of expenditures


Try it
Request

 

Request URL

 

Request parameters
  • (optional)
    string

    Your Ocp-Apim-Subscription-Key

Request headers
  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.
Request body

{
hoofdpersonen : array
kinderen : array
huisgenoten : array
autos : array
woning : object
nettoBesteedbaarInkomenPerMaand : number
adviesdatum : string
}

<?xml version="1.0" encoding="UTF-8"?>
<Gezin xmlns="http://nibud.nl/uitgaven">
    <Autos>
        <Auto>
            <KilometersPerJaar>25000</KilometersPerJaar>
            <Nieuwwaarde>21000</Nieuwwaarde>
            <Status>Nieuw</Status>
        </Auto>
    </Autos>
    <Hoofdpersonen>
        <Hoofdpersoon>
            <Geboortedatum>1963-01-01</Geboortedatum>
        </Hoofdpersoon>
        <Hoofdpersoon>
            <Geboortedatum>1963-01-01</Geboortedatum>
        </Hoofdpersoon>
    </Hoofdpersonen>
    <Kinderen>
        <Kind>
            <Geboortedatum>2003-01-01</Geboortedatum>
        </Kind>
        <Kind>
            <Geboortedatum>1997-01-01</Geboortedatum>
        </Kind>
    </Kinderen>
    <NettoBesteedbaarInkomenPerMaand>6000</NettoBesteedbaarInkomenPerMaand>
    <Woning>
        <Bouwjaar>Van1989TotEnMet2000</Bouwjaar>
        <Soort>Koopwoning</Soort>
        <TypeWoning>VrijstaandGroot</TypeWoning>
        <WozWaarde>375000</WozWaarde>
    </Woning>
</Gezin>
{
  "example": "{\n  \"hoofdpersonen\": [\n    { \"geboortedatum\": \"1963-01-01\" },\n    { \"geboortedatum\": \"1963-01-01\" }\n  ],\n  \"kinderen\": [\n    { \"geboortedatum\": \"2003-01-01\" },\n    { \"geboortedatum\": \"1997-01-01\" }\n  ],\n  \"autos\": [\n    {\n      \"nieuwwaarde\": 21000,\n      \"kilometersPerJaar\": 25000,\n      \"status\": \"Nieuw\"\n    }\n  ],\n  \"nettoBesteedbaarInkomenPerMaand\": 6000,\n  \"woning\": {\n    \"soort\": \"Koopwoning\",\n    \"typeWoning\": \"VrijstaandGroot\",\n    \"bouwjaar\": \"Van1989TotEnMet2000\",\n    \"wozWaarde\": 375000\n  }\n}"
}
{
  "Hoofdpersonen": [
    {
      "Geslacht": "Man",
      "Geboortedatum": "1980-01-01"
    },
    {
      "Geslacht": "Vrouw",
      "Geboortedatum": "1980-01-01"
    }
  ],
  "Kinderen": [
    {
      "Schooltype": "Basis",
      "Geslacht": "Man",
      "Geboortedatum": "2012-01-01",
      "Woonsituatie": "Thuiswonend"
    }
  ],
  "Autos": [
    {
      "Nieuwwaarde": 20000,
      "KilometersPerJaar": 10000,
      "Status": "Nieuw"
    }
  ],
  "Huisgenoten": [
    {
      "Geslacht": null,
      "Geboortedatum": "2012-01-01"
    }
  ],
  "Adviesdatum": "2021-03-24",
  "Woning": {
    "WozWaarde": 0,
    "Soort": "Huurwoning",
    "TypeWoning": "Galerij",
    "Bouwjaar": "Na2001",
    "Energielabel": "C",
    "GemeenteId": 10,
    "GemeenteCbsId": "1680"
  },
  "NettoBesteedbaarInkomenPerMaand": 3000
}
{
  "type": "object",
  "properties": {
    "hoofdpersonen": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "geboortedatum": {
            "type": "string"
          },
          "geslacht": {
            "type": "string"
          }
        },
        "required": [
          "geboortedatum"
        ]
      }
    },
    "kinderen": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "geboortedatum": {
            "type": "string"
          },
          "geslacht": {
            "type": "string"
          }
        },
        "required": [
          "geboortedatum"
        ]
      }
    },
    "autos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "nieuwwaarde": {
            "type": "string"
          },
          "kilometersPerJaar": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "nieuwwaarde",
          "kilometersPerJaar",
          "status"
        ]
      }
    },
    "nettoBesteedbaarInkomenPerMaand": {
      "type": "integer"
    },
    "woning": {
      "type": "object",
      "properties": {
        "soort": {
          "type": "string"
        },
        "typeWoning": {
          "type": "string"
        },
        "bouwjaar": {
          "type": "string"
        },
        "energielabel": {
          "type": "string"
        },
        "wozWaarde": {
          "type": "integer"
        },
        "gemeenteCbsId": {
          "type": "string"
        }
      },
      "required": [
        "soort",
        "typeWoning",
        "bouwjaar",
        "bouwenergielabel"
      ]
    }
  },
  "required": [
    "nettoBesteedbaarInkomenPerMaand",
    "woning",
    "hoofdpersonen",
    "kinderen"
  ]
}

Responses

200 OK

Please see the Technical Documentation for the response.

Sample output can be viewed by using the ‘Try it’ button above.

Code samples
@ECHO OFF

curl -v -X POST "https://api.nibud.nl/Uitgaven/v5/Referentiebedragen?key={string}"
-H "Content-Type: application/xml"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["key"] = "{string}";
            var uri = "https://api.nibud.nl/Uitgaven/v5/Referentiebedragen?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.nibud.nl/Uitgaven/v5/Referentiebedragen");

            builder.setParameter("key", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/xml");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "key": "{string}",
        };
      
        $.ajax({
            url: "https://api.nibud.nl/Uitgaven/v5/Referentiebedragen?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/xml");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.nibud.nl/Uitgaven/v5/Referentiebedragen";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"key={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/xml" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.nibud.nl/Uitgaven/v5/Referentiebedragen');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/xml',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'key' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/xml',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'key': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.nibud.nl')
    conn.request("POST", "/Uitgaven/v5/Referentiebedragen?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/xml',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'key': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.nibud.nl')
    conn.request("POST", "/Uitgaven/v5/Referentiebedragen?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.nibud.nl/Uitgaven/v5/Referentiebedragen')

query = URI.encode_www_form({
    # Request parameters
    'key' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/xml'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body