Get expenditure options

GET /api/v2/household/{HouseholdGUID}/expenditure/options
Bearer auth

This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.

Path parameters

  • HouseholdGUID string(uuid) Required

    The GUID of the household you wish to get options for.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
  • 404 application/json

    Household not found

    Hide response attributes Show response attributes object
GET /api/v2/household/{HouseholdGUID}/expenditure/options 
curl \
 --request GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/expenditure/options \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "ExpenditureType": {
      "1": "Essential",
      "6": "Assurance",
      "5": "Lifestyle"
    },
    "Frequency": {
      "120": "one off",
      "52": "per week",
      "26": "per fortnight"
    },
    "StartBasis": {
      "1": "Current",
      "2": "Specific Age",
      "3": "Specific Date"
    },
    "StartEventGUID": {
      "6AF438D7-2CB9-4626-B1C6-AAD7D9ECD32": "Tom's State Pension Age",
      "B1E4B658-0759-4C3F-93A3-F0B428853E31": "Tina's State Pension Age"
    },
    "EndBasis": {
      "2": "Specific Age",
      "3": "Specific Date",
      "4": "Event"
    },
    "EndEventGUID": {
      "6AF438D7-2CB9-4626-B1C6-AAD7D9ECD32": "Tom's State Pension Age",
      "B1E4B658-0759-4C3F-93A3-F0B428853E31": "Tina's State Pension Age"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    },
    "FutureLevelChange": {
      "1": "Yes",
      "2": "No"
    },
    "FutureDateOfChangeBasis": {
      "2": "Specific Age",
      "3": "Specific Date",
      "4": "Event"
    },
    "FutureDateOfChangeEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    },
    "IsGoal": {
      "1": "Yes",
      "2": "No"
    },
    "EventIcon": {
      "fa-solid fa-graduation-cap": "graduation-cap",
      "fa-solid fa-hous": "house",
      "fa-kit fa-downsize": "downsize"
    },
    "GoalPriority": {
      "1": "Highest",
      "2": "High",
      "3": "Medium",
      "4": "Low",
      "5": "Lowest"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}