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
      Hide data attributes Show data attributes object
      • ExpenditureType object
        Hide ExpenditureType attributes Show ExpenditureType attributes object
        • 1 string

          Value is Essential.

        • 6 string

          Value is Assurance.

        • 5 string

          Value is Lifestyle.

      • Frequency object
        Hide Frequency attributes Show Frequency attributes object
        • 120 string

          Value is one off.

        • 52 string

          Value is per week.

        • 26 string

          Value is per fortnight.

      • StartBasis object
        Hide StartBasis attributes Show StartBasis attributes object
        • 1 string

          Value is Current.

        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

      • StartEventGUID object
        Hide StartEventGUID attributes Show StartEventGUID attributes object
        • 6AF438D7-2CB9-4626-B1C6-AAD7D9ECD32 string

          Value is Tom's State Pension Age.

        • B1E4B658-0759-4C3F-93A3-F0B428853E31 string

          Value is Tina's State Pension Age.

      • EndBasis object
        Hide EndBasis attributes Show EndBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • EndEventGUID object
        Hide EndEventGUID attributes Show EndEventGUID attributes object
        • 6AF438D7-2CB9-4626-B1C6-AAD7D9ECD32 string

          Value is Tom's State Pension Age.

        • B1E4B658-0759-4C3F-93A3-F0B428853E31 string

          Value is Tina's State Pension Age.

      • BackOfficeSync object
        Hide BackOfficeSync attributes Show BackOfficeSync attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

        • 3 string

          Value is Only update from back office.

      • FutureLevelChange object
        Hide FutureLevelChange attributes Show FutureLevelChange attributes object
        • 1 integer

          Value is Yes.

        • 2 integer

          Value is No.

      • FutureDateOfChangeBasis object
        Hide FutureDateOfChangeBasis attributes Show FutureDateOfChangeBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • FutureDateOfChangeEventGUID object
        Hide FutureDateOfChangeEventGUID attributes Show FutureDateOfChangeEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • IsGoal object
        Hide IsGoal attributes Show IsGoal attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • EventIcon object
        Hide EventIcon attributes Show EventIcon attributes object
        • fa-solid fa-graduation-cap string

          Value is graduation-cap.

        • fa-solid fa-hous string

          Value is house.

        • fa-kit fa-downsize string

          Value is downsize.

      • GoalPriority object
        Hide GoalPriority attributes Show GoalPriority attributes object
        • 1 string

          Value is Highest.

        • 2 string

          Value is High.

        • 3 string

          Value is Medium.

        • 4 string

          Value is Low.

        • 5 string

          Value is Lowest.
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
  • 404 application/json

    Household not found

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
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."
}