GET /users/{id_or_external_id}/budget

Fetch information of an user's budget, spending distribution, including average monthly budget over the past 12 months, essential and non-essential expenditure, top-3 spending categories.

Path parameters

  • id_or_external_id string Required

    UUID or external ID of a user profile to get access to their reports and data.

Responses

  • 200

    User budget retrieved

    Hide response attributes Show response attributes object
    • budget_distribution array[object]

      Average budget items distribution (in %)

      Hide budget_distribution attributes Show budget_distribution attributes array[object]
      • category_group string

        Category group code name

        Values are entertainment, food, home, house, misc, transport, shopping, or wellness.

      • name string

        Category group name

        Values are Household & Services, Food & Drinks, Transport, Home impovements / repair, Other, Leisure, Shopping, or Health & Beauty.

      • total number

        Average monthly amouunt spend on the defined category group (in %).

    • budget_items array[object]

      Average budget over the past 12 months

      Hide budget_items attributes Show budget_items attributes array[object]
      • category_group string

        Category group code name

        Values are entertainment, food, home, house, misc, transport, shopping, or wellness.

      • name string

        Category group name

        Values are Household & Services, Food & Drinks, Transport, Home impovements / repair, Other, Leisure, Shopping, or Health & Beauty.

      • total number

        Average monthly amouunt spend on the defined category group.

    • expenditures object
      Hide expenditures attributes Show expenditures attributes object
      • essential number

        Average percentage of tthe budget that goes to essential expenditure

      • non_essential number

        Average percentage of tthe budget that goes to non-essential expenditure

      • top3 array[object]

        List of TOP-3 monthly expenses

        Hide top3 attributes Show top3 attributes array[object]
        • category_group string

          Category group code name

          Values are entertainment, food, home, house, misc, transport, shopping, or wellness.

        • name string

          Category group name

          Values are Household & Services, Food & Drinks, Transport, Home impovements / repair, Other, Leisure, Shopping, or Health & Beauty.

        • total number

          Average monthly amouunt spend on the defined category group.
  • 404

    User not found

  • 500

    The request is not valid.

    Hide response attributes Show response attributes object
    • error_message string

      Human readable error message.

    • error string

      Error code & short status
GET /users/{id_or_external_id}/budget 
curl \
 -X GET https://link.goscore.me/finid-api/1.0/users/{id_or_external_id}/budget \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "budget_items": [
    {
      "category_group": "food",
      "name": "Food & Drinks",
      "amount": 3850
    },
    {
      "category_group": "Home",
      "name": "Household & Services",
      "amount": 11858
    },
    {
      "category_group": "transport",
      "name": "Transport",
      "amount": 1212
    }
  ]
}
Response examples (200) 
{
  "budget_distribution": [
    {
      "category_group": "entertainment",
      "name": "Household & Services",
      "total": 42.0
    }
  ],
  "budget_items": [
    {
      "category_group": "entertainment",
      "name": "Household & Services",
      "total": 42.0
    }
  ],
  "expenditures": {
    "essential": 42.0,
    "non_essential": 42.0,
    "top3": [
      {
        "category_group": "entertainment",
        "name": "Household & Services",
        "total": 42.0
      }
    ]
  }
}
Response examples (500) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}
Response examples (500) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}