Get household options

GET /api/v2/household/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.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data object
      Hide data attribute Show data attribute object
      • BaselineAssumptionSetGUID object
        Hide BaselineAssumptionSetGUID attributes Show BaselineAssumptionSetGUID attributes object
        • EFCAF6D7-B6F5-4D1C-A1F9-9FA92F024B90 string
        • 8B8AE6E3-2F55-4B3E-88F9-1BC0FAD31C6D string
        • F721F267-3B81-4652-9371-DBBFA93F7E8C string
GET /api/v2/household/options 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/options' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "BaselineAssumptionSetGUID": {
      "EFCAF6D7-B6F5-4D1C-A1F9-9FA92F024B90": "FinCalc Default",
      "8B8AE6E3-2F55-4B3E-88F9-1BC0FAD31C6D": "FinCalc Default (Growth Sets)",
      "F721F267-3B81-4652-9371-DBBFA93F7E8C": "FinCalc Default (non increasing Income Tax bands)"
    }
  }
}