Skip to main content
Version: v3

Budget Service

The Budget Service calculates the monthly spending capacity of a household across various categories based on the household's aggregated financial data and profile. The service relies on output from the Aggregate Service and optionally, a personalized Profile, or a manually entered profile. The calculated budget aligns with annual budget guidelines determined by Nibud.

Key Features:

  • Category Budgets: Provides expected average spending amounts per category, calculated according to Nibud’s yearly budget schemes.
  • Detailed Category Breakdown: Results include detailed category nodes, which consist of cost types, category amounts, and values, offering more granular insights into household spending.
  • Profile Flexibility: Allows the use of either the generated profile from the Profile Service or a manually entered profile.

Budget Service Output Formats

The Budget service supports multiple output formats. By setting the Accept header, you can specify the format of the response:

  • JSON (default): Standard format for API responses.
  • PDF: A formatted, print-friendly version of the data.

Setting the Accept Header

To receive a specific format, include the Accept header in your request with one of the following values:

  • For JSON: application/json
  • For PDF: application/pdf

For more information, refer to the MDN documentation on the Accept header.

Calling the Budget service

Please refer to the API reference for the Budget service for all technical details on how to call this service.

Output:

The service returns:

  • Expected Monthly Averages: Average spending amounts per category, based on Nibud’s budget guidelines.
  • Detailed Category Structure:
    • Nodes: Information about category groups, including cost type, amounts, and subcategories.
    • Categories: Includes category names, amounts, and values for each cost type.
    • Transaction Overview: Number of categorized transactions, total amounts, debits, and credits.
  • Date Range: The service also provides the date range of the transactions considered in the budget, indicating the "from" and "to" dates.